Skip to main content

IntraCord integration API

Use the integration API to retrieve assistants and conversation outcomes from your own backend. This release introduces an independently versioned, read-only v2 surface. Deploy the matching backend and gateway before using these routes; a documentation update alone does not enable v2 on an older installation.

Connect to your installation

The managed gateway uses https://app.intracord.hu/api/v2. On your own installation, replace the hostname with your public application gateway. The documentation host docs.intracord.hu serves guides, not API requests.

Create an application API key in Developers and store it on your server. New keys begin with itc_; existing keys keep working until revoked.

curl --fail-with-body 'https://app.intracord.hu/api/v2/agents?page=1&page_size=20' \
-H "X-API-Key: $INTRACORD_API_KEY"

Set INTRACORD_API_KEY in your server environment first. This request lists only the key's organization. Successful collections return data and pagination with page, page_size and total. Page size is between 1 and 100.

Retrieve an outcome

Read an assistant's conversation list, then retrieve a conversation by its numeric ID. V2 calls the starting fields input and the collected fields result. completed records completion; it is not a business-success classification. channel preserves the execution mode recorded by the installation, and direction records the call direction.

Method and path, relative to /api/v2Purpose
GET /agentsList assistants
GET /agents/{agent_id}Read assistant metadata
GET /agents/{agent_id}/conversationsPage through its conversations
GET /conversations/{conversation_id}Read inputs and results
GET /statusProcess liveness, without provider or database checks

V2 deliberately returns an explicit set of fields; internal logs, provider credentials and public recording tokens are not part of this contract. The data you put into conversation inputs and results is still returned to authorized clients.

Integrate existing write operations

Authoring assistants, placing calls, campaigns and carrier callbacks continue to use the documented v1 operations. Existing client libraries also target v1. Do not change a v1 payload or callback URL merely by replacing its version number. In v1, workflow_definition, initial_context and gathered_context remain the exact field names.

The running v2 schema is available at /api/v2/openapi.json. See authentication, errors and the reference entries below this guide.