Set individual user groups' AI credit limits

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

{
  "userGroups": [
    {
      "creditLimit": 50,
      "name": "Blob Sales",
      "userGroupId": "mEhXj6ZI",
      "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

user-groups

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

{
  "userGroups": [
    {
      "creditLimit": 50,
      "name": "Blob Sales",
      "userGroupId": "mEhXj6ZI",
      "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 a user group, use creditLimit: null. This is distinct from having the user group follow the organization’s user group 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

userGroups

object[]

required

User groups to update. Each entry has a userGroupId 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 user group's effective limit, in request order.

userGroups

object[]

required

Show child attributes

Getting started

Who am I?

Administration APIs

AI APIs

App APIs

Branch APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Embed APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Set individual user groups' AI credit limits

Authorizations

Body

Response