deleteAgent

DELETE

/api/v1/agents/{agentId}

Destroys the sandbox and its home volume, then the agent. Runs in the background.

deleteAgent

curl --request DELETE \
  --url '<base-url>/api/v1/agents/<agentId>' \
  --cookie 'agenthold_session=<agenthold_session>'

const url = '<base-url>/api/v1/agents/<agentId>';
const options = {
  method: 'DELETE',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Returns

202

Destruction started.

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required

409

Error.

JSON

error
string
required