Skip to content
Docs
Select language:English

/api/v1/ai/pause

POST
/api/v1/ai/pause
curl --request POST \
  --url https://example.com/api/v1/ai/pause \
  --header 'Content-Type: application/json' \
  --data '{ "scope": "instance", "accountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
scope
required
string
Allowed values: instance instance_account account location member user
accountId
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)$/
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)$/
userId
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)$/
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
Example
{
  "scope": "instance",
  "task": "extraction",
  "state": "active",
  "reason": "manual"
}