Generated from the API's OpenAPI spec, so it always matches what the API serves.
Finns are the voice agents; a deployment points one at an audience or a number, and each call it makes or takes is a call record. Guides: Finns, Calls, Deployments, Audiences, Phone numbers, Voices, Wallet.
Generated from the API's OpenAPI spec: 52 operations. Request and response bodies for each are in the API reference. The MCP tool column names the tool in Finn's MCP server that makes the same call.
Finns
| Endpoint | What it does | Scope | MCP tool | Notes |
|---|
GET /finns | List Finns | voice:read | list_finns | limit/offset pages |
POST /finns | Create a Finn | voice:write | | |
GET /finns/{finn_id} | Retrieve a Finn | voice:read | get_finn | |
PATCH /finns/{finn_id} | Update a Finn | voice:write | | |
DELETE /finns/{finn_id} | Delete a Finn | voice:write | | |
GET /finns/{finn_id}/knowledge_base | List a Finn's knowledge base documents | voice:read | | |
POST /finns/{finn_id}/knowledge_base | Add a knowledge base document | voice:write | | |
GET /finns/{finn_id}/post_call_analysis | Get a Finn's post-call analysis | voice:read | | |
POST /finns/generate | Draft a Finn with AI | finn:write | generate_finn | |
GET /finns/{finn_id}/flow | Read a Finn's call flow | finn:read | get_finn_flow | |
POST /finns/{finn_id}/flow/enable | Turn a Finn's call flow on | finn:write | set_finn_flow_enabled | |
POST /finns/{finn_id}/flow/disable | Turn a Finn's call flow off | finn:write | set_finn_flow_enabled | |
GET /finns/{finn_id}/settings | Read a Finn's settings | finn:read | get_finn_settings | |
GET /finns/{finn_id}/variables | Read a Finn's variables | finn:read | get_finn_variables | |
PATCH /finns/{finn_id}/variables | Edit a Finn's variables | finn:write | update_finn_variables | |
PATCH /finns/{finn_id}/handbook | Edit a Finn's agent handbook | finn:write | update_finn_handbook | |
PATCH /finns/{finn_id}/speech_settings | Edit a Finn's speech settings | finn:write | update_finn_speech_settings | |
PATCH /finns/{finn_id}/draft | Edit a draft Finn | finn:write | update_finn_draft | |
POST /finns/{finn_id}/duplicate | Copy a Finn | finn:write | duplicate_finn | |
GET /finns/{finn_id}/share_link | Read a Finn's share link | finn:read | get_share_link | |
POST /finns/{finn_id}/share_link | Get or make a Finn's share link | finn:write | get_share_link | |
GET /finns/{finn_id}/stats | A Finn's call stats | finn:read | get_finn_stats | |
GET /finns/{finn_id}/outcomes | Summarize a Finn's call outcomes | finn:read | summarize_finn_outcomes | |
Calls
| Endpoint | What it does | Scope | MCP tool | Notes |
|---|
GET /calls | List calls | voice:read | list_calls | limit/offset pages |
POST /calls | Place a call | voice:write | place_call | Idempotency-Key; can be held: 202 pending_approval |
GET /calls/{call_uuid} | Retrieve a call | voice:read | get_call | |
Deployments
| Endpoint | What it does | Scope | MCP tool | Notes |
|---|
GET /deployments | List deployments | voice:read | list_campaigns | limit/offset pages |
POST /deployments | Create an outbound deployment | voice:write | start_campaign | Idempotency-Key; can be held: 202 pending_approval |
POST /deployments/inbound | Create an inbound deployment | voice:write | | Idempotency-Key; can be held: 202 pending_approval |
GET /deployments/{id} | Retrieve a deployment | voice:read | get_campaign | |
POST /deployments/{id}/stop | Stop an outbound deployment | voice:write | | |
POST /deployments/inbound/{finn_id}/stop | Stop an inbound deployment | voice:write | | |
GET /deployments/{id}/analytics | Get deployment analytics | voice:read | get_campaign | |
Audiences
| Endpoint | What it does | Scope | MCP tool | Notes |
|---|
GET /audiences | List audiences | voice:read | list_audiences | limit/offset pages |
POST /audiences | Create an audience | voice:write | | |
GET /audiences/{audience_id} | Retrieve an audience | voice:read | get_audience | |
DELETE /audiences/{audience_id} | Archive an audience | voice:write | | |
GET /audiences/{audience_id}/contacts | List contacts | voice:read | | limit/offset pages |
POST /audiences/{audience_id}/contacts | Add contacts | voice:write | | |
DELETE /audiences/{audience_id}/contacts/{phone} | Remove a contact | voice:write | | |
Phone numbers
| Endpoint | What it does | Scope | MCP tool | Notes |
|---|
GET /phone_numbers | List phone numbers | voice:read | list_phone_numbers | limit/offset pages |
POST /phone_numbers | Rent a phone number | voice:write | | Idempotency-Key; can be held: 202 pending_approval |
GET /phone_numbers/available | Search available numbers | voice:read | | |
GET /phone_numbers/{id} | Retrieve a phone number | voice:read | get_phone_number | |
DELETE /phone_numbers/{id} | Release a phone number | voice:write | | |
Voices
| Endpoint | What it does | Scope | MCP tool | Notes |
|---|
GET /voices | List voices | voice:read | list_voices | limit/offset pages |
GET /voices/{voice_id} | Retrieve a voice | voice:read | | |
Do not call
| Endpoint | What it does | Scope | MCP tool | Notes |
|---|
GET /do_not_call | List do-not-call numbers | voice:read | | limit/offset pages |
POST /do_not_call | Add a number to the do-not-call list | voice:write | | |
DELETE /do_not_call/{phone} | Remove a number from the do-not-call list | voice:dnc:write | | |
Wallet
| Endpoint | What it does | Scope | MCP tool | Notes |
|---|
GET /wallet | Retrieve the wallet balance | voice:read | | |
GET /wallet/transactions | List wallet transactions | voice:read | | limit/offset pages |