Check Organization Usage Totals Within Limit

GET 
/v1/organization/:organization_id_or_slug/usage/:usage_type/within_limit

Check Organization Usage Totals Within Limit

Request

Path Parameters

usage_type UsageTyperequired

Possible values: [advanced_analysis, text_tokens, image_embeddings]

organization_id_or_slug Organization Id Or Slugrequired

Query Parameters

offset_number Offset Number

Default value: 0

limit any

Responses

200

Successful Response

application/json

Schema

Schema

organization_to_charge_slug

object

required

anyOf

MOD1

string

usage_type UsageType (string)required

Possible values: [advanced_analysis, text_tokens, image_embeddings]

within_limit Within Limit (boolean)required
total_with_update Total With Update (integer)required
limit Limit (integer)required

organization_to_charge_id

object

required

anyOf

MOD1

string

plan_type

object

required

anyOf

OrganizationPlan

The master list of available plans for organizations.

string

Possible values: [atlas_demo, atlas_enterprise, atlas_team, atlas_plus, atlas_research, atlas_starter, atlas_startup, atlas_pro, mock, free_test_user, pro, enterprise, free, research]

Example (from schema)

{
  "organization_to_charge_slug": "string",
  "usage_type": "advanced_analysis",
  "within_limit": true,
  "total_with_update": 0,
  "limit": 0,
  "organization_to_charge_id": "string",
  "plan_type": "atlas_demo"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...