Skip to main content
The Anyreach API is organized around REST. It has predictable, resource-oriented URLs, accepts JSON request bodies, returns JSON responses, and uses standard HTTP verbs and status codes.

​
Base URL

All endpoints are relative to: 
https://api.anyreach.ai
Endpoints are grouped by service and each group has a path prefix:
PrefixService
/coreAgents, conversations, phone numbers, trunks, web widgets, email, inbound routing
/knowledge-baseKnowledge bases (datasets), sources, retrieval
/workflowWorkflows, executions, triggers
/campaignOutbound campaigns, contacts, configurations
/mcpModel Context Protocol server

​
Conventions

  • Requests — send JSON with a Content-Type: application/json header. List endpoints take filters as query parameters and paginate with a cursor.
  • Responses — always JSON. Timestamps are ISO 8601 (UTC). IDs are opaque strings; don’t parse them.
  • Authentication — every request needs a bearer credential (ak_ or pat_). See Authentication.
  • Errors — non-2xx responses return a JSON detail message. See Errors.

​
Resources

Authentication

Authorize requests with an API key or personal access token.

Errors

Error format and status codes.

Conversations

Create, list, retrieve, and message conversations.

Knowledge bases

Datasets, sources, and retrieval.

Agents

Manage agents, versions, publishing, and deployment.

Campaigns

Create campaigns, upload contacts, and read stats.

Email

Domains, addresses, and unsubscribes.

Web widgets

Manage widgets and the public widget runtime.

Telephony

Phone numbers, trunks, and inbound routing.

Workflows

Manage workflows and run executions.