Record a usage event

Appends a row to usage_events. Document send/complete already records automatically; this endpoint is for explicit agent metering. Requires usage:write (or a write/admin API token).

POST/organizations/{organizationSlug}/usage

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Path parameters

organizationSlugstringrequired

Request body

requiredapplication/json

event_typestringrequired

quantityinteger

min 1 · default: 1

periodstring

metadataobject

Responses

201

Recorded

successbooleanrequired

periodstringrequired

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

403

Forbidden

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationSlugpath*

Bodyapplication/json

Request body

Request

curl -X POST "https://api.seal.nyc/api/v1/organizations/string/usage" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "event_type": "string",
  "quantity": 1,
  "period": "string",
  "metadata": {}
}'

const response = await fetch("https://api.seal.nyc/api/v1/organizations/string/usage", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"event_type\": \"string\",\n  \"quantity\": 1,\n  \"period\": \"string\",\n  \"metadata\": {}\n}"
});

import requests

response = requests.post(
    "https://api.seal.nyc/api/v1/organizations/string/usage",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"event_type\": \"string\",\n  \"quantity\": 1,\n  \"period\": \"string\",\n  \"metadata\": {}\n}",
)

Response

{
  "success": true,
  "period": "string"
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}