End a conversation
Ends one of your organization's conversations the way it ends when the person hangs up, though for now the page's session.closed may name the reason error rather than close_requested. One that hasn't started ends at once; a running one ends within a few seconds, once the AI persona leaves, and its place counts until then. Answers with the conversation as it stands, so a running one can still say connected. One already over is left as it is. It has no body; send Content-Length: 0. Reaches only your organization's conversations: another's answers 404.
apiKeyAuthorizationBearer <token>An API key from your organization's API keys page on the platform, nk_…. Server only.
conversation_id*stringThe conversation's id.
uuidSuccessful Response
application/json- response
Where one of your conversations stands.
id*stringThe conversation's id.
uuidstatus*ConversationStatusWhere the conversation is in its life.
"created""ready""queued""admitted""connecting""connected""ended""failed""expired"created_at*stringWhen it was created (UTC).
date-timestarted_at*|When the persona started it (UTC); null while it waits or joins, and for one that ended without running.
curl -X POST 'https://api.nuancelabs.ai/conversation/497f6eca-6276-4993-bfeb-53cbbbba6f08/end'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "created", "created_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z"}List active conversations GET
Your organization's active conversations, ones still starting included, oldest first: the ones its limit on conversations at once counts. Each has its id, its status, when it was created and when the AI persona started it, so you can find one to end. Reaches only your organization's conversations.
Get your usage GET
Your organization's limits, today's credits, your credit balance and what is available in all, and how many conversations its API keys hold active now, ones still starting included. Check it before starting a conversation to avoid a 409 or 429.