Get Usage

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

{
  "object": "usage",
  "billing_period": {
    "start": "2026-04-01T00:00:00Z",
    "end": "2026-04-30T23:59:59Z"
  },
  "by_endpoint_type": {
    "search": { "used": 1204, "limit": 100000 },
    "read": { "used": 8932, "limit": 500000 },
    "screening": { "used": 42, "limit": 1000 },
    "clearance": { "used": 5, "limit": 500 },
    "image_search": { "used": 18, "limit": 1000 },
    "check": { "used": 3, "limit": 100 },
    "export": { "used": 0, "limit": 10 }
  },
  "rate_limit": {
    "limit": 10000,
    "resets_at": "2026-04-18T12:30:00Z"
  },
  "request_id": "req_abc123"
}

GET

organization

usage

Get Usage

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

{
  "object": "usage",
  "billing_period": {
    "start": "2026-04-01T00:00:00Z",
    "end": "2026-04-30T23:59:59Z"
  },
  "by_endpoint_type": {
    "search": { "used": 1204, "limit": 100000 },
    "read": { "used": 8932, "limit": 500000 },
    "screening": { "used": 42, "limit": 1000 },
    "clearance": { "used": 5, "limit": 500 },
    "image_search": { "used": 18, "limit": 1000 },
    "check": { "used": 3, "limit": 100 },
    "export": { "used": 0, "limit": 10 }
  },
  "rate_limit": {
    "limit": 10000,
    "resets_at": "2026-04-18T12:30:00Z"
  },
  "request_id": "req_abc123"
}

Overview

Returns API usage statistics for the current billing period, broken down by endpoint type, plus rate limit status. The by_endpoint_type object reports used and limit for every metered endpoint type (search, read, screening, clearance, image_search, check, export). A limit of null indicates an unlimited plan; 0 means the endpoint type is not allowed on the current plan.

Response

object

string

Always "usage"

billing_period

object

Show Billing period

start

string

ISO timestamp for the billing period start

end

string

ISO timestamp for the billing period end

by_endpoint_type

object

Show Per-endpoint-type usage

Keyed by endpoint type (search, read, screening, clearance, image_search, check, export). Each value is an object:

used

integer

Requests used in the current billing period for this endpoint type

limit

integer | null

Plan limit for this endpoint type. null if unlimited; 0 if not allowed on the current plan.

rate_limit

object

Show Rate limit status

limit

integer

Requests allowed in the current rate limit window

resets_at

string

ISO timestamp when the rate limit window resets

request_id

string

Request ID for debugging

{
  "object": "usage",
  "billing_period": {
    "start": "2026-04-01T00:00:00Z",
    "end": "2026-04-30T23:59:59Z"
  },
  "by_endpoint_type": {
    "search": { "used": 1204, "limit": 100000 },
    "read": { "used": 8932, "limit": 500000 },
    "screening": { "used": 42, "limit": 1000 },
    "clearance": { "used": 5, "limit": 500 },
    "image_search": { "used": 18, "limit": 1000 },
    "check": { "used": 3, "limit": 100 },
    "export": { "used": 0, "limit": 10 }
  },
  "rate_limit": {
    "limit": 10000,
    "resets_at": "2026-04-18T12:30:00Z"
  },
  "request_id": "req_abc123"
}

Code Examples

curl "https://api.signa.so/v1/organization/usage" \
  -H "Authorization: Bearer sig_xxxxxxxxxxxx"

Errors

Status	Type	Description
401	`unauthorized`	Missing or invalid API key
429	`rate_limited`	Too many requests

Get Current Organization — organization profile and plan
Get Usage Summary — daily breakdown by endpoint type or API key
List API Keys — manage API keys

Rotate API Key Get Usage Summary

​Overview

​Response

​Code Examples

​Errors

​Related Endpoints

Overview

Response

Code Examples

Errors

Related Endpoints