Skip to content
Docs
Select language:English

/api/v1/ai/caps (GET)

GET
/api/v1/ai/caps
curl --request GET \
  --url 'https://example.com/api/v1/ai/caps?scope=me'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
scope
string
default: me
Allowed values: me location account instance
locationId
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
caps
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)$/
scope
required
string
Allowed values: instance instance_account account location member user
target
required
object
id
required
string | null
label
required
string
task
required
Any of:
string
Allowed values: extraction assistant embeddings
tokensPerMinute
number
tokensPerDay
number
tokensPerMonth
number
monthlyCap
object
amount
required
string
currency
required
string
used
required
object
tokens
required
number
cost
required
Array<object>
object
currency
required
string
amount
required
string
unknownCostCalls
required
number
notCounted
required
Array<string>
percent
required
number | null
state
required
string
Allowed values: active warned paused
pausedUntil
string
reason
string
Allowed values: manual cap_money cap_tokens tokens_day
cappedByAccount
required
boolean
rowVersion
required
number
canEdit
required
boolean
suggested
object
monthlyCap
object
amount
required
string
currency
required
string
tokensPerMonth
number
Example
{
  "caps": [
    {
      "scope": "instance",
      "task": "extraction",
      "state": "active",
      "reason": "manual"
    }
  ]
}