Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Capture credential on an agent

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

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

Not available yet. Sylphx Agents is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents:capture-credential
  • Scope agents:sessions
  • Effect write — a successful call changes state.
  • Collection agents

#Request

FieldTypeWhat it is
parentstringThe environment in which the caller holds the existing grant. Required.
sessionstringThe prospective or existing session to bind this handle to. Required.
turnint64The turn allowed to use the execution credential. Required.
credentialstringThe existing caller-owned credential, stored encrypted and never logged. Required. Never returned again.
expires_attimestampThe issuer-provided expiry of the captured credential. Required.
allowed_toolsstring[]Pinned tool names allowed to inject this credential. Required.
purposestringexecution, completion, or runtime; runtime handles never enter the guest. Required.

#Response

FieldTypeWhat it is
handlestringThe opaque handle; it never reveals the captured credential. Output only. Never returned again.
generationint64The current fencing generation of the captured handle. Output only.
expires_attimestampThe issuer-provided expiry of the captured credential. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agents:capture-credential" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"allowed_tools":["…"],"credential":"…","expires_at":{},"purpose":"…","session":"…","turn":1}'