DocsAPI Reference

API Reference

The Yapsolutely REST API lets you manage agents, calls, phone numbers, and transcripts programmatically. All endpoints require authentication via API key.

HTTPS only

Bearer token auth

JSON responses

Base URL

https://api.yapsolutely.com/v1

Authentication

POST/api/v1/auth/tokenGenerate an API access token

POST/api/v1/auth/revokeRevoke an existing token

Agents

GET/api/v1/agentsList all agents

POST/api/v1/agentsCreate a new agent

GET/api/v1/agents/:idRetrieve an agent

PATCH/api/v1/agents/:idUpdate an agent

DELETE/api/v1/agents/:idDelete an agent

Calls

GET/api/v1/callsList all calls

GET/api/v1/calls/:idRetrieve a call

GET/api/v1/calls/:id/transcriptGet call transcript

POST/api/v1/calls/:id/exportExport call data

Phone Numbers

GET/api/v1/numbersList all phone numbers

POST/api/v1/numbersProvision a new number

PATCH/api/v1/numbers/:idUpdate number routing

DELETE/api/v1/numbers/:idRelease a phone number

Webhooks

GET/api/v1/webhooksList webhook endpoints

POST/api/v1/webhooksRegister a webhook

DELETE/api/v1/webhooks/:idRemove a webhook

Transcripts

GET/api/v1/transcriptsList transcripts

GET/api/v1/transcripts/:idRetrieve a transcript

GET/api/v1/transcripts/:id/segmentsGet transcript segments

Authentication

Include your API key in the Authorization header of every request.

curl https://api.yapsolutely.com/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"