Get session and process status

GET

/api/v1/chat/status

const url = 'http://localhost:11044/api/v1/chat/status';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/chat/status \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Returns the status of the user’s chat session and any running agent processes. Use this to monitor progress of long-running actions.

Authorizations

apiKeyAuth
basicAuth

Responses

200

Session status

*/*

object

404

No active session

*/*

A refusal from the chat surface: the word error and the reason, written to be shown

object

message

required

What was refused and why, such as no open stream, no active session, or an unknown command

string

status

required

Always error. A client may branch on it rather than on the status code

string

Example

error