Accounts

Get usage

Daily usage, errors, server time, and exact USD costs, with model and API-key breakdowns.

Calendar days in the selected timezone (UTC by default), today included, with the preceding period for comparison. requests counts successes; total_requests includes recorded 4xx/5xx failures. cost_usd is an exact decimal string. Key metadata never contains credentials. These fields count inference; laboratory has fine-tunes, prompt jobs, evaluation predictions, keep warm and dataset storage, and ignores the model, key and source filters.

GET

organization

usage

Get usage

curl --request GET \
  --url https://api.sqwish.ai/v1/organization/usage \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sqwish.ai/v1/organization/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "days": 123,
  "start": "<string>",
  "end": "<string>",
  "timezone": "<string>",
  "totals": {
    "requests": 123,
    "decisions": 123,
    "input_tokens": 123,
    "errors_4xx": 123,
    "errors_5xx": 123,
    "fallbacks": 123,
    "total_requests": 123,
    "cost_usd": "<string>",
    "request_ms_sum": 123,
    "request_ms_count": 123,
    "p50_ms": 123,
    "p95_ms": 123
  },
  "previous": {
    "requests": 123,
    "decisions": 123,
    "input_tokens": 123,
    "errors_4xx": 123,
    "errors_5xx": 123,
    "fallbacks": 123,
    "total_requests": 123,
    "cost_usd": "<string>",
    "request_ms_sum": 123,
    "request_ms_count": 123,
    "p50_ms": 123,
    "p95_ms": 123
  },
  "daily": [
    {
      "requests": 123,
      "decisions": 123,
      "input_tokens": 123,
      "errors_4xx": 123,
      "errors_5xx": 123,
      "fallbacks": 123,
      "total_requests": 123,
      "cost_usd": "<string>",
      "request_ms_sum": 123,
      "request_ms_count": 123,
      "p50_ms": 123,
      "p95_ms": 123,
      "day": "<string>"
    }
  ],
  "by_model": [
    {
      "requests": 123,
      "decisions": 123,
      "input_tokens": 123,
      "errors_4xx": 123,
      "errors_5xx": 123,
      "fallbacks": 123,
      "total_requests": 123,
      "cost_usd": "<string>",
      "request_ms_sum": 123,
      "request_ms_count": 123,
      "p50_ms": 123,
      "p95_ms": 123,
      "model": "<string>",
      "daily": [
        {
          "requests": 123,
          "decisions": 123,
          "input_tokens": 123,
          "errors_4xx": 123,
          "errors_5xx": 123,
          "fallbacks": 123,
          "total_requests": 123,
          "cost_usd": "<string>",
          "request_ms_sum": 123,
          "request_ms_count": 123,
          "p50_ms": 123,
          "p95_ms": 123,
          "day": "<string>"
        }
      ],
      "daily_decisions": [
        123
      ]
    }
  ],
  "by_api_key": [
    {
      "requests": 123,
      "decisions": 123,
      "input_tokens": 123,
      "errors_4xx": 123,
      "errors_5xx": 123,
      "fallbacks": 123,
      "total_requests": 123,
      "cost_usd": "<string>",
      "request_ms_sum": 123,
      "request_ms_count": 123,
      "p50_ms": 123,
      "p95_ms": 123,
      "api_key": {
        "id": "<string>",
        "name": "<string>",
        "is_console": true,
        "revoked_at": 123
      },
      "daily": [
        {
          "requests": 123,
          "decisions": 123,
          "input_tokens": 123,
          "errors_4xx": 123,
          "errors_5xx": 123,
          "fallbacks": 123,
          "total_requests": 123,
          "cost_usd": "<string>",
          "request_ms_sum": 123,
          "request_ms_count": 123,
          "p50_ms": 123,
          "p95_ms": 123,
          "day": "<string>"
        }
      ]
    }
  ],
  "laboratory": {
    "totals": {
      "cost_usd": "<string>"
    },
    "daily": [
      {
        "day": "<string>",
        "cost_usd": "<string>"
      }
    ],
    "activities": [
      {
        "activity": "labeling",
        "cost_usd": "<string>",
        "daily": [
          {
            "day": "<string>",
            "cost_usd": "<string>"
          }
        ],
        "jobs": 123,
        "charged": 123,
        "decisions": 123,
        "requests": 123,
        "minutes": 123,
        "subjects": 123
      }
    ],
    "items": [
      {
        "activity": "labeling",
        "id": "<string>",
        "name": "<string>",
        "started_at": 123,
        "ended_at": 123,
        "status": "<string>",
        "charge": "free",
        "reason": "failed",
        "cost_usd": "<string>",
        "reserved_usd": "<string>",
        "by_day": [
          {
            "day": "<string>",
            "cost_usd": "<string>"
          }
        ],
        "examples": 123,
        "base": "<string>",
        "gate": true,
        "effort": "<string>",
        "decisions": 123,
        "requests": 123,
        "minutes": 123,
        "rows": 123,
        "deleted": true
      }
    ],
    "items_complete": true,
    "recurring": [
      {
        "activity": "keep_warm",
        "id": "<string>",
        "name": "<string>",
        "rate_usd": "<string>",
        "unit": "hour",
        "started_at": 123,
        "ends_at": 123,
        "reserved_usd": "<string>",
        "base": "<string>",
        "rows": 123
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "details": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "type": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "details": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "type": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Create an API key in the console.

Query Parameters

days

integer

default:30

Required range: 1 <= x <= 90

timezone

string

default:UTC

Maximum string length: 64

model

string | null

Maximum string length: 128

api_key_id

string | null

Maximum string length: 64

source

string | null

Pattern: ^(api|console)$

project

string | null

Count only this project's usage, by its id. Without it, you get all the usage you can see: the whole organisation's, or your projects' if an owner limited you to some. A project's API key sees its own project alone.

Maximum string length: 64

Response

Successful Response

days

integer

required

start

string

required

end

string

required

timezone

string

required

totals

UsageTotals · object

required

Show child attributes

UsageTotals · object

required

Show child attributes

daily

DailyUsage · object[]

required

Show child attributes

by_model

ModelUsage · object[]

required

Show child attributes

by_api_key

KeyUsage · object[]

required

Show child attributes

laboratory

LaboratoryUsage · object

required

Laboratory spend in the period. The model, key and source filters don't apply to it. The other fields count inference only, so evaluation predictions are here instead.

Show child attributes

Get usage

curl --request GET \
  --url https://api.sqwish.ai/v1/organization/usage \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sqwish.ai/v1/organization/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "days": 123,
  "start": "<string>",
  "end": "<string>",
  "timezone": "<string>",
  "totals": {
    "requests": 123,
    "decisions": 123,
    "input_tokens": 123,
    "errors_4xx": 123,
    "errors_5xx": 123,
    "fallbacks": 123,
    "total_requests": 123,
    "cost_usd": "<string>",
    "request_ms_sum": 123,
    "request_ms_count": 123,
    "p50_ms": 123,
    "p95_ms": 123
  },
  "previous": {
    "requests": 123,
    "decisions": 123,
    "input_tokens": 123,
    "errors_4xx": 123,
    "errors_5xx": 123,
    "fallbacks": 123,
    "total_requests": 123,
    "cost_usd": "<string>",
    "request_ms_sum": 123,
    "request_ms_count": 123,
    "p50_ms": 123,
    "p95_ms": 123
  },
  "daily": [
    {
      "requests": 123,
      "decisions": 123,
      "input_tokens": 123,
      "errors_4xx": 123,
      "errors_5xx": 123,
      "fallbacks": 123,
      "total_requests": 123,
      "cost_usd": "<string>",
      "request_ms_sum": 123,
      "request_ms_count": 123,
      "p50_ms": 123,
      "p95_ms": 123,
      "day": "<string>"
    }
  ],
  "by_model": [
    {
      "requests": 123,
      "decisions": 123,
      "input_tokens": 123,
      "errors_4xx": 123,
      "errors_5xx": 123,
      "fallbacks": 123,
      "total_requests": 123,
      "cost_usd": "<string>",
      "request_ms_sum": 123,
      "request_ms_count": 123,
      "p50_ms": 123,
      "p95_ms": 123,
      "model": "<string>",
      "daily": [
        {
          "requests": 123,
          "decisions": 123,
          "input_tokens": 123,
          "errors_4xx": 123,
          "errors_5xx": 123,
          "fallbacks": 123,
          "total_requests": 123,
          "cost_usd": "<string>",
          "request_ms_sum": 123,
          "request_ms_count": 123,
          "p50_ms": 123,
          "p95_ms": 123,
          "day": "<string>"
        }
      ],
      "daily_decisions": [
        123
      ]
    }
  ],
  "by_api_key": [
    {
      "requests": 123,
      "decisions": 123,
      "input_tokens": 123,
      "errors_4xx": 123,
      "errors_5xx": 123,
      "fallbacks": 123,
      "total_requests": 123,
      "cost_usd": "<string>",
      "request_ms_sum": 123,
      "request_ms_count": 123,
      "p50_ms": 123,
      "p95_ms": 123,
      "api_key": {
        "id": "<string>",
        "name": "<string>",
        "is_console": true,
        "revoked_at": 123
      },
      "daily": [
        {
          "requests": 123,
          "decisions": 123,
          "input_tokens": 123,
          "errors_4xx": 123,
          "errors_5xx": 123,
          "fallbacks": 123,
          "total_requests": 123,
          "cost_usd": "<string>",
          "request_ms_sum": 123,
          "request_ms_count": 123,
          "p50_ms": 123,
          "p95_ms": 123,
          "day": "<string>"
        }
      ]
    }
  ],
  "laboratory": {
    "totals": {
      "cost_usd": "<string>"
    },
    "daily": [
      {
        "day": "<string>",
        "cost_usd": "<string>"
      }
    ],
    "activities": [
      {
        "activity": "labeling",
        "cost_usd": "<string>",
        "daily": [
          {
            "day": "<string>",
            "cost_usd": "<string>"
          }
        ],
        "jobs": 123,
        "charged": 123,
        "decisions": 123,
        "requests": 123,
        "minutes": 123,
        "subjects": 123
      }
    ],
    "items": [
      {
        "activity": "labeling",
        "id": "<string>",
        "name": "<string>",
        "started_at": 123,
        "ended_at": 123,
        "status": "<string>",
        "charge": "free",
        "reason": "failed",
        "cost_usd": "<string>",
        "reserved_usd": "<string>",
        "by_day": [
          {
            "day": "<string>",
            "cost_usd": "<string>"
          }
        ],
        "examples": 123,
        "base": "<string>",
        "gate": true,
        "effort": "<string>",
        "decisions": 123,
        "requests": 123,
        "minutes": 123,
        "rows": 123,
        "deleted": true
      }
    ],
    "items_complete": true,
    "recurring": [
      {
        "activity": "keep_warm",
        "id": "<string>",
        "name": "<string>",
        "rate_usd": "<string>",
        "unit": "hour",
        "started_at": 123,
        "ends_at": 123,
        "reserved_usd": "<string>",
        "base": "<string>",
        "rows": 123
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "details": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "type": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "details": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "type": "<string>"
      }
    ]
  }
}

Overview

Decisions

Models

Families

Datasets

Evaluations

Fine-tuning

Prompt tuning

Labelling

Accounts

Billing

Organizations

Projects

Integrations

System

Get usage

Authorizations

Query Parameters

Response