Docs Servers Reference Cookbooks Sandbox

API reference

Schemas

The 23 object schemas the published OpenAPI document defines.

10 min read

View Markdown Edit on GitHub

Schemas

Generated from the published OpenAPI document. Operation pages link here by schema name.

AgentRevokeLimits

What this verb reaches and what it does not. Served with every 200 so the limit travels with the act.

Field	Type	Required	Description
`does_not_stop`	`string`	yes	—
`issue`	`string`	yes	—
`stops`	array of `string`	yes	—

GatewayPaymentResult

Field	Type	Required	Description
`audit`	array of object	yes	—
`requestId`	`string`	yes	—
`status`	`"completed"` \| `"denied"` \| `"requires-approval"` \| `"failed"`	yes	—
`wallet`	object	no	—

Policy

Field	Type	Required	Description
`agents`	array of `string`	yes	—
`config`	object	yes	—
`createdAt`	`string (date-time)`	yes	—
`enabled`	`boolean`	yes	—
`id`	`string`	yes	—
`name`	`string`	yes	—
`order`	`number`	yes	—
`tools`	array of `string`	yes	—
`type`	`"allow"` \| `"deny"` \| `"budget"` \| `"rate-limit"` \| `"time-window"` \| `"approval-required"`	yes	—
`updatedAt`	`string (date-time)`	yes	—

PolicyCreate

Field	Type	Required	Description
`agents`	array of `string`	no	—
`config`	—	no	—
`enabled`	`boolean`	no	—
`name`	`string`	yes	—
`tools`	array of `string`	no	—
`type`	`"allow"` \| `"deny"` \| `"budget"` \| `"rate-limit"` \| `"time-window"` \| `"approval-required"`	yes	—

PolicyEvaluation

Field	Type	Required	Description
`agentId`	`string`	yes	—
`decision`	`"allow"` \| `"deny"`	yes	—
`denialReason`	`string,null`	yes	—
`id`	`string`	yes	—
`ruleId`	`string,null`	yes	—
`ruleName`	`string,null`	yes	—
`timestamp`	`string (date-time)`	yes	—
`toolName`	`string`	yes	—

PolicyReorder

Field	Type	Required	Description
`ids`	array of `string`	yes	—

PolicyUpdate

Field	Type	Required	Description
`agents`	array of `string`	no	—
`config`	—	no	—
`enabled`	`boolean`	no	—
`name`	`string`	no	—
`tools`	array of `string`	no	—
`type`	`"allow"` \| `"deny"` \| `"budget"` \| `"rate-limit"` \| `"time-window"` \| `"approval-required"`	no	—

ServerCatalogRow

Field	Type	Required	Description
`auth_type`	`string`	yes	—
`category`	`string`	yes	—
`country`	`string`	yes	—
`description`	`string,null`	yes	—
`engine_provisionable`	`boolean`	yes	Has an engine provisioning descriptor AND is not quarantined.
`engine_status`	`"none"` \| `"available"` \| `"quarantined"`	yes	Carries the reason `engine_provisionable` is false.
`id`	`string`	yes	—
`name`	`string`	yes	—
`pkg`	`string`	yes	—
`provider_docs_url`	`string,null`	no	—
`provider_homepage`	`string,null`	no	—
`provider_logo_fallback_url`	`string,null`	no	—
`provider_logo_url`	`string,null`	no	—
`sandbox_available`	`boolean`	no	—
`sandbox_url`	`string,null`	no	—
`status`	`string`	yes	—
`subaccount_provisionable`	`boolean`	yes	—
`tools_count`	`integer`	yes	—

Session

Field	Type	Required	Description
`closed_at`	`string,null (date-time)`	no	—
`created_at`	`string (date-time)`	yes	—
`id`	`string`	yes	`ses_`-prefixed
`org_id`	`string`	yes	—
`project_id`	`string`	yes	—
`servers`	array of `string`	yes	—
`status`	`"active"` \| `"closed"` \| `"error"`	yes	—
`user_id`	`string`	yes	—

ToolCall

Field	Type	Required	Description
`called_at`	`string (date-time)`	yes	—
`duration_ms`	`integer,null`	yes	—
`error_code`	`string,null`	yes	—
`failover_trail`	—	no	—
`id`	`string`	yes	`tc_`-prefixed: the bigserial with a `tc_` prefix prepended
`input`	—	no	—
`output`	—	no	—
`routing`	—	no	—
`server_id`	`string`	yes	—
`session_id`	`string`	yes	—
`status`	`"running"` \| `"success"` \| `"error"`	yes	—
`tool_name`	`string`	yes	—

Trigger

Field	Type	Required	Description
`created_at`	`string (date-time)`	yes	—
`event`	`string`	yes	—
`id`	`string`	yes	—
`last_run_at`	`string,null (date-time)`	yes	—
`name`	`string`	yes	—
`org_id`	`string`	yes	—
`project_id`	`string,null`	yes	nullable during the 0014→0015 rollout
`server_id`	`string,null`	yes	—
`signing_enabled`	`boolean`	yes	Whether a signing secret exists. The secret itself is never read back — the serializer drops the vault reference and reports only this.
`status`	`string`	yes	—
`total_runs`	`integer`	yes	—
`webhook_url`	`string`	yes	—

TriggerCreated

Type: —

Wallet

Field	Type	Required	Description
`agent_id`	`string,null`	yes	—
`balances`	array of WalletBalance	no	—
`closed_at`	`string,null (date-time)`	yes	—
`created_at`	`string (date-time)`	yes	—
`display_name`	`string`	yes	—
`id`	`string`	yes	—
`metadata`	object	yes	—
`org_id`	`string`	yes	—
`project_id`	`string`	yes	—
`status`	`"active"` \| `"frozen"` \| `"closed"`	yes	—

WalletAnomalyResolve

Field	Type	Required	Description
`note`	`string`	no	—
`status`	`"resolved"` \| `"dismissed"`	yes	—

WalletBalance

Field	Type	Required	Description
`available_minor`	`string`	yes	bigint as string
`balance_minor`	`string`	yes	bigint as string
`currency`	`"BRL"` \| `"USD"` \| `"MXN"` \| `"COP"` \| `"ARS"` \| `"USDC"` \| `"BRLA"`	yes	—
`updated_at`	`string (date-time)`	yes	—
`wallet_id`	`string`	yes	—

WalletCreate

Field	Type	Required	Description
`agent_id`	`string,null`	no	—
`currency`	`"BRL"` \| `"USD"` \| `"MXN"` \| `"COP"` \| `"ARS"` \| `"USDC"` \| `"BRLA"`	yes	—
`display_name`	`string`	yes	—
`metadata`	object	no	—

WalletExecute

Field	Type	Required	Description
`amount`	`number`	yes	—
`attempt_id`	`string`	no	—
`currency`	`"BRL"` \| `"USD"` \| `"MXN"` \| `"COP"` \| `"ARS"` \| `"USDC"` \| `"BRLA"`	yes	—
`description`	`string`	yes	—
`mandate_id`	`string`	yes	—
`metadata`	object	no	—
`preferred_method`	`string`	no	—
`purpose`	`string`	no	—
`recipient`	`string`	yes	—
`target_currency`	`"USD"` \| `"EUR"` \| `"BRL"` \| `"MXN"`	no	—

WalletFundingSource

Field	Type	Required	Description
`connection_id`	`string`	yes	—
`created_at`	`string (date-time)`	yes	—
`currency`	`"BRL"` \| `"USD"` \| `"MXN"` \| `"COP"` \| `"ARS"` \| `"USDC"` \| `"BRLA"`	yes	—
`enabled`	`boolean`	yes	—
`metadata`	object	yes	—
`wallet_id`	`string`	yes	—

WalletFundingSourceBind

Field	Type	Required	Description
`connection_id`	`string`	yes	—
`currency`	`"BRL"` \| `"USD"` \| `"MXN"` \| `"COP"` \| `"ARS"` \| `"USDC"` \| `"BRLA"`	yes	—
`metadata`	object	no	—

WalletLedgerEntry

Field	Type	Required	Description
`amount_minor`	`string`	yes	bigint signed minor units
`attempt_id`	`string,null`	yes	—
`currency`	`"BRL"` \| `"USD"` \| `"MXN"` \| `"COP"` \| `"ARS"` \| `"USDC"` \| `"BRLA"`	yes	—
`external_ref`	`string,null`	yes	—
`id`	`string`	yes	bigserial as string
`kind`	`"fund"` \| `"hold"` \| `"release"` \| `"debit"` \| `"reconcile"` \| `"reverse"` \| `"fee"`	yes	—
`mandate_id`	`string,null`	yes	—
`metadata`	object	yes	—
`org_id`	`string`	yes	—
`posted_at`	`string (date-time)`	yes	—
`reconciled_at`	`string,null (date-time)`	yes	—
`wallet_id`	`string`	yes	—

WalletLedgerPost

Field	Type	Required	Description
`amount_minor`	`string`	yes	—
`attempt_id`	`string,null`	yes	—
`currency`	`"BRL"` \| `"USD"` \| `"MXN"` \| `"COP"` \| `"ARS"` \| `"USDC"` \| `"BRLA"`	yes	—
`external_ref`	`string,null`	yes	—
`kind`	`"fund"` \| `"hold"` \| `"release"` \| `"debit"` \| `"reconcile"` \| `"reverse"` \| `"fee"`	yes	—
`mandate_id`	`string,null`	yes	—
`metadata`	object	no	—
`org_id`	`string`	yes	—
`wallet_id`	`string`	yes	—

WalletReconAnomaly

Field	Type	Required	Description
`amount_minor`	`string,null`	yes	—
`currency`	`"BRL"` \| `"USD"` \| `"MXN"` \| `"COP"` \| `"ARS"` \| `"USDC"` \| `"BRLA"`	yes	—
`detected_at`	`string (date-time)`	yes	—
`external_ref`	`string,null`	yes	—
`id`	`string`	yes	—
`kind`	`"debit_without_receipt"` \| `"receipt_without_debit"`	yes	—
`ledger_entry_id`	`string,null`	yes	—
`metadata`	object	yes	—
`org_id`	`string`	yes	—
`resolution_note`	`string,null`	yes	—
`resolved_at`	`string,null (date-time)`	yes	—
`status`	`"open"` \| `"resolved"` \| `"dismissed"`	yes	—
`wallet_id`	`string`	yes	—

Whoami

Field	Type	Required	Description
`key`	object	yes	—
`organization`	object	yes	—
`project`	object	yes	—
`user`	object	no	Display only. An API key is scoped to an org and a project, not to a user; this is a representative org member (owner first) for a 'logged in as' line, and it is absent when no member has an email.

Whoami

Generated HTTP reference for the 1 operation the published OpenAPI document describes under whoami.

codespar_shop

Buy-side shopping — act as the shopper to search a store's catalog and buy a product, minting the store's real Pix. VTEX guest checkout and Mercado Livre. Call via session.execute().

Schemas | CodeSpar