Skip to content
Docs
Select language:English

/api/v1/ai/calls/{id}

GET
/api/v1/ai/calls/{id}
curl --request GET \
  --url https://example.com/api/v1/ai/calls/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
at
required
string
requestId
required
string
attempt
required
number
task
required
string
Allowed values: extract_thing extract_receipt extract_label extract_reading assistant_turn assistant_followup embed_thing embed_query connection_test enrich_aliases
providerKind
required
string
Allowed values: openai anthropic google openai_compatible openrouter groq
model
required
string
location
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
person
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
paidBy
required
object
scope
required
string
Allowed values: instance account user
label
required
string
fellBack
required
boolean
sent
required
boolean
tokens
required
object
estimate
required
number | null
input
required
number | null
output
required
number | null
reasoning
required
number | null
cached
required
number | null
images
required
object
count
required
number
tokensEach
required
number | null
bytes
required
number | null
latencyMs
required
number | null
finishReason
required
string | null
outcome
required
string
Allowed values: ok refused rate_limited over_budget provider_error timeout schema_invalid truncated
errorCode
required
string | null
cost
object
amount
required
string
currency
required
string
source
required
string
Allowed values: provider price_table price_table_later unknown not_sent
priceVersion
required
number | null
moneyHidden
boolean
links
required
object
extractionId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
thingId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
threadId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
attempts
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
at
required
string
requestId
required
string
attempt
required
number
task
required
string
Allowed values: extract_thing extract_receipt extract_label extract_reading assistant_turn assistant_followup embed_thing embed_query connection_test enrich_aliases
providerKind
required
string
Allowed values: openai anthropic google openai_compatible openrouter groq
model
required
string
location
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
person
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
paidBy
required
object
scope
required
string
Allowed values: instance account user
label
required
string
fellBack
required
boolean
sent
required
boolean
tokens
required
object
estimate
required
number | null
input
required
number | null
output
required
number | null
reasoning
required
number | null
cached
required
number | null
images
required
object
count
required
number
tokensEach
required
number | null
bytes
required
number | null
latencyMs
required
number | null
finishReason
required
string | null
outcome
required
string
Allowed values: ok refused rate_limited over_budget provider_error timeout schema_invalid truncated
errorCode
required
string | null
cost
object
amount
required
string
currency
required
string
source
required
string
Allowed values: provider price_table price_table_later unknown not_sent
priceVersion
required
number | null
moneyHidden
boolean
links
required
object
extractionId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
thingId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
threadId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Example
{
  "task": "extract_thing",
  "providerKind": "openai",
  "person": "background",
  "paidBy": {
    "scope": "instance"
  },
  "outcome": "ok",
  "cost": {
    "source": "provider"
  },
  "moneyHidden": true,
  "attempts": [
    {
      "task": "extract_thing",
      "providerKind": "openai",
      "person": "background",
      "paidBy": {
        "scope": "instance"
      },
      "outcome": "ok",
      "cost": {
        "source": "provider"
      },
      "moneyHidden": true
    }
  ]
}