Get an Agent's execution status

get/bots/{agentId}/state

Get an Agent's execution status by ID. This endpoint returns a value of either 'idle' or 'running'.

Request Samples

1

Response Samples

1running

Path Parameters

NameTypeRequiredDescription
agentId
string
true

The ID of the Agent.

Responses

StatusMeaningDescription
200OK

The request succeeded.

Schema
400Bad Request

Bad request (the request is not well-formed).

Schema
401Unauthorized

Not authenticated.

Schema
403Forbidden

The user does not have permission to complete this request.

Schema
404Not Found

The specified resource was not found.

Schema
406Not Acceptable

Not Acceptable. Include an Accept header with a supported value on the request.

Schema
415Unsupported Media Type

Unsupported Media Type. Include a Content-Type header with a supported value in the request.

Schema