NylorunDocsBeta
Runtime APIAgents

Delete an Agent

DELETE
/v1/agents/{agentId}

Deletes the Agent, its vault with every secret, and its disk. Its sessions keep its id; their next turn is refused (agent_unavailable) until an Agent with this id exists again.

Authorization

headerAuthorizationBearer <token>

An application key of the Tenant (PUT /v1/tenant/keys/{keyId}), or Studio's key, derived from the admin key. With Nylorun-Subject and Nylorun-Scopes, it acts for that person, narrowed to those scopes. Never accepted from a browser (Origin).

Path Parameters

agentId*string

The Agent id, percent-encoded: users%2Falice%2Ftriage for users/alice/triage

Header Parameters

Nylorun-Protocol*string

The protocol version, 18

Nylorun-Subject?string

The person an application key acts for

Nylorun-Scopes?string

The subject's space-separated scopes; required with a subject

Response Body

Deleted, or there was none

application/json
  1. response
id*string
deleted*boolean
import { createClient } from "@nylorun/agents";const client = await createClient();await client.agents.delete("users/alice/assistant");
{  "id": "string",  "deleted": true}