Skip to content

ListAiCalls

GET
/api/v1/t/{tenant}/intelligence/usage/calls
curl --request GET \
--url 'https://example.com/api/v1/t/example/intelligence/usage/calls?task=Classification'
tenant
required
string

Tenant slug

month
string
task
Allowed values: Classification Extraction VisionFallback SplitDetection Embedding Chat Summary Assistant ScriptAssist WorkflowAction WorkflowDesign SignatureFields
charged
boolean
cursor
string
limit
integer format: int32

OK

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
createdAt
required
string format: date-time
task
required
Allowed values: Classification Extraction VisionFallback SplitDetection Embedding Chat Summary Assistant ScriptAssist WorkflowAction WorkflowDesign SignatureFields
model
required
string
promptVersion
required
null | string
outcome
required
Allowed values: Succeeded RateLimited TimedOut Unavailable Rejected InvalidResponse Cancelled Aborted
credits
required
integer format: int32
inputTokens
required
integer format: int32
outputTokens
required
integer format: int32
latencyMs
required
integer format: int32
documentId
required
null | string format: uuid
versionNumber
required
null | integer format: int32
nextCursor
required
null | string
total
null | integer format: int32
isTotalCapped
null | boolean
Example
{
"items": [
{
"task": "Classification",
"outcome": "Succeeded"
}
]
}

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}