AgentPhone

Create a phone agent.

POST JSON body. Creates an agent that can handle calls. Returns agent_id.

{
  "body": {
    "name": "string (optional)",
    "instructions": "string (optional, system prompt for the agent)",
    "voice": "string (optional)"
  }
}

Update an agent.

PATCH JSON body with fields to update.

{
  "path": {
    "agent_id": "string"
  },
  "body": {
    "name": "string (optional)",
    "instructions": "string (optional)",
    "voice": "string (optional)"
  }
}

Delete an agent.

Permanently deletes the agent.

{
  "path": {
    "agent_id": "string"
  }
}

Get agent details.

Replace {agent_id}. Returns agent details.

{
  "path": {
    "agent_id": "string"
  }
}

List calls for an agent.

Returns all calls handled by this agent.

{
  "path": {
    "agent_id": "string"
  }
}

List conversations for an agent.

Returns all conversations for this agent.

{
  "path": {
    "agent_id": "string"
  }
}

Attach a phone number to an agent.

Attach an existing phone number to this agent so it can receive calls.

{
  "path": {
    "agent_id": "string"
  },
  "body": {
    "number_id": "string (required)"
  }
}

Detach a phone number from an agent.

Removes the number from this agent.

{
  "path": {
    "agent_id": "string",
    "number_id": "string"
  }
}

Create a webhook for an agent.

Set up a webhook URL for agent events.

{
  "path": {
    "agent_id": "string"
  },
  "body": {
    "url": "string (required)"
  }
}

Delete webhook for an agent.

Removes the webhook.

{
  "path": {
    "agent_id": "string"
  }
}

Get webhook for an agent.

Returns webhook configuration.

{
  "path": {
    "agent_id": "string"
  }
}

List webhook deliveries.

Returns webhook delivery history.

{
  "path": {
    "agent_id": "string"
  }
}

Test webhook delivery.

Sends a test event to the configured webhook.

{
  "path": {
    "agent_id": "string"
  }
}

Make a phone call with x402 upto settlement or MPP session billing.

POST JSON body. Initiates an outbound call and returns call_id. x402 authorizes up to 0.50 USDC with deferred settlement; MPP uses session billing for call usage.

{
  "body": {
    "to": "string (required, phone number)",
    "from": "string (optional, your number_id)",
    "agent_id": "string (optional)",
    "prompt": "string (optional)"
  }
}

Make a web call (WebRTC) with x402 upto settlement or MPP session billing.

POST JSON body. Creates a WebRTC call session. x402 authorizes up to 0.50 USDC with deferred settlement; MPP uses session billing for call usage.

{
  "body": {
    "agent_id": "string (optional)",
    "prompt": "string (optional)"
  }
}

List all conversations.

Returns all conversations.

Get a conversation.

Returns conversation details.

{
  "path": {
    "conversation_id": "string"
  }
}

Get messages in a conversation.

Returns all messages in the conversation.

{
  "path": {
    "conversation_id": "string"
  }
}

Purchase a phone number.

POST JSON body. Purchases a phone number. Returns number_id and the phone number.

{
  "body": {
    "country": "string (optional, ISO country code, default 'US')",
    "area_code": "string (optional)"
  }
}

Release a phone number.

Releases the phone number.

{
  "path": {
    "number_id": "string"
  }
}

List calls for a number.

Returns all calls for this number.

{
  "path": {
    "number_id": "string"
  }
}

List messages for a number.

Returns all messages for this number.

{
  "path": {
    "number_id": "string"
  }
}