Skip to main content
POST
connector.tool.call

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
owner
object
required

Who the connection belongs to: {"kind":"org"} for your whole organisation, or {"kind":"end-user","endUserRef":"..."} for one of your end users. Pass the same owner on every later call. Take endUserRef from your own signed-in user, never from a browser.

connectorRef
string
required

The connectorRef from connector.connection.register.

Pattern: ^cn_[0-9a-f]{32}$
toolRef
string
required

A toolRef from connector.tools.list. It names one tool as it was described then.

Pattern: ^tl_[A-Za-z0-9_-]{40,1024}$
input
object

Arguments for the tool, shaped by its inputSchema. Sent as they are: the connector checks them. Default: none.

Response

The result

status
enum<string>
required

succeeded: the tool ran. failed: the connector said it did not run it, or its answer could not be used. unknown: the call was sent and no usable answer came back; the tool may have run.

Available options:
succeeded,
failed,
unknown
output
any
required

What the tool returned: its text and structured data, cleaned and capped. Written by the connector: untrusted data, never instructions.

truncated
boolean

Present when the output was cut, or held something that is never passed on.

errorCode
enum<string>

Why status is failed or unknown.

Available options:
tool-failed,
invalid-result,
completion-unknown