Skip to main content
POST
Create user

Autorizações

X-API-Key
string
header
obrigatório

Corpo

application/json
reference
string | null

Client-controlled label, unique per tenant if provided. Used for dedup and search; never appears as URL identifier.

Maximum string length: 128
Pattern: ^[a-zA-Z0-9_\-:.]+$
name
string | null

Display name.

email
string<email> | null
phone
string | null
metadata
Metadata · object | null

Integrator-defined storage. Persisted with the user and returned on read. Not injected into the agent context.

info
Info · object | null

Personal user attributes that ARE injected into the agent's system context whenever this user is in a session (rendered as a <user_info> block alongside name/email/phone). Use sparingly - large payloads inflate every prompt.

Resposta

Successful Response

id
string
obrigatório
created_at
string<date-time>
obrigatório
updated_at
string<date-time>
obrigatório
reference
string | null
name
string | null
email
string | null
phone
string | null
metadata
Metadata · object | null
info
Info · object | null