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
sylphx agents goals
Every sylphx agents goals command: its argument, its flags and a run line.
The goals commands of Sylphx Agents, as the CLI spells them: the same
calls as the goals API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#create
Creates an optional objective owned by this Session, without an external Task. The operation_id keeps the original receipt beyond request replay expiry.
CLI
sylphx agents goals create --parent orgs/acme/projects/shop/envs/production/agent_sessions/agent-session --objective …POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/goals · scope agents:sessions · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--objective | string | The objective, nonempty and at most 4,000 characters. Required. |
--token-budget | int | Omit unless the caller explicitly requests a positive token budget. |
--operation-id | string | Caller-stable mutation identity, nonempty and at most 128 bytes. Required. |
#get
Reads the exact Goal, including its terminal receipt after a successor starts.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx agents goals get orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/goals/goalGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/goals/goal · scope agents:sessions · effect read · Request, response and examples
#settle
Settles only the named Goal/version with an observed environment receipt. Replaying operation_id returns its original receipt, never its successor.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx agents goals settle orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/goals/goalPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/goals/goal:settle · scope agents:sessions · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--expected-version | int | The acceptance-contract version observed by the caller. Required. |
--state | enum | Only COMPLETED and FAILED settle a Goal. Waiting is not success. Required. One of working, waiting, completed, failed. |
--receipt | json | An actual observation at the delivered environment surface. Required. |
--operation-id | string | Caller-stable mutation identity, nonempty and at most 128 bytes. Required. |
#control
Applies an explicit owner control to this exact Goal/version. Pause interrupts only its current execution; resume does not resolve a wait or clear observed usage. Amend changes only supplied objective/budget fields.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx agents goals control orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/goals/goalPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/agent_sessions/agent-session/goals/goal:control · scope agents:sessions · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--expected-version | int | The contract version observed by the owner. Required. |
--action | enum | Explicit owner action. Only AMEND accepts objective/budget changes. Required. One of pause, resume, amend. |
--operation-id | string | Caller-stable mutation identity, nonempty and at most 128 bytes. Required. |
--objective | string | New objective, only when amending. Omission preserves the existing text. |
--token-budget | int | New explicit token budget, only when amending. Omission preserves it. |
--clear-token-budget | bool | Explicitly remove a budget when amending; incompatible with token_budget. |