Get conversation status

Learn more about get conversation status.

Use the Get conversation status to get the status of a conversation. This lets you check the status of a single execution without listing every run.

HTTP method and endpoint

Use the following HTTP method and endpoint path to get conversation status.

GET {TenantURL}/ai/agentflow/api/v202605/{tenant_id}/schedules/{schedule_id}/conversations/{conversation_id}

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`TenantURL`	String	Yes	The base URL for your tenant.
`tenant_id`	String	Yes	The unique identifier of your tenant.
`schedule_id`	String	Yes	The unique identifier of the schedule.
`conversation_id`	String	Yes	The unique identifier of the conversation.

The following request headers must be included.


Header	Value	Required
`Authorization`	`<access_token>`	Yes

This operation does not require a request body.

Use the following example to see how a complete request is structured, with headers.

GET {TenantURL}/ai/agentflow/api/v202605/tenant-xyz/schedules/example-id/conversations/example-id
Authorization: <access_token>

The following table describes the fields returned in the response body.


Parameter	Type	Description
`conversation_id`	String	The unique identifier of the conversation.
`status`	String	The status of the execution: running, completed, stopped, or failed.
`started_at`	String	The date and time when the execution started.
`completed_at`	String	The date and time when the execution finished. Empty if the execution is still running.

The following example shows a response with successful response.

{
  "conversation_id": "conv-abc123",
  "status": "completed",
  "started_at": "2025-05-13T09:00:00Z",
  "completed_at": "2025-05-13T09:15:30Z"
}

The following table lists the possible error responses returned by this API.


HTTP status	Description	Recommended action
`422 Unprocessable Entity`	Validation Error	Review the request parameters or body, correct the invalid values, and resend the request.