Dynamiq
PlatformPython SDKAPI Reference
Voice Agents

Test an MCP server

Probes an MCP server and lists the tools it exposes, so you can verify a server before attaching it to an agent. Backs the Test connection button in the builder. A failed probe is reported as 200 with ok: false and an error string — it is not an HTTP error. The response is bare, with no data envelope.

POST
/v1/agents/voice/tools/mcp/test

Authorization

personalAccessToken
AuthorizationBearer <token>

Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/agents/voice/tools/mcp/test" \  -H "Content-Type: application/json" \  -d '{    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",    "url": "string"  }'
{
  "ok": true,
  "tools": [
    {
      "name": "string",
      "description": "string"
    }
  ],
  "error": "string"
}
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

Create a WebRTC session for a draft agent

Mints a realtime session without requiring a saved agent — pass a full `config` inline to talk to a configuration that has not been created yet. This is what the builder's **Live Preview** uses. Pass `agent_id` instead to mint a session for a saved agent; that is equivalent to `POST /v1/agents/voice/agents/{agent_id}/rooms`. The response is **bare** — it is not wrapped in a `data` envelope.

Get telephony configuration

Returns the agent's SIP trunks, the phone numbers attached to them, the SIP URI to point your trunk's origination at, and per-provider setup steps.