Skip to main content
POST
Tool Call

Authorizations

gateway_session
string
cookie
required

Secure same-origin browser session cookie.

Headers

X-Aixy-Tool-Context
string<uuid>
required
X-Aixy-Session-ID
string

Optional Activity conversation ID shared with model rounds. Invalid IDs are ignored; the selected key supplies scope.

Maximum string length: 128

Body

application/json
model
string
required
api_key_id
string<uuid>
required
server_ids
string<uuid>[]
required
Required array length: 1 - 20 elements
name
string
required
Pattern: ^[a-z0-9_]{1,65}\.[a-z0-9_]{1,60}$
arguments
Arguments · object
required
execution_id
string<uuid>
required

A unique UUID for this proposed action. Reuse it after an uncertain submission; duplicates are rejected for 24 hours.

server_revision
integer
required
Required range: x >= 1
definition_revision
string
required
Pattern: ^[0-9a-f]{64}$
approved
boolean
required
endpoint
enum<string>
default:chat/completions
Available options:
chat/completions,
responses,
messages
project_id
string<uuid> | null

Response

Successful Response

content
string
required
is_error
boolean
required
duration_ms
integer
required