List all agent processes

GET

/api/v1/chat/processes

const url = 'http://localhost:11044/api/v1/chat/processes';
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/processes \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Returns all known agent processes — the chat session and any child processes (actions, tasks, cron). Includes running and recently completed processes.

Authorizations

apiKeyAuth
basicAuth

Responses

200

List of processes

*/*

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