Skip to content
Console
On this page

Agents

An Agent is a versioned agent definition: model, instructions, tools, MCP servers, skills, memory stores, tool policy and budget.

An Agent is a versioned agent definition: model, instructions, tools, MCP servers, skills, memory stores, tool policy and budget. Each create or update that changes spec mints a new immutable AgentVersion; a session pins the version it started on, so a change never alters a running conversation.

Service Sylphx Agents · Resource type agents.sylphx.com/Agent · Name pattern orgs/{org}/projects/{project}/envs/{env}/agents/{agent} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/agents/{agent}.
uidstringagt_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specAgentSpecDesired state: the definition the next version takes. Required.
statusAgentStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
POSTcapture_credentialCaptures an existing grant for one session and purpose; never issues a key.
POSTrotate_credentialRotates the captured value under the same handle with generation fencing.
POSTrevoke_credentialRevokes one captured handle. Repeating the revocation is harmless.
GETgetGets an agent.
GETlistLists agents.
POSTcreateCreates an agent and its version 1.
PATCHupdateUpdates an agent. A change to spec mints the next AgentVersion; sessions already started keep the version they pinned.
DELETEdeleteDeletes an agent and its versions. An agent with sessions is refused with INVALID_STATE unless force is set, which deletes them too.
POSTrunAtomically admits a pinned task session, initial event and pending turn.

capture_credential

Captures an existing grant for one session and purpose; never issues a key.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents:capture-credential · scope agents:sessions · effect write · Request, response and examples

rotate_credential

Rotates the captured value under the same handle with generation fencing.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents:rotate-credential · scope agents:sessions · effect write · Request, response and examples

revoke_credential

Revokes one captured handle. Repeating the revocation is harmless.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents:revoke-credential · scope agents:sessions · effect write · Request, response and examples

get

Gets an agent.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents/agent · scope agents:read · effect read · Request, response and examples

list

Lists agents.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents · scope agents:read · effect read · paginated · Request, response and examples

create

Creates an agent and its version 1.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents · scope agents:write · effect write · Request, response and examples

update

Updates an agent. A change to spec mints the next AgentVersion; sessions already started keep the version they pinned.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents/agent · scope agents:write · effect write · Request, response and examples

delete

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

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents/agent · scope agents:write · effect destructive · Request, response and examples

run

Atomically admits a pinned task session, initial event and pending turn.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents/agent:run · scope agents:sessions · effect write · Request, response and examples