Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.oneinbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Before you start

You need: an api_key and an LLM model. Attach tools via tool_ids when you create or update a model. Tool types in the API:
TypeWhat it does
api_callAgent calls your HTTP endpoint
transfer_callTransfer to a human phone number
end_callAgent hangs up
1

1. Create a tool

Example — call your API:
curl -X POST https://api.oneinbox.ai/v1/tools \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "get_weather",
    "type": "api_call",
    "description": "Look up current weather for a city.",
    "url": "https://api.weather.com/v1/current",
    "method": "GET",
    "headers": {"Authorization": "Bearer <secret>"},
    "parameters": [
      {"name": "city", "type": "string", "required": true, "description": "City name"}
    ]
  }'
Transfer to a human:
curl -X POST https://api.oneinbox.ai/v1/tools \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "transfer_to_human",
    "type": "transfer_call",
    "description": "Escalate to a human agent.",
    "transfer_to": "+15105550100"
  }'
End the call:
curl -X POST https://api.oneinbox.ai/v1/tools \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "hangup",
    "type": "end_call",
    "description": "End the call."
  }'
2

2. Attach tools to your LLM model

Goal: The agent can use the tools during calls.Update your model (or set tool_ids when creating it):
curl -X PATCH https://api.oneinbox.ai/v1/models/<llm_id> \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_ids": ["<tool_id>"]
  }'
Your agent already linked to this llm_id picks up the change automatically.
3

3. List or manage tools

# List all
curl https://api.oneinbox.ai/v1/tools \
  -H "Authorization: Bearer <api_key>"

# Get one
curl https://api.oneinbox.ai/v1/tools/<tool_id> \
  -H "Authorization: Bearer <api_key>"

# Delete
curl -X DELETE https://api.oneinbox.ai/v1/tools/<tool_id> \
  -H "Authorization: Bearer <api_key>"

​
API reference

Create tool · List tools · Update tool