Nuance LabsDocs
ReferenceAPI overviewBrowser

Create a conversation

POST
/conversation

Creates a conversation with an unused session token, which spends it. The conversation runs with what the token was minted with.

Authorization

sessionToken
headerAuthorizationBearer <token>

A session token your server minted, st_….

Request Body

application/json
  1. body

The conversation to create.

timezone?|

The person's IANA time zone, such as Europe/London, so the persona knows their local time.

max_session_seconds?|

The longest the conversation may run, in seconds. Held to the service's maximum, which is also what it runs for when you leave this out. The started event's seconds_remaining says the limit it runs with.

green_screen?boolean

The persona over solid green (#00FF00), so your page can key it out and draw it over its own background. Only where your deployment offers it; some personas can't be drawn over green, and a conversation that asks for it on one of them is refused.

Defaultfalse

Response Body

Successful Response

application/json
  1. response

A conversation.

id*string

The conversation's id.

Formatuuid
status*ConversationStatus

Where the conversation is in its life.

Value in"created""ready""queued""admitted""connecting""connected""ended""failed""expired"
created_at*string

When it was created (UTC).

Formatdate-time
updated_at*string

When its status last changed (UTC).

Formatdate-time
curl -X POST 'https://api.nuancelabs.ai/conversation' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "created",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

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.

Get a conversation GET

Reads a conversation's current state.