Skip to content

Overview

AI-powered survey open-end coding API. Send raw verbatim responses, receive structured codes, categories, and sentiment back.

Authentication

All endpoints (except /health) require an API key passed in the x-api-key header. Keys follow the format scp_live_<32 chars> and are scoped to an organization. Each key carries read and/or write scopes.

Response envelope

Every response follows the shape:

{ "success": true,  "data": { ... }, "meta": { ... } }
{ "success": false, "error": { "code": "...", "message": "...", "doc_url": "..." } }

Rate limits

Per-key limits are returned in X-RateLimit-* headers on every response. Default: 60 req/min. Enterprise keys can be raised.

Async jobs

Requests that process >= 50 responses return 202 Accepted with a job_id. Poll GET /v2/jobs/{id} until status is completed or failed.

Credits

Every coded response costs 1 credit. Check your balance with GET /v2/usage. Credits never expire and accumulate on renewal.

Informations

API key in the format scp_live_<32 alphanumeric chars>. Keys are SHA-256 hashed server-side. Each key belongs to one organization and carries read and/or write scopes.

Create keys in the Survey Coder Pro dashboard under Settings > API Keys.

Security scheme type: apiKey

Header parameter name: x-api-key