POST /v1/end-users
POST/v1/end-users
Pre-register an end user (SPEC-14 §10.1). Useful to create the record before the first interaction. Idempotent: if user_id already exists in the account the existing record is returned with 200 and the supplied metadata is IGNORED (use PATCH to mutate); a brand-new user is created with 201. This never collides with the implicit creation on first /v1/respond — both converge on the same (account, user_id) row. 409 if the user_id is under deletion. Requires the read_write scope.
Request
Responses
- 200
- 201
- 400
- 401
- 403
- 409
- 422
- 429
- 500
Default Response
Response Headers
ULID stamped on every response and propagated through error envelopes. Use it when filing support tickets — it identifies the exact request in the structured logs (requestId field).
Requests-per-second ceiling for the current bucket (per-organization for authenticated calls, per-IP for public ones).
Tokens left in the bucket after this request.
ISO-8601 timestamp when the bucket will be fully refilled.
Default Response
Response Headers
ULID stamped on every response and propagated through error envelopes. Use it when filing support tickets — it identifies the exact request in the structured logs (requestId field).
Requests-per-second ceiling for the current bucket (per-organization for authenticated calls, per-IP for public ones).
Tokens left in the bucket after this request.
ISO-8601 timestamp when the bucket will be fully refilled.
Default Response
Response Headers
ULID stamped on every response and propagated through error envelopes. Use it when filing support tickets — it identifies the exact request in the structured logs (requestId field).
Default Response
Response Headers
ULID stamped on every response and propagated through error envelopes. Use it when filing support tickets — it identifies the exact request in the structured logs (requestId field).
Default Response
Response Headers
ULID stamped on every response and propagated through error envelopes. Use it when filing support tickets — it identifies the exact request in the structured logs (requestId field).
Turns consumed by the organization in the current billing period.
Turn ceiling for the organization in the current billing period.
Active relationships currently counted toward the organization’s quota.
Active-relationship ceiling for the organization’s plan.
ISO-8601 timestamp when the current billing period (and the quota) rolls over.
Default Response
Response Headers
ULID stamped on every response and propagated through error envelopes. Use it when filing support tickets — it identifies the exact request in the structured logs (requestId field).
Default Response
Response Headers
ULID stamped on every response and propagated through error envelopes. Use it when filing support tickets — it identifies the exact request in the structured logs (requestId field).
Default Response
Response Headers
ULID stamped on every response and propagated through error envelopes. Use it when filing support tickets — it identifies the exact request in the structured logs (requestId field).
Requests-per-second ceiling for the current bucket (per-organization for authenticated calls, per-IP for public ones).
Tokens left in the bucket after this request.
ISO-8601 timestamp when the bucket will be fully refilled.
Seconds the client should wait before retrying. Emitted only on 429 responses.
Turns consumed by the organization in the current billing period.
Turn ceiling for the organization in the current billing period.
Active relationships currently counted toward the organization’s quota.
Active-relationship ceiling for the organization’s plan.
ISO-8601 timestamp when the current billing period (and the quota) rolls over.
Default Response
Response Headers
ULID stamped on every response and propagated through error envelopes. Use it when filing support tickets — it identifies the exact request in the structured logs (requestId field).