Set individual entity groups' AI credit limits

curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v1/ai/credit-controls/entity-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityGroups": [
    {
      "entity": "blobsrus",
      "creditLimit": 50
    },
    {
      "entity": "blobsrus-eu",
      "creditLimit": null
    }
  ]
}
'

{
  "entityGroups": [
    {
      "creditLimit": 50,
      "entity": "blobsrus",
      "usesDefaultLimit": true
    }
  ]
}

{
  "detail": "<string>",
  "status": 400
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

{
  "detail": "<string>",
  "status": 404
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

PATCH

credit-controls

entity-groups

curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v1/ai/credit-controls/entity-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityGroups": [
    {
      "entity": "blobsrus",
      "creditLimit": 50
    },
    {
      "entity": "blobsrus-eu",
      "creditLimit": null
    }
  ]
}
'

{
  "entityGroups": [
    {
      "creditLimit": 50,
      "entity": "blobsrus",
      "usesDefaultLimit": true
    }
  ]
}

{
  "detail": "<string>",
  "status": 400
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

{
  "detail": "<string>",
  "status": 404
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

To set an unlimited override for an entity group, use creditLimit: null. This is distinct from having the entity group follow the organization default.

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json

entityGroups

object[]

required

Entity groups to update. Each entry has an entity plus exactly one of creditLimit (number or null) or useDefaultLimit: true.

Required array length: 1 - 1000 elements

Show child attributes

Response

All entries applied. Returns each entity group's effective limit, in request order.

entityGroups

object[]

required

Show child attributes

List individual users' AI credit limits

List individual entity groups' AI credit limits

⌘I

Getting started

AI APIs

API token APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Set individual entity groups' AI credit limits

Authorizations

Body

Response