{"info":{"name":"AI Studio API","description":"The /v1 surface of AI Studio, generated from openapi.yaml v1.0.0. Set apiKey to a managed key from Developers.","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"variable":[{"key":"baseUrl","value":"https://aistudio.housystan.com/v1"},{"key":"apiKey","value":""}],"item":[{"name":"Agents","description":"The AI agent — prompt, greeting, voice, language, caller ID.","item":[{"name":"List agents","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents","host":["{{baseUrl}}"],"path":["agents"],"variable":[]},"description":"List agents — scope agents:read"}},{"name":"Create an agent","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents","host":["{{baseUrl}}"],"path":["agents"],"variable":[]},"description":"Create an agent — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Fetch one agent","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id","host":["{{baseUrl}}"],"path":["agents",":id"],"variable":[{"key":"id","value":""}]},"description":"Fetch one agent — scope agents:read"}},{"name":"Update an agent","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id","host":["{{baseUrl}}"],"path":["agents",":id"],"variable":[{"key":"id","value":""}]},"description":"Update an agent — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Delete an agent","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id","host":["{{baseUrl}}"],"path":["agents",":id"],"variable":[{"key":"id","value":""}]},"description":"Delete an agent — scope agents:write"}},{"name":"Copy an agent","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/duplicate","host":["{{baseUrl}}"],"path":["agents",":id","duplicate"],"variable":[{"key":"id","value":""}]},"description":"Copy an agent — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Prompt version history","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/versions","host":["{{baseUrl}}"],"path":["agents",":id","versions"],"variable":[{"key":"id","value":""}]},"description":"Prompt version history — scope agents:read"}},{"name":"One stored version, with its full text","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/versions/:versionId","host":["{{baseUrl}}"],"path":["agents",":id","versions",":versionId"],"variable":[{"key":"id","value":""},{"key":"versionId","value":""}]},"description":"One stored version, with its full text — scope agents:read"}},{"name":"Roll a prompt column back to a stored version","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/rollback","host":["{{baseUrl}}"],"path":["agents",":id","rollback"],"variable":[{"key":"id","value":""}]},"description":"Roll a prompt column back to a stored version — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Languages the agent speaks","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/languages","host":["{{baseUrl}}"],"path":["agents",":id","languages"],"variable":[{"key":"id","value":""}]},"description":"Languages the agent speaks — scope agents:read"}},{"name":"Set the agent's languages","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/languages","host":["{{baseUrl}}"],"path":["agents",":id","languages"],"variable":[{"key":"id","value":""}]},"description":"Set the agent's languages — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Supported languages","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/languages","host":["{{baseUrl}}"],"path":["languages"],"variable":[]},"description":"Supported languages — scope agents:read"}},{"name":"What the model receives","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/prompt","host":["{{baseUrl}}"],"path":["agents",":id","prompt"],"variable":[{"key":"id","value":""}]},"description":"What the model receives — scope agents:read"}},{"name":"Which variables a call in this workspace fills","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/variables","host":["{{baseUrl}}"],"path":["agents",":id","variables"],"variable":[{"key":"id","value":""}]},"description":"Which variables a call in this workspace fills — scope agents:read"}},{"name":"Check an unsaved draft's variables","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/variables","host":["{{baseUrl}}"],"path":["agents",":id","variables"],"variable":[{"key":"id","value":""}]},"description":"Check an unsaved draft's variables — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Saved named versions","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/branches","host":["{{baseUrl}}"],"path":["agents",":id","branches"],"variable":[{"key":"id","value":""}]},"description":"Saved named versions — scope agents:read"}},{"name":"Save the agent as a named version","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/branches","host":["{{baseUrl}}"],"path":["agents",":id","branches"],"variable":[{"key":"id","value":""}]},"description":"Save the agent as a named version — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Make a saved version live","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/branches/:branchId/apply","host":["{{baseUrl}}"],"path":["agents",":id","branches",":branchId","apply"],"variable":[{"key":"id","value":""},{"key":"branchId","value":""}]},"description":"Make a saved version live — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Delete a saved version","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/branches/:branchId","host":["{{baseUrl}}"],"path":["agents",":id","branches",":branchId"],"variable":[{"key":"id","value":""},{"key":"branchId","value":""}]},"description":"Delete a saved version — scope agents:write"}},{"name":"List simulation tests","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/evals/scenarios","host":["{{baseUrl}}"],"path":["agents",":id","evals","scenarios"],"variable":[{"key":"id","value":""}]},"description":"List simulation tests — scope agents:read"}},{"name":"Add a simulation test","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/evals/scenarios","host":["{{baseUrl}}"],"path":["agents",":id","evals","scenarios"],"variable":[{"key":"id","value":""}]},"description":"Add a simulation test — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Add the starter tests","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/evals/scenarios/starter","host":["{{baseUrl}}"],"path":["agents",":id","evals","scenarios","starter"],"variable":[{"key":"id","value":""}]},"description":"Add the starter tests — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Edit a simulation test","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/evals/scenarios/:scenarioId","host":["{{baseUrl}}"],"path":["agents",":id","evals","scenarios",":scenarioId"],"variable":[{"key":"id","value":""},{"key":"scenarioId","value":""}]},"description":"Edit a simulation test — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Delete a simulation test","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/evals/scenarios/:scenarioId","host":["{{baseUrl}}"],"path":["agents",":id","evals","scenarios",":scenarioId"],"variable":[{"key":"id","value":""},{"key":"scenarioId","value":""}]},"description":"Delete a simulation test — scope agents:write"}},{"name":"Past test runs","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/evals","host":["{{baseUrl}}"],"path":["agents",":id","evals"],"variable":[{"key":"id","value":""}]},"description":"Past test runs — scope agents:read"}},{"name":"Run the simulation tests","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/evals","host":["{{baseUrl}}"],"path":["agents",":id","evals"],"variable":[{"key":"id","value":""}]},"description":"Run the simulation tests — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"One test run — progress, then results","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/evals/:runId","host":["{{baseUrl}}"],"path":["agents",":id","evals",":runId"],"variable":[{"key":"id","value":""},{"key":"runId","value":""}]},"description":"One test run — progress, then results — scope agents:read"}},{"name":"Stop a test run","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/evals/:runId/cancel","host":["{{baseUrl}}"],"path":["agents",":id","evals",":runId","cancel"],"variable":[{"key":"id","value":""},{"key":"runId","value":""}]},"description":"Stop a test run — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}}]},{"name":"Analysis","description":"Per-agent success criteria and structured data extracted from each call.","item":[{"name":"The agent's success criteria and data-collection fields","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/analysis","host":["{{baseUrl}}"],"path":["agents",":id","analysis"],"variable":[{"key":"id","value":""}]},"description":"The agent's success criteria and data-collection fields — scope agents:read"}},{"name":"Replace the agent's analysis configuration","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/agents/:id/analysis","host":["{{baseUrl}}"],"path":["agents",":id","analysis"],"variable":[{"key":"id","value":""}]},"description":"Replace the agent's analysis configuration — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}}]},{"name":"Calls","description":"Placing calls, and the record of every call placed or received.","item":[{"name":"List calls","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/calls","host":["{{baseUrl}}"],"path":["calls"],"variable":[]},"description":"List calls — scope calls:read"}},{"name":"One call, with transcript","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/calls/:id","host":["{{baseUrl}}"],"path":["calls",":id"],"variable":[{"key":"id","value":""}]},"description":"One call, with transcript — scope calls:read"}},{"name":"Aggregates over the same filters as the list","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/calls/stats","host":["{{baseUrl}}"],"path":["calls","stats"],"variable":[]},"description":"Aggregates over the same filters as the list — scope calls:read"}},{"name":"Place an outbound call","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/calls/outbound","host":["{{baseUrl}}"],"path":["calls","outbound"],"variable":[]},"description":"Place an outbound call — scope calls:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Calls booked for later","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/calls/bookings","host":["{{baseUrl}}"],"path":["calls","bookings"],"variable":[]},"description":"Calls booked for later — scope calls:read"}},{"name":"One booked call","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/calls/bookings/:id","host":["{{baseUrl}}"],"path":["calls","bookings",":id"],"variable":[{"key":"id","value":""}]},"description":"One booked call — scope calls:read"}},{"name":"Cancel a booked call","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/calls/bookings/:id","host":["{{baseUrl}}"],"path":["calls","bookings",":id"],"variable":[{"key":"id","value":""}]},"description":"Cancel a booked call — scope calls:write"}},{"name":"Every call with one phone number","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/calls/contact","host":["{{baseUrl}}"],"path":["calls","contact"],"variable":[]},"description":"Every call with one phone number — scope calls:read"}},{"name":"Pull call results since your last read","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/results","host":["{{baseUrl}}"],"path":["results"],"variable":[]},"description":"Pull call results since your last read — scope calls:read"}}]},{"name":"Recordings","description":"Call audio, behind a short-lived signed link.","item":[{"name":"Play a call recording","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/recordings/:id","host":["{{baseUrl}}"],"path":["recordings",":id"],"variable":[{"key":"id","value":""}]},"description":"Play a call recording — scope recordings:read"}},{"name":"Download a call recording","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/recordings/:id/download","host":["{{baseUrl}}"],"path":["recordings",":id","download"],"variable":[{"key":"id","value":""}]},"description":"Download a call recording — scope recordings:read"}}]},{"name":"Campaigns","description":"Outbound campaigns and the leads inside them.","item":[{"name":"List campaigns","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns","host":["{{baseUrl}}"],"path":["campaigns"],"variable":[]},"description":"List campaigns — scope campaigns:read"}},{"name":"Create a campaign","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns","host":["{{baseUrl}}"],"path":["campaigns"],"variable":[]},"description":"Create a campaign — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Fetch one campaign","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id","host":["{{baseUrl}}"],"path":["campaigns",":id"],"variable":[{"key":"id","value":""}]},"description":"Fetch one campaign — scope campaigns:read"}},{"name":"Update a campaign — including starting and pausing it","request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id","host":["{{baseUrl}}"],"path":["campaigns",":id"],"variable":[{"key":"id","value":""}]},"description":"Update a campaign — including starting and pausing it — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Delete a campaign and its leads","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id","host":["{{baseUrl}}"],"path":["campaigns",":id"],"variable":[{"key":"id","value":""}]},"description":"Delete a campaign and its leads — scope campaigns:write"}},{"name":"Leads in a campaign","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/leads","host":["{{baseUrl}}"],"path":["campaigns",":id","leads"],"variable":[{"key":"id","value":""}]},"description":"Leads in a campaign — scope campaigns:read"}},{"name":"Add leads to a campaign","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/leads","host":["{{baseUrl}}"],"path":["campaigns",":id","leads"],"variable":[{"key":"id","value":""}]},"description":"Add leads to a campaign — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Calls made by a campaign","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/call-log","host":["{{baseUrl}}"],"path":["campaigns",":id","call-log"],"variable":[{"key":"id","value":""}]},"description":"Calls made by a campaign — scope campaigns:read"}},{"name":"Lifetime counters for a campaign","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/stats","host":["{{baseUrl}}"],"path":["campaigns",":id","stats"],"variable":[{"key":"id","value":""}]},"description":"Lifetime counters for a campaign — scope campaigns:read"}},{"name":"Day-by-day activity","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/daywise","host":["{{baseUrl}}"],"path":["campaigns",":id","daywise"],"variable":[{"key":"id","value":""}]},"description":"Day-by-day activity — scope campaigns:read"}},{"name":"Leads that showed interest","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/interest","host":["{{baseUrl}}"],"path":["campaigns",":id","interest"],"variable":[{"key":"id","value":""}]},"description":"Leads that showed interest — scope campaigns:read"}},{"name":"Add a number to a campaign","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/dids","host":["{{baseUrl}}"],"path":["campaigns",":id","dids"],"variable":[{"key":"id","value":""}]},"description":"Add a number to a campaign — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Rotate one of a campaign's numbers","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/dids/:number/rotate","host":["{{baseUrl}}"],"path":["campaigns",":id","dids",":number","rotate"],"variable":[{"key":"id","value":""},{"key":"number","value":""}]},"description":"Rotate one of a campaign's numbers — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Pre-launch sanity check","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/preflight","host":["{{baseUrl}}"],"path":["campaigns",":id","preflight"],"variable":[{"key":"id","value":""}]},"description":"Pre-launch sanity check — scope campaigns:read"}},{"name":"Funnel counts","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/pipeline-metrics","host":["{{baseUrl}}"],"path":["campaigns",":id","pipeline-metrics"],"variable":[{"key":"id","value":""}]},"description":"Funnel counts — scope campaigns:read"}},{"name":"Call the unanswered leads again","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/retry","host":["{{baseUrl}}"],"path":["campaigns",":id","retry"],"variable":[{"key":"id","value":""}]},"description":"Call the unanswered leads again — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Progress of the latest retry job","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/retry-job","host":["{{baseUrl}}"],"path":["campaigns",":id","retry-job"],"variable":[{"key":"id","value":""}]},"description":"Progress of the latest retry job — scope campaigns:read"}},{"name":"Stop a running retry job","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/retry-job/stop","host":["{{baseUrl}}"],"path":["campaigns",":id","retry-job","stop"],"variable":[{"key":"id","value":""}]},"description":"Stop a running retry job — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Did the system do its part","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/pipeline-stats","host":["{{baseUrl}}"],"path":["campaigns",":id","pipeline-stats"],"variable":[{"key":"id","value":""}]},"description":"Did the system do its part — scope campaigns:read"}},{"name":"Your lines in use right now","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/live-channels","host":["{{baseUrl}}"],"path":["campaigns","live-channels"],"variable":[]},"description":"Your lines in use right now — scope campaigns:read"}},{"name":"Hot and warm leads (the lead judge's verdict)","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/leads/hot-warm","host":["{{baseUrl}}"],"path":["campaigns","leads","hot-warm"],"variable":[]},"description":"Hot and warm leads (the lead judge's verdict) — scope campaigns:read"}},{"name":"Which numbers dialled for which campaigns","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/dids","host":["{{baseUrl}}"],"path":["campaigns","dids"],"variable":[]},"description":"Which numbers dialled for which campaigns — scope campaigns:read"}},{"name":"Live calling snapshot","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/live","host":["{{baseUrl}}"],"path":["campaigns","live"],"variable":[]},"description":"Live calling snapshot — scope campaigns:read"}},{"name":"Calls in flight right now","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/active-calls","host":["{{baseUrl}}"],"path":["campaigns","active-calls"],"variable":[]},"description":"Calls in flight right now — scope campaigns:read"}},{"name":"Campaign totals for today, yesterday or the last 7 days","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/scoped-stats","host":["{{baseUrl}}"],"path":["campaigns","scoped-stats"],"variable":[]},"description":"Campaign totals for today, yesterday or the last 7 days — scope campaigns:read"}},{"name":"Compact progress summary","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/summary","host":["{{baseUrl}}"],"path":["campaigns",":id","summary"],"variable":[{"key":"id","value":""}]},"description":"Compact progress summary — scope campaigns:read"}},{"name":"How many leads a retry would re-queue","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/:id/retry-stats","host":["{{baseUrl}}"],"path":["campaigns",":id","retry-stats"],"variable":[{"key":"id","value":""}]},"description":"How many leads a retry would re-queue — scope campaigns:read"}},{"name":"List reusable lead lists","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/lead-groups","host":["{{baseUrl}}"],"path":["campaigns","lead-groups"],"variable":[]},"description":"List reusable lead lists — scope campaigns:read"}},{"name":"Create a reusable lead list","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/lead-groups","host":["{{baseUrl}}"],"path":["campaigns","lead-groups"],"variable":[]},"description":"Create a reusable lead list — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Delete a lead list","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/lead-groups/:id","host":["{{baseUrl}}"],"path":["campaigns","lead-groups",":id"],"variable":[{"key":"id","value":""}]},"description":"Delete a lead list — scope campaigns:write"}},{"name":"Append leads to a lead list","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/lead-groups/:id/leads","host":["{{baseUrl}}"],"path":["campaigns","lead-groups",":id","leads"],"variable":[{"key":"id","value":""}]},"description":"Append leads to a lead list — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Recount a lead list","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/lead-groups/:id/recount","host":["{{baseUrl}}"],"path":["campaigns","lead-groups",":id","recount"],"variable":[{"key":"id","value":""}]},"description":"Recount a lead list — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Check which phones you already hold","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/campaigns/preview-leads","host":["{{baseUrl}}"],"path":["campaigns","preview-leads"],"variable":[]},"description":"Check which phones you already hold — scope campaigns:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}}]},{"name":"Numbers","description":"The phone numbers you call from, their health, and requests for more.","item":[{"name":"List your numbers","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dids","host":["{{baseUrl}}"],"path":["dids"],"variable":[]},"description":"List your numbers — scope numbers:read"}},{"name":"Which number belongs to which agent or campaign","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dids/assignments","host":["{{baseUrl}}"],"path":["dids","assignments"],"variable":[]},"description":"Which number belongs to which agent or campaign — scope numbers:read"}},{"name":"The next number of yours that no agent is using","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dids/next-free","host":["{{baseUrl}}"],"path":["dids","next-free"],"variable":[]},"description":"The next number of yours that no agent is using — scope numbers:read"}},{"name":"Rotate onto a fresh caller-ID number","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dids/rotate","host":["{{baseUrl}}"],"path":["dids","rotate"],"variable":[]},"description":"Rotate onto a fresh caller-ID number — scope numbers:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Mark one of your numbers as spam-flagged","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dids/:number/spam","host":["{{baseUrl}}"],"path":["dids",":number","spam"],"variable":[{"key":"number","value":""}]},"description":"Mark one of your numbers as spam-flagged — scope numbers:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Clear the spam flag","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dids/:number/unspam","host":["{{baseUrl}}"],"path":["dids",":number","unspam"],"variable":[{"key":"number","value":""}]},"description":"Clear the spam flag — scope numbers:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Your requests for more numbers","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/numbers/requests","host":["{{baseUrl}}"],"path":["numbers","requests"],"variable":[]},"description":"Your requests for more numbers — scope numbers:read"}},{"name":"Request more numbers","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/numbers/requests","host":["{{baseUrl}}"],"path":["numbers","requests"],"variable":[]},"description":"Request more numbers — scope numbers:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Ask for a verified caller ID","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/numbers/verified-request","host":["{{baseUrl}}"],"path":["numbers","verified-request"],"variable":[]},"description":"Ask for a verified caller ID — scope numbers:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Your phone numbers and who uses them","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/numbers","host":["{{baseUrl}}"],"path":["numbers"],"variable":[]},"description":"Your phone numbers and who uses them — scope numbers:read"}}]},{"name":"Knowledge","description":"Documents the agent answers from.","item":[{"name":"List knowledge documents","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge","host":["{{baseUrl}}"],"path":["knowledge"],"variable":[]},"description":"List knowledge documents — scope knowledge:read"}},{"name":"Add a document","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge","host":["{{baseUrl}}"],"path":["knowledge"],"variable":[]},"description":"Add a document — scope knowledge:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Preview what the agent would retrieve","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge/search","host":["{{baseUrl}}"],"path":["knowledge","search"],"variable":[]},"description":"Preview what the agent would retrieve — scope knowledge:read"}},{"name":"Your folders","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge/folders","host":["{{baseUrl}}"],"path":["knowledge","folders"],"variable":[]},"description":"Your folders — scope knowledge:read"}},{"name":"One document, with its text","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge/:docId","host":["{{baseUrl}}"],"path":["knowledge",":docId"],"variable":[{"key":"docId","value":""}]},"description":"One document, with its text — scope knowledge:read"}},{"name":"Edit a document's text","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge/:docId","host":["{{baseUrl}}"],"path":["knowledge",":docId"],"variable":[{"key":"docId","value":""}]},"description":"Edit a document's text — scope knowledge:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Move, re-scope or set auto-sync","request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge/:docId","host":["{{baseUrl}}"],"path":["knowledge",":docId"],"variable":[{"key":"docId","value":""}]},"description":"Move, re-scope or set auto-sync — scope knowledge:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Remove a document and its chunks","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge/:docId","host":["{{baseUrl}}"],"path":["knowledge",":docId"],"variable":[{"key":"docId","value":""}]},"description":"Remove a document and its chunks — scope knowledge:write"}},{"name":"Agents that can use this document","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge/:docId/agents","host":["{{baseUrl}}"],"path":["knowledge",":docId","agents"],"variable":[{"key":"docId","value":""}]},"description":"Agents that can use this document — scope knowledge:read"}},{"name":"Re-crawl a URL document now","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge/:docId/resync","host":["{{baseUrl}}"],"path":["knowledge",":docId","resync"],"variable":[{"key":"docId","value":""}]},"description":"Re-crawl a URL document now — scope knowledge:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Recent re-crawls of a document","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/knowledge/:docId/jobs","host":["{{baseUrl}}"],"path":["knowledge",":docId","jobs"],"variable":[{"key":"docId","value":""}]},"description":"Recent re-crawls of a document — scope knowledge:read"}}]},{"name":"Tools","description":"Webhook and transfer-to-number tools an agent may call mid-conversation. Making or changing one needs the Developers service switched on for your workspace (otherwise 403 `service_off`); listing and deleting always work.","item":[{"name":"List your tools","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/tools","host":["{{baseUrl}}"],"path":["tools"],"variable":[]},"description":"List your tools — scope tools:read"}},{"name":"Create a tool","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/tools","host":["{{baseUrl}}"],"path":["tools"],"variable":[]},"description":"Create a tool — scope tools:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Fetch one tool","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/tools/:id","host":["{{baseUrl}}"],"path":["tools",":id"],"variable":[{"key":"id","value":""}]},"description":"Fetch one tool — scope tools:read"}},{"name":"Update a tool","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/tools/:id","host":["{{baseUrl}}"],"path":["tools",":id"],"variable":[{"key":"id","value":""}]},"description":"Update a tool — scope tools:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Delete a tool","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/tools/:id","host":["{{baseUrl}}"],"path":["tools",":id"],"variable":[{"key":"id","value":""}]},"description":"Delete a tool — scope tools:write"}}]},{"name":"Usage","description":"What you used, per day. The basis for billing.","item":[{"name":"Usage by day","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/usage","host":["{{baseUrl}}"],"path":["usage"],"variable":[]},"description":"Usage by day — scope usage:read"}},{"name":"The same data as CSV","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/usage/export.csv","host":["{{baseUrl}}"],"path":["usage","export.csv"],"variable":[]},"description":"The same data as CSV — scope usage:read"}}]},{"name":"API keys","description":"Issue, rotate and revoke keys.","item":[{"name":"List keys","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api-keys","host":["{{baseUrl}}"],"path":["api-keys"],"variable":[]},"description":"List keys — scope keys:read"}},{"name":"Create a key","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api-keys","host":["{{baseUrl}}"],"path":["api-keys"],"variable":[]},"description":"Create a key — scope keys:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Issue a replacement and revoke the old key","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api-keys/:id/rotate","host":["{{baseUrl}}"],"path":["api-keys",":id","rotate"],"variable":[{"key":"id","value":""}]},"description":"Issue a replacement and revoke the old key — scope keys:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Rename a key or change its limits","request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api-keys/:id","host":["{{baseUrl}}"],"path":["api-keys",":id"],"variable":[{"key":"id","value":""}]},"description":"Rename a key or change its limits — scope keys:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Revoke a key","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api-keys/:id","host":["{{baseUrl}}"],"path":["api-keys",":id"],"variable":[{"key":"id","value":""}]},"description":"Revoke a key — scope keys:write"}}]},{"name":"Settings","description":"Organisation settings — pipeline defaults, webhooks, secrets your tools send, recording and privacy settings.","item":[{"name":"Organisation settings","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings","host":["{{baseUrl}}"],"path":["settings"],"variable":[]},"description":"Organisation settings — scope settings:read"}},{"name":"Update organisation settings","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings","host":["{{baseUrl}}"],"path":["settings"],"variable":[]},"description":"Update organisation settings — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Post-call and initiation webhooks","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/webhooks","host":["{{baseUrl}}"],"path":["settings","webhooks"],"variable":[]},"description":"Post-call and initiation webhooks — scope settings:read"}},{"name":"Update webhook settings","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/webhooks","host":["{{baseUrl}}"],"path":["settings","webhooks"],"variable":[]},"description":"Update webhook settings — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Send a signed test event","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/webhooks/test","host":["{{baseUrl}}"],"path":["settings","webhooks","test"],"variable":[]},"description":"Send a signed test event — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Recent webhook deliveries","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/webhooks/deliveries","host":["{{baseUrl}}"],"path":["settings","webhooks","deliveries"],"variable":[]},"description":"Recent webhook deliveries — scope settings:read"}},{"name":"Where your call results go","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/send-to","host":["{{baseUrl}}"],"path":["settings","send-to"],"variable":[]},"description":"Where your call results go — scope settings:read"}},{"name":"Choose where your call results go","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/send-to","host":["{{baseUrl}}"],"path":["settings","send-to"],"variable":[]},"description":"Choose where your call results go — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Your test address and what arrived there","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/send-to/inbox","host":["{{baseUrl}}"],"path":["settings","send-to","inbox"],"variable":[]},"description":"Your test address and what arrived there — scope settings:read"}},{"name":"Your variables and their defaults","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/variables","host":["{{baseUrl}}"],"path":["settings","variables"],"variable":[]},"description":"Your variables and their defaults — scope settings:read"}},{"name":"Replace your variables","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/variables","host":["{{baseUrl}}"],"path":["settings","variables"],"variable":[]},"description":"Replace your variables — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Make or change one variable","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/variables/:name","host":["{{baseUrl}}"],"path":["settings","variables",":name"],"variable":[{"key":"name","value":""}]},"description":"Make or change one variable — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Remove one variable","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/variables/:name","host":["{{baseUrl}}"],"path":["settings","variables",":name"],"variable":[{"key":"name","value":""}]},"description":"Remove one variable — scope settings:write"}},{"name":"What an agent would say with these values","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/variables/preview","host":["{{baseUrl}}"],"path":["settings","variables","preview"],"variable":[]},"description":"What an agent would say with these values — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Your CRM connection","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/crm","host":["{{baseUrl}}"],"path":["settings","crm"],"variable":[]},"description":"Your CRM connection — scope settings:read"}},{"name":"Connect your CRM, change its URL, or switch it off","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/crm","host":["{{baseUrl}}"],"path":["settings","crm"],"variable":[]},"description":"Connect your CRM, change its URL, or switch it off — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Send a signed sample to your CRM","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/crm/test","host":["{{baseUrl}}"],"path":["settings","crm","test"],"variable":[]},"description":"Send a signed sample to your CRM — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Start connecting Zoho CRM","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/crm/zoho/start","host":["{{baseUrl}}"],"path":["settings","crm","zoho","start"],"variable":[]},"description":"Start connecting Zoho CRM — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Make a new signing secret","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/crm/secret","host":["{{baseUrl}}"],"path":["settings","crm","secret"],"variable":[]},"description":"Make a new signing secret — scope settings:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Recording and privacy settings","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/settings/compliance","host":["{{baseUrl}}"],"path":["settings","compliance"],"variable":[]},"description":"Recording and privacy settings — scope settings:read"}},{"name":"Your secrets (names only)","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/secrets","host":["{{baseUrl}}"],"path":["secrets"],"variable":[]},"description":"Your secrets (names only) — scope settings:read"}}]},{"name":"Billing","description":"Your plan, this month's billed usage and invoices. Read-only.","item":[{"name":"Credits left, plan and rates","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/credits","host":["{{baseUrl}}"],"path":["credits"],"variable":[]},"description":"Credits left, plan and rates — scope billing:read"}},{"name":"Every charge and credit, newest first","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/credits/ledger","host":["{{baseUrl}}"],"path":["credits","ledger"],"variable":[]},"description":"Every charge and credit, newest first — scope billing:read"}},{"name":"A month, line by line, with the call behind every charge","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/credits/statement","host":["{{baseUrl}}"],"path":["credits","statement"],"variable":[]},"description":"A month, line by line, with the call behind every charge — scope billing:read"}},{"name":"The monthly statement as CSV","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/credits/statement.csv","host":["{{baseUrl}}"],"path":["credits","statement.csv"],"variable":[]},"description":"The monthly statement as CSV — scope billing:read"}},{"name":"Your current plan","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/billing/plan","host":["{{baseUrl}}"],"path":["billing","plan"],"variable":[]},"description":"Your current plan — scope billing:read"}},{"name":"Billed usage for a month","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/billing/usage","host":["{{baseUrl}}"],"path":["billing","usage"],"variable":[]},"description":"Billed usage for a month — scope billing:read"}},{"name":"List invoices","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/billing/invoices","host":["{{baseUrl}}"],"path":["billing","invoices"],"variable":[]},"description":"List invoices — scope billing:read"}},{"name":"One invoice with its lines","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/billing/invoices/:id","host":["{{baseUrl}}"],"path":["billing","invoices",":id"],"variable":[{"key":"id","value":""}]},"description":"One invoice with its lines — scope billing:read"}}]},{"name":"Do not call","description":"The opt-out list. A number here is refused before the switch is touched.","item":[{"name":"List opted-out numbers","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dnd","host":["{{baseUrl}}"],"path":["dnd"],"variable":[]},"description":"List opted-out numbers — scope calls:read"}},{"name":"Add numbers in bulk","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dnd/bulk","host":["{{baseUrl}}"],"path":["dnd","bulk"],"variable":[]},"description":"Add numbers in bulk — scope calls:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Update an entry","request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dnd/:id","host":["{{baseUrl}}"],"path":["dnd",":id"],"variable":[{"key":"id","value":""}]},"description":"Update an entry — scope calls:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Remove an entry","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dnd/:id","host":["{{baseUrl}}"],"path":["dnd",":id"],"variable":[{"key":"id","value":""}]},"description":"Remove an entry — scope calls:write"}}]},{"name":"Leads","description":"Send a lead in and have it called at once (call now / schedule / no) - the same as a lead URL from Settings > Lead sources; read the leads and what their calls are doing.","item":[{"name":"List the leads you sent in","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/leads","host":["{{baseUrl}}"],"path":["leads"],"variable":[]},"description":"List the leads you sent in — scope calls:read"}},{"name":"Send a lead in (and have it called)","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/leads","host":["{{baseUrl}}"],"path":["leads"],"variable":[]},"description":"Send a lead in (and have it called) — scope calls:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"One lead, its call now, the calls made and its appointment","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/leads/:id","host":["{{baseUrl}}"],"path":["leads",":id"],"variable":[{"key":"id","value":""}]},"description":"One lead, its call now, the calls made and its appointment — scope calls:read"}}]},{"name":"Appointments","description":"Site visits, meetings, demos and consultations - booked, confirmed, moved or flagged by a call, an agent tool, your CRM or this API; one id, one status, one history; your CRM and webhooks are told on every change.","item":[{"name":"List appointments","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments","host":["{{baseUrl}}"],"path":["appointments"],"variable":[]},"description":"List appointments — scope appointments:read"}},{"name":"Book an appointment","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments","host":["{{baseUrl}}"],"path":["appointments"],"variable":[]},"description":"Book an appointment — scope appointments:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"One appointment with its history","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments/:id","host":["{{baseUrl}}"],"path":["appointments",":id"],"variable":[{"key":"id","value":""}]},"description":"One appointment with its history — scope appointments:read"}},{"name":"Change an appointment (any action)","request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments/:id","host":["{{baseUrl}}"],"path":["appointments",":id"],"variable":[{"key":"id","value":""}]},"description":"Change an appointment (any action) — scope appointments:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Confirm (the customer reconfirmed)","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments/:id/confirm","host":["{{baseUrl}}"],"path":["appointments",":id","confirm"],"variable":[{"key":"id","value":""}]},"description":"Confirm (the customer reconfirmed) — scope appointments:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Move to a new time","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments/:id/reschedule","host":["{{baseUrl}}"],"path":["appointments",":id","reschedule"],"variable":[{"key":"id","value":""}]},"description":"Move to a new time — scope appointments:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"He will come later, no new time yet","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments/:id/reschedule_requested","host":["{{baseUrl}}"],"path":["appointments",":id","reschedule_requested"],"variable":[{"key":"id","value":""}]},"description":"He will come later, no new time yet — scope appointments:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"He may not come (a person decides)","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments/:id/cancel_requested","host":["{{baseUrl}}"],"path":["appointments",":id","cancel_requested"],"variable":[{"key":"id","value":""}]},"description":"He may not come (a person decides) — scope appointments:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Cancel","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments/:id/cancel","host":["{{baseUrl}}"],"path":["appointments",":id","cancel"],"variable":[{"key":"id","value":""}]},"description":"Cancel — scope appointments:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Mark done","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments/:id/complete","host":["{{baseUrl}}"],"path":["appointments",":id","complete"],"variable":[{"key":"id","value":""}]},"description":"Mark done — scope appointments:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Mark no-show","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/appointments/:id/no_show","host":["{{baseUrl}}"],"path":["appointments",":id","no_show"],"variable":[{"key":"id","value":""}]},"description":"Mark no-show — scope appointments:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}}]},{"name":"Integrations","description":"REST hooks and the auth test used by the Zapier and Make apps (and any API client) - call results as they happen.","item":[{"name":"Who am I","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/me","host":["{{baseUrl}}"],"path":["me"],"variable":[]},"description":"Who am I — scope calls:read"}},{"name":"Your REST hooks","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/hooks","host":["{{baseUrl}}"],"path":["hooks"],"variable":[]},"description":"Your REST hooks — scope calls:read"}},{"name":"Subscribe a URL to an event (REST hook)","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/hooks","host":["{{baseUrl}}"],"path":["hooks"],"variable":[]},"description":"Subscribe a URL to an event (REST hook) — scope calls:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Unsubscribe a REST hook","request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/hooks/:id","host":["{{baseUrl}}"],"path":["hooks",":id"],"variable":[{"key":"id","value":""}]},"description":"Unsubscribe a REST hook — scope calls:write"}},{"name":"Send a signed sample of the hook's event","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/hooks/:id/test","host":["{{baseUrl}}"],"path":["hooks",":id","test"],"variable":[{"key":"id","value":""}]},"description":"Send a signed sample of the hook's event — scope calls:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"The newest items of an event (polling)","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/hooks/recent","host":["{{baseUrl}}"],"path":["hooks","recent"],"variable":[]},"description":"The newest items of an event (polling) — scope calls:read"}}]},{"name":"Catalogue","description":"Voices, text to speech, models and voice tuning.","item":[{"name":"List voices","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/voices","host":["{{baseUrl}}"],"path":["voices"],"variable":[]},"description":"List voices — scope agents:read"}},{"name":"List what your campaigns are about","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/subjects","host":["{{baseUrl}}"],"path":["subjects"],"variable":[]},"description":"List what your campaigns are about — scope agents:read"}},{"name":"Hear a voice","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/voices/:voiceId/sample","host":["{{baseUrl}}"],"path":["voices",":voiceId","sample"],"variable":[{"key":"voiceId","value":""}]},"description":"Hear a voice — scope agents:read"}},{"name":"Hear your own line in a voice","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/voices/:voiceId/try","host":["{{baseUrl}}"],"path":["voices",":voiceId","try"],"variable":[{"key":"voiceId","value":""}]},"description":"Hear your own line in a voice — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"Text to speech","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/voices/tts","host":["{{baseUrl}}"],"path":["voices","tts"],"variable":[]},"description":"Text to speech — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"name":"LLM model ids by provider","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/models","host":["{{baseUrl}}"],"path":["models"],"variable":[]},"description":"LLM model ids by provider — scope agents:read"}},{"name":"AI models you can pick, and what each adds per minute","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/llm/models","host":["{{baseUrl}}"],"path":["llm","models"],"variable":[]},"description":"AI models you can pick, and what each adds per minute — scope agents:read"}},{"name":"Current voice tuning","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/voice-tuning","host":["{{baseUrl}}"],"path":["voice-tuning"],"variable":[]},"description":"Current voice tuning — scope agents:read"}},{"name":"Update voice tuning","request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"},{"key":"content-type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/voice-tuning","host":["{{baseUrl}}"],"path":["voice-tuning"],"variable":[]},"description":"Update voice tuning — scope agents:write","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}}]},{"name":"Reports","description":"Exports and dashboard reporting.","item":[{"name":"Export calls (and, for a workspace whose own CRM keeps its leads, its campaigns' call results)","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/export/leads","host":["{{baseUrl}}"],"path":["export","leads"],"variable":[]},"description":"Export calls (and, for a workspace whose own CRM keeps its leads, its campaigns' call results) — scope calls:read"}},{"name":"Filters available for export","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/export/filters","host":["{{baseUrl}}"],"path":["export","filters"],"variable":[]},"description":"Filters available for export — scope calls:read"}},{"name":"Call health over the last hour","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dashboard/health","host":["{{baseUrl}}"],"path":["dashboard","health"],"variable":[]},"description":"Call health over the last hour — scope usage:read"}},{"name":"Calls, answer rate and latency over a date range","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/analytics/overview","host":["{{baseUrl}}"],"path":["analytics","overview"],"variable":[]},"description":"Calls, answer rate and latency over a date range — scope usage:read"}},{"name":"Call outcome report","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/dashboard/reports","host":["{{baseUrl}}"],"path":["dashboard","reports"],"variable":[]},"description":"Call outcome report — scope usage:read"}}]},{"name":"Platform","description":"Platform-wide status that affects every account.","item":[{"name":"Is outbound calling paused?","request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/system/pause","host":["{{baseUrl}}"],"path":["system","pause"],"variable":[]},"description":"Is outbound calling paused? — scope system:read"}}]}]}