Kill a running process

DELETE

/api/v1/chat/process/{processId}

const url = 'http://localhost:11044/api/v1/chat/process/example';
const options = {method: 'DELETE', 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 DELETE \
  --url http://localhost:11044/api/v1/chat/process/example \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Kills a running agent process by ID. Use GET /status to find the process ID. This stops any running actions including Docker sandbox processes.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

processId

required

string

Id of the agent process to kill, as reported in processId by GET /api/v1/chat/status or GET /api/v1/chat/processes; 404 when no process has it

Responses

200

Process killed

*/*

A process that was running and has been killed

object

previousStatus

required

The process’s status at the moment it was killed, such as RUNNING or WAITING

string

processId

required

The process id, as given

string

status

required

Always killed

string

Example

killed

404

Process not found

*/*

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