AGagency-swarm

Register API consumer

Changed on

Idempotently registers one application member. Allowance values are controlled by the integration owner and cannot be supplied by this route.

post/register_api_consumer

Request

  • Base URL
    https://api-integration-v2-qd6wo466iq-uc.a.run.app
  • URL
    https://api-integration-v2-qd6wo466iq-uc.a.run.app/register_api_consumer
  • Auth
    HTTP bearer

Request body

apiIntegrationIdstring required
externalUserIdstring required

A stable user ID from your application. It is stored as a hash.

displayNamestring
emailstring email

Response

Existing consumer returned.

consumerIdstring required
activeboolean required
canStartRunboolean required

False when access is disabled or the current period is exhausted.

createdboolean required

Example response

{
  "period": {
    "id": "2026-09-23",
    "limitMicros": 20000000,
    "spentMicros": 4250000,
    "remainingMicros": 15750000,
    "inputTokens": 1200,
    "outputTokens": 300,
    "usageItemCount": 2
  }
}

Changes