Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Invoke tool on an agent session
Guest execution capability authentication, not an Access management key.
Guest execution capability authentication, not an Access management key. Preserve any JSON tool result, including scalars and arrays.
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/agent_sessions/agent-session:invoke-tool - Scope
agents:sessions - Effect
write— a successful call changes state. - Collection agent_sessions
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the session whose pinned tools are used. Required. |
turn | int64 | The live turn whose execution capability authorizes the call. Required. |
tool | string | The tool name in the session's pinned agent version. Required. |
arguments | struct | The tool input, validated against its pinned input schema. Required. |
op_id | string | The stable operation identifier, reused for idempotent tool-call retries. Required. |
#Response
The call answers with an empty object.
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.
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:invoke-tool" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"arguments":{},"op_id":"…","tool":"…","turn":1}'