Skip to content
Console
On this page

Delete an agent

Deletes an agent and its versions.

Deletes an agent and its versions. An agent with sessions is refused with INVALID_STATE unless force is set, which deletes them too.

  • Path DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents/agent
  • Scope agents:write
  • Effect destructive — a successful call removes data; the CLI asks before it runs.
  • Collection agents
  • Query etag, allow_missing, validate_only, force

Request

FieldTypeWhat it is
namestringThe name of the agent to delete. Required.
etagstringDelete only if the current etag matches.
allow_missingboolSucceed when the agent does not exist.
validate_onlyboolValidate without deleting anything.
forceboolAlso delete the agent's sessions; without it, an agent with sessions is refused with INVALID_STATE.

Response

The call answers with an empty object.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X DELETE "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents/agent" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"