Agents

Bind tools to an agent

Replace the agent's tool bindings. Each entry references a tool id from GET /v1/tools. Requires the omni:session scope.

put/v1/agents/{id}/tools

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/agents/{id}/tools
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Request body

tool_idstring required
enabledboolean
configobject

Customer SETTINGS for this tool on this agent, keyed by the tool's config_schema field keys (e.g. { from_number, provider_api_key }). Fields marked secret are encrypted at rest and returned masked ('********'); re-send the mask (or omit) to keep the stored value.

namestring

Present on agent reads when the tool resolves.

descriptionstring
input_schemaobject

Per-call model argument schema. Present on agent reads when the tool resolves.

execution'hosted' | 'server' | 'engine' | 'client'

Resolved execution mode. Present on agent reads when the tool resolves.

Response

Updated bindings

objectstring

Example response

{
  "object": "list"
}

Changes

No recorded changes to this operation across all 1 revision of this API.