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

Cancel a wait

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

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

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/waits/wait:cancel
  • Scope agents:sessions
  • Effect write — a successful call changes state.
  • Collection waits

#Request

FieldTypeWhat it is
namestringExact wait name. Required.
operation_idstringPermanent caller mutation identity, at most 128 bytes. Required.

#Response

FieldTypeWhat it is
namestringExact name; the final segment is the conserved wait UUID.
uidstringImmutable platform Resource UID. Output only.
metaResourceMetaStandard metadata. Output only.
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.
statestringactive, ready, resolved or cancelled. Ready still requires turn admission. Output only.
evidencestructOriginal bounded observed evidence, retained through delivery and restart. Output only.
resumed_turnint64The only turn that consumed this wait; unset until resolved. Output only.
create_timetimestampCreation time. Output only.
update_timetimestampLast state change time. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. 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/agent_sessions/agent-session/waits/wait:cancel" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operation_id":"…"}'