ConvoBrainsConvoBrains

Developers

API documentation

Integrate with ConvoBrains using the REST API: ingest calls, sync directory data, and read metrics, summaries, transcript links, and tickets, all keyed by your company API key.

Open Swagger UIRequest access

Base URL (configurable via NEXT_PUBLIC_API_BASE_URL): https://api.convobrains.com

Authentication

Every request under /api/v1 must send your integration key.

  • HDRx-api-key

    Company API key

    Same key as for teams, users, and call ingestion. Keys are hashed server-side and scoped to one company; responses only include data for that company.

Calls & conversations

Read-side endpoints use the ConvoBrains conversation UUID as callId (the primary key on conversation rows).

  • GET/api/v1/conversations/{callId}/metrics

    Call metrics

    Duration, silence, hold, words-per-minute, sentiment, channel, direction, CSAT, FCR, handle-time-related KPIs, and timestamps.

  • GET/api/v1/conversations/{callId}/summary

    AI summary

    Returns the stored ai_summary text when present, plus a boolean hasSummary.

  • GET/api/v1/conversations/{callId}/transcription

    Transcript download (presigned URL)

    Response includes downloadUrl (AWS S3 presigned GET, typically valid 1 hour), expiresAt (ISO 8601), expiresInSeconds (3600), and a note to refresh after expiry. Requires transcript_link to point to an HTTPS S3 object URL. Use downloadUrl immediately; after expiresAt, call this endpoint again.

Tickets

Kanban tickets linked to users inside your workspace.

  • GET/api/v1/users/{userId}/tickets

    Tickets for a user

    Lists tickets where the user is creator, primary owner, or a participant. userId is the ConvoBrains user UUID. Includes tags and participants.

Ingestion & writes

Existing write APIs remain under POST /api/v1/teams, POST /api/v1/users, and POST /api/v1/call. Full schemas and try-it-out flows live in Swagger.

API documentation | ConvoBrains