Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifacts API
- Assets API
- Auth configs API
- Buckets API
- Builds API
- Catalogs API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Queue execution on an agent session
Explicitly reserves existing captured authority for one future turn, without executing it.
Explicitly reserves existing captured authority for one future turn, without executing it.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agent_sessions/agent-session:queueExecution - Scope
agents:sessions - Effect
write— a successful call changes state. - Collection agent_sessions
#Request
| Field | Type | What it is |
|---|---|---|
name | string | Existing owning Session. Required. |
execution | SessionTurnExecution | Existing handles captured by this caller for this exact future turn. Required. |
goal | string | Exact current Goal, or empty only when the Session has no Goal. |
expected_goal_version | int32 | Required for a Goal; its observed contract version when granting authority. |
operation_id | string | Permanent caller mutation identity, at most 128 bytes. Required. |
expected_generation | int64 | Zero on first creation; replacing authority requires its exact generation. |
automatic | bool | Explicitly authorize automatic ready-wait resume with these exact captures. Default false only reserves them. Requires captured agents:sessions as well as runtime permissions; owner holds and ordinary admission still apply. |
#SessionTurnExecution
| Field | Type | What it is |
|---|---|---|
turn | int64 | The expected next turn. A concurrent admission never changes this pin. Required. |
runtime_credential_handle | string | Same-turn captured caller authority for Workflows and lazy Sandbox APIs. Required. Never returned again. |
credentials | map<string, CredentialBinding> | Same-turn execution handles by alias, including inference and any pinned tool or repository capabilities. Each retains its existing permission gate. |
#CredentialBinding
| Field | Type | What it is |
|---|---|---|
secret | string | A Kernel Secret of this environment, by name. One of the source group. |
connection | string | A Kernel Connection (a third-party OAuth installation), by name. One of the source group. |
end_user_provider | string | The end user's own grant in Sylphx Auth's agent token vault, by provider id; the session's end user must hold it. One of the source group. |
placement | string | How the value is sent: bearer (default), header:<Name> or query:<name>. |
handle | string | An opaque credential handle issued for this session, resolved only at egress. This is never a credential value. Never returned again. One of the source group. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | Exact Session and reserved public turn number. |
uid | string | Immutable platform Resource UID. Output only. |
meta | ResourceMeta | Standard metadata. Output only. |
turn | int64 | Exact future turn; never selected by a model or a Task. Output only. |
state | string | queued, consumed, superseded or cancelled. Queued does not run inference. Output only. |
goal | string | Optional exact Goal whose objective and budget this authority covers. Output only. |
expire_time | timestamp | Earliest captured handle expiry; ordinary admission revalidates all grants. Output only. |
create_time | timestamp | When the caller reserved this execution. Output only. |
update_time | timestamp | When the state last changed. Output only. |
generation | int64 | Configuration generation, advanced only by explicit replacement. Output only. |
automatic | bool | Whether the caller explicitly authorized automatic wait readmission. Output only. |
continuation_state | string | disabled, unscheduled, pending, waiting or finished; no inference implied. Output only. |
blocked_reason | string | Current delivery/authority/owner hold, when automatic continuation is blocked. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong 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_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
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:queueExecution" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"execution":{"runtime_credential_handle":"…","turn":1},"operation_id":"…"}'