---
title: "Register API consumer"
method: POST
path: "/register_api_consumer"
---

# Register API consumer

`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

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

## Request body

- RegisterApiConsumerRequest
  - `apiIntegrationId` string, required
  - `externalUserId` string, required: A stable user ID from your application. It is stored as a hash.
  - `displayName` string
  - `email` string, email

## Response `200`

Existing consumer returned.

- RegisterApiConsumerResponse
  - `consumerId` string, required
  - `active` boolean, required
  - `canStartRun` boolean, required: False when access is disabled or the current period is exhausted.
  - `period` ApiConsumerPeriod, required
    - `id` string, required: UTC period start date and document ID, based on the member's registration date.
    - `startsAt` string, date-time, required
    - `endsAt` string, date-time, required
    - `limitMicros` integer, required: USD allowance in millionths of a dollar.
    - `spentMicros` integer, required
    - `remainingMicros` integer, required
    - `inputTokens` integer, required
    - `outputTokens` integer, required
    - `usageItemCount` integer, required
    - `lastUsageRequestId` string, nullable
    - `updatedAt` string, date-time, required
  - `created` boolean, required

## Other responses

- `201`: Consumer created.
- `400`: Invalid request or allowance policy is not configured.
- `401`: Missing or invalid platform API key.
- `403`: The API key does not own this integration.
- `404`: Integration not found.

## Changes

- **2026-11-03** `d9ab31b0307f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/agency-swarm/apis/agencii-platform-api/changes/register_api_consumer/post.md)

---

[API](https://skmtc.dev/agency-swarm/apis/agencii-platform-api.md) - [All operations](https://skmtc.dev/agency-swarm/apis/agencii-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agency-swarm/apis/agencii-platform-api/revisions/d9ab31b0307f?raw)