Skip to main content
PATCH
/
v1
/
calls
/
{call_id}
Update call outcome
curl --request PATCH \
  --url https://api.oneinbox.ai/v1/calls/{call_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "outcome": "interested"
}
'
{
  "id": "<string>",
  "agent_id": "<string>",
  "to_number": "<string>",
  "from_number": "<string>",
  "room_name": "<string>",
  "twilio_call_sid": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "variables": {},
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "duration_seconds": 123,
  "end_reason": "<string>",
  "outcome": "<string>",
  "recording_url": "<string>",
  "transcript": [
    {}
  ],
  "messages": [
    {
      "content": "<string>"
    }
  ],
  "ai_summary": "<string>",
  "analysis": {
    "outcome": "interested",
    "summary": "<string>"
  },
  "metadata": {},
  "latency": {
    "llm_ttft": {
      "avg_ms": 123,
      "p50_ms": 123,
      "min_ms": 123,
      "max_ms": 123,
      "samples": 123
    },
    "tts_ttfb": {
      "avg_ms": 123,
      "p50_ms": 123,
      "min_ms": 123,
      "max_ms": 123,
      "samples": 123
    },
    "eou_delay": {
      "avg_ms": 123,
      "p50_ms": 123,
      "min_ms": 123,
      "max_ms": 123,
      "samples": 123
    }
  },
  "credits_used": 123,
  "cost_cents": 123,
  "created_at": "2023-11-07T05:31:56Z"
}

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.

Authorizations

Authorization
string
header
required

Use api_key from POST /v1/api-keys

Path Parameters

call_id
string
required

Body

application/json
outcome
string

Call outcome label in lowercase or lowercase_underscore format

Example:

"interested"

Response

200 - application/json

OK

id
string
agent_id
string
type
enum<string>

Call type

Available options:
web,
outbound,
inbound
status
enum<string>
Available options:
queued,
initiated,
in_progress,
completed,
failed
direction
enum<string> | null
Available options:
inbound,
outbound
to_number
string | null
from_number
string | null
room_name
string | null

LiveKit room name (web calls only)

twilio_call_sid
string | null
scheduled_at
string<date-time> | null
variables
object

Variables passed at call creation time

started_at
string<date-time> | null
ended_at
string<date-time> | null
duration_seconds
integer | null
end_reason
string | null

How the call ended (e.g. api_stop, silence_timeout, max_duration)

outcome
string | null

Call outcome. Set automatically post-call or manually via PATCH.

recording_url
string | null

Signed S3 URL to call recording. Valid for 4 hours — re-fetch to get a fresh URL. Only present if enable_recording was true on the agent.

transcript
object[] | null

Deprecated — use messages instead.

messages
object[] | null

Full conversation transcript. Only populated after the call ends. Always call POST /v1/calls/{id}/stop and wait 2-3 seconds before fetching.

ai_summary
string | null

AI-generated summary of the call. Only populated after the call ends.

analysis
object

Post-call analysis. Only populated after the call ends. outcome is stored as-set — when patching use lowercase (e.g. "interested").

metadata
object
latency
object

Per-component latency breakdown. Only populated after the call ends.

credits_used
number | null

Credits consumed by this call (duration_seconds / 60)

cost_cents
integer | null

Carrier cost in cents. Null if not available.

created_at
string<date-time>