GET
/
v1
/
{account_id}
/
{project_id}
/
handoff_state

Authorizations

x-api-key
string
headerrequired

Path Parameters

account_id
string
required

Account ID

project_id
string
required

Project ID

Query Parameters

id
string

The PolyAI ID of the conversation. API queries can include either id or shared_id, but must include at least one of them. If both are included, shared_id takes precedence for querying.

shared_id
string

shared ID can be used to query information. API queries can include either id or shared_id, but must include at least one of them. If both are included, shared_id takes precedence for querying.

Response

200 - application/json
id
string
required

The PolyAI ID of the conversation

shared_id
string

shared_id can be used to query information. This is optionally visible in response based on whether there is a shared_id associated with the data

data
object
required

The data stored for this conversation

Get Max Concurrent call numbers