This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Get the metadata of an Agent session.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:agents-read.
objectstringIdentifies an Agent session.
stringThe Agent the session was created for.
objectoptionalThe Agent API name and ontology RID for the Agent the session was created for. Empty if the Agent does not have an ontology binding.
stringThe Agent version the session was created for.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/agents/agentSessions/3fa85f64-5717-4562-b3fc-2c963f66afa6?preview=true"1
2
3
4
5
6
7
8
9
{
"agentRid": "ri.agent-engine..agent-definition.0b1a801c-de31-4c3d-96a6-e8a1a6a0c1b2",
"agentVersion": "1.2.0",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"agentApiNameIdentifier": {
"agentApiName": "customerSupportAgent",
"ontology": "example-ontology"
}
}| Error Name | ||
|---|---|---|
Unsupported | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The Agent is not supported by this API. | |
| Parameters | | |
Agent | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given AgentSession could not be found. | |
| Parameters | agentSessionId | |
See Errors for a general overview of errors in the platform.