Skip to main content
The Versive public API (v1) lets you manage studies, questions, logic, interviews, translations, and insights programmatically. Typical uses: creating interviews with tracked links from your own app, syncing study content from your systems, building studies with the AI agent, and pulling interview transcripts and summaries into your data warehouse.

​
Base URL

​
Authentication

All endpoints require an API key passed as a Bearer token:
API keys are created in your organization settings (Organization → API keys) by an owner or admin. Each key is scoped to one organization and grants full API access to that organization’s data — there are no per-key scopes, so treat keys like passwords: store them in a secrets manager, never in client-side code, and deactivate keys you no longer use. A missing or invalid key returns 401 with {"detail": "Invalid authentication credentials"}.

​
Conventions

  • JSON everywhere — request bodies are JSON (Content-Type: application/json); one endpoint (Update question) also accepts multipart/form-data for file uploads.
  • IDs are UUID strings.
  • Organization scoping is automatic — the key determines the organization; requesting a resource that belongs to another organization returns 403.
  • Partial updates — PUT endpoints only change the fields you send. On studies, the config object is merged into the existing config rather than replaced.
  • No pagination — list endpoints currently return all matching records.

​
Errors

Errors use conventional HTTP status codes with a JSON body:

​
Resources

Studies

Create, list, update, translate, and AI-edit studies; read response metrics.

Questions

Read, batch-create/update, and delete a study’s questions.

Question logic

Manage conditional branching rules.

Interviews

Create tracked participant links and read interview transcripts and status.

Insights

Fetch AI-generated interview summaries.

Translations

Trigger and manage study translations.

Folders

Create and list folders for organizing studies.