Skip to content
AcrivaDocs

GetCreditUsage

GET
/api/v1/t/{tenant}/intelligence/usage
curl --request GET \
  --url https://example.com/api/v1/t/example/intelligence/usage

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Query Parameters

Section titled “Query Parameters”
month
string

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
month
required
string
used
required
integer format: int32
allowance
required
null | integer format: int32
remaining
required
null | integer format: int32
byTask
required
Array<object>
object
task
required
Allowed values: Classification Extraction VisionFallback SplitDetection Embedding Chat Summary Assistant ScriptAssist WorkflowAction WorkflowDesign SignatureFields
credits
required
integer format: int32
calls
required
integer format: int32
byDay
required
Array<object>
object
day
required
string format: date
credits
required
integer format: int32
calls
required
integer format: int32
Example
{
  "byTask": [
    {
      "task": "Classification"
    }
  ]
}

400

Section titled “400”

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"
    ]
  }
}

403

Section titled “403”

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"
}

429

Section titled “429”

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"
}