Fetch Organization Usage

GET 
/v1/organization/:organization_id_or_slug/usage

Computes the organization usage in the past 1 month.

since_last_billing_date: If True and organization is on a paid tier, only returns usage after the last billing date.

Request

Path Parameters

organization_id_or_slug Organization Id Or Slugrequired

Query Parameters

since_last_billing_date Since Last Billing Date

Default value: true

offset_number Offset Number

Default value: 0

limit any

Responses

200

Successful Response

application/json

Schema

Schema

usage_since_date date-timerequired

The start date this usage record represents

public_datapoints Public Datapoints (integer)required

The number of public datapoints used.

private_datapoints Private Datapoints (integer)required

The number of private datapoints used.

organization_seats Organization Seats (integer)required

The number of organization seats currently used.

embedding_models

object[]

required

Array [

model

object

required

The embedding model used.

anyOf

NomicTextEmbeddingModel

string

Possible values: [nomic-embed-text-v1, nomic-embed-text-v1.5]

NomicVisionEmbeddingModel

string

Possible values: [nomic-embed-vision-v1, nomic-embed-vision-v1.5]

tokens Tokens (integer)required

The total tokens used.

num_embeddings

object

required

The total embeddings generated.

anyOf

MOD1

integer

]

advanced_analysis_usage

object

The number of advanced analysis calls used.

anyOf

MOD1

integer

Example (from schema)

{
  "usage_since_date": "2024-07-29T15:51:28.071Z",
  "public_datapoints": 0,
  "private_datapoints": 0,
  "organization_seats": 0,
  "embedding_models": [
    {
      "model": "nomic-embed-text-v1",
      "tokens": 0,
      "num_embeddings": 0
    }
  ],
  "advanced_analysis_usage": 0
}

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...