Fundamentals

API Reference

View as Markdown

Choose an endpoint below for its method, path, authentication, input fields, response schema, examples, and errors. Use the Documentation tab for setup and workflow guides.

Base URL and authentication

Send requests to https://anthropod.in/api/v2 with your Developer Hub private API key in the Bearer header. The same key works across the API reference. See authentication.

API version

The API version is part of the base URL: /api/v2. Legacy (the documentation URL segment /v0) identifies this documentation edition; it does not change the API version or request paths. A response’s api_version or an analytics module’s version describes that stored payload or module configuration, not the HTTP API version.

Conversation Analytics

Read analyzed calls and chats, customers, and analytics configuration. Filter the shared conversations collection with channel=call or channel=chat.

MethodEndpointReference
GET/conversation-analytics/conversationsList conversations
GET/conversation-analytics/conversations/{conversation_id}Retrieve a conversation
GET/conversation-analytics/customersList customers
GET/conversation-analytics/customers/{customer_id}Retrieve a customer
GET/conversation-analytics/customers/{customer_id}/conversationsList customer conversations
GET/conversation-analytics/configurationRetrieve analytics configuration

Batch Analytics

Submit existing conversations for asynchronous analysis. Each channel has its own input contract.

MethodEndpointReference
POST/call_analytics/batch/Create Call Analysis
POST/chat_analytics/batch/Create Chat Analysis

Voice Agents

MethodEndpointReference
POST/voice_agents/batch/make_outbound_call/Create outbound calls
GET/voice-agents/conversationsList conversations
GET/voice-agents/conversations/{conversation_id}Retrieve a conversation

Exports

Export larger sets of records asynchronously.

MethodEndpointReference
POST/exportsCreate an export
GET/exports/{export_id}Retrieve an export

Embedded URLs

MethodEndpointReference
POST/embedded_urls/generate/Generate an embedded URL

Integration essentials

Read pagination, per-key, per-endpoint rate limits, and errors before integrating the data-read APIs. See each endpoint for response formats and timestamp units.

For real-time delivery of processed results, configure webhooks in Developer Hub. Anthropod sends the callback to your server.