Get tenant settings

Overview

Read or change your tenant's display name and monthly quota.

Returns your tenant's display name, monthly quota, and monetization setting. A null quota means usage is unlimited. deletion is null unless your tenant is scheduled for deletion, when it holds the request and deletion times.

Request

Requires bearer authentication.

There are no parameters and no request body.

Response

Your tenant's settings.

TenantSettingsobjectrequired

Your tenant's settings.

Returns 200 OK as application/json. Your tenant's settings.

Response schema: TenantSettings.

{
  "name": "Acme",
  "quota": {
    "monthlyTokenLimit": 5000000,
    "monthlyRequestLimit": 10000,
    "resetDay": 1
  },
  "monetizationEnabled": false,
  "deletion": null
}

Errors

Status	Codes	Description
`401`	`unauthorized`	The credential is missing or invalid
`402`	`subscription_required`	An active subscription or usage credit is required

See REST errors for the error envelope and shared codes.

cURL

curl "$BLAZING_AGENTS_BASE_URL/v1/tenant" \
  --header "Authorization: Bearer $BLAZING_AGENTS_API_KEY"

Update tenant settingsPATCH`/v1/tenant`

Update tenant settings.

Updates your tenant's display name, monthly quota, or monetization setting. Send at least one field; the ones you leave out keep their values. A quota replaces the whole quota, so send all three of its fields with at least one limit set, or send null to remove it. Turning monetizationEnabled off drops usage events your merchant has not yet accepted.

Request

Requires bearer authentication and a JSON body.

Field	Type	Location	Description
`monetizationEnabled`	boolean	body	Bill usage to your end users through your merchant account. Turning it off drops usage events your merchant has not yet accepted.
`name`	string	body	Display name of your tenant. 1–80 characters.
`quota`	object \| null	body	The whole monthly quota, replacing the current one, or `null` to remove it. Send `monthlyTokenLimit`, `monthlyRequestLimit`, and `resetDay`, with at least one limit set.

Response

Your tenant's settings.

TenantSettingsobjectrequired

Your tenant's settings.

Returns 200 OK as application/json. Your tenant's updated settings.

Response schema: TenantSettings.

{
  "name": "Acme",
  "quota": {
    "monthlyTokenLimit": 5000000,
    "monthlyRequestLimit": null,
    "resetDay": 1
  },
  "monetizationEnabled": false,
  "deletion": null
}

Errors

Status	Codes	Description
`400`	`validation_failed`, `invalid_request`	The request is invalid
`401`	`unauthorized`	The credential is missing or invalid
`402`	`subscription_required`	An active subscription or usage credit is required

See REST errors for the error envelope and shared codes.

cURL

curl --request PATCH "$BLAZING_AGENTS_BASE_URL/v1/tenant" \
  --header "Authorization: Bearer $BLAZING_AGENTS_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"quota":{"monthlyTokenLimit":5000000,"monthlyRequestLimit":null,"resetDay":1}}'

Usage and quotas to choose quota values.
Usage API to compare usage with your quota.

Overview

Endpoints