Skip to main content
POST
Create client tool

Autorizaciones

X-API-Key
string
header
requerido

API key for authentication. Keys are prefixed with nxr_live_.

Cuerpo

application/json
name
string
requerido

snake_case, matching ^[a-z][a-z0-9_]*$. Immutable after creation.

description
string
requerido

Non-empty, max 1024 characters.

url
string
requerido

Non-empty.

method
enum<string>
predeterminado:POST
Opciones disponibles:
GET,
POST,
PUT,
PATCH,
DELETE
parameters
object
headers
object
query_parameters
object
timeout_ms
integer

Clamped to 1,000-120,000. Default 10000.

speak_during_execution
boolean
predeterminado:true
speak_after_execution
boolean
predeterminado:true
response_variables
object
execution_message_type
string
execution_message_description
string
llm_response_fields
string[]
is_active
boolean
predeterminado:true
sort_order
integer
predeterminado:0

Respuesta

Tool created

success
boolean
tool
object

A reusable tool in the client's catalog. Assigning it to an agent (POST /client-tools/{id}/assign) creates an inherited workflow_tools mirror that stays in sync on future edits.

Última modificación el 7 de agosto de 2026