Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

sylphx agents waits

Every sylphx agents waits command: its argument, its flags and a run line.

The waits commands of Sylphx Agents, as the CLI spells them: the same calls as the waits API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#create

Creates a durable wait on an idle Session, with permanent operation replay.

CLI

Shell
sylphx agents waits create --parent orgs/acme/projects/shop/envs/production/agent_sessions/agent-session --type … --resume-prompt …

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

Flags

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--goalstringOptional exact Goal in this Session, never a current-Goal selector.
--typestringtime or signal. Other producer types require their own admitted adapter. Required.
--referencestringExact source reference for a signal; empty for a timer.
--deadlinetimestampActual future due time; required only for a timer.
--resume-promptstringWhat to do after observing this wait's evidence, at most 16 KiB. Required.
--operation-idstringPermanent caller mutation identity, at most 128 bytes. Required.
--expected-goal-versionintRequired when the wait names a Goal; its exact observed contract version.

#get

Reads an exact wait and its retained evidence.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx agents waits get orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/waits/wait

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

#list

Lists durable waits, including ready undelivered owners.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx agents waits list orgs/acme/projects/shop/envs/production/agent_sessions/agent-session

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

Flags

FlagTypeWhat it does
--page-sizeintDefault 50, clamped to 1000.
--page-tokenstringThe preceding response's next_page_token.

#resolve

Records observed signal evidence or checks a timer against its actual due time.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx agents waits resolve orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/waits/wait

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/waits/wait:resolve · scope agents:sessions · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--operation-idstringPermanent caller mutation identity, at most 128 bytes. Required.
--referencestringExact recorded signal source; omitted for a timer.
--evidencejsonNonempty observed signal evidence; omitted for a timer.

#cancel

Cancels only this exact undelivered wait; repeated operations retain receipts.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx agents waits cancel orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/waits/wait

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/waits/wait:cancel · scope agents:sessions · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--operation-idstringPermanent caller mutation identity, at most 128 bytes. Required.