GET
/
v1
/
{account_id}
/
{project_id}
/
handoff_state
curl --request GET \
  --url https://api.us-1.platform.polyai.app/v1/{account_id}/{project_id}/handoff_state \
  --header 'x-api-key: <api-key>'
{
  "id": "0bba04d7-38b3-4fd3-a1a8-329c34517fc1",
  "shared_id": "acme_inc_sdklfasdklfjasbdfklabs",
  "data": {
    "customer_id": "12345",
    "handoff_reason": "successfully_identified"
  }
}

Authorizations

​
x-api-key
string
header
required

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
OK
​
id
string
required

The PolyAI ID of the conversation

Example:

"0bba04d7-38b3-4fd3-a1a8-329c34517fc1"

​
data
object
required

The data stored for this conversation

Example:
{
  "customer_id": "12345",
  "handoff_reason": "successfully_identified"
}
​
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

Example:

"acme_inc_sdklfasdklfjasbdfklabs"