Recipient routing: route inbound mail to a single destination per recipient address. Rules bind an address pattern (exact or wildcard) to an endpoint; `function_id` routes an address to a function, minting its route-target endpoint.
openapi: 3.1.0
info:
title: Primitive Account Routes API
version: 1.0.0
description: "Primitive is email infrastructure for AI agents. The Primitive API lets you manage domains, emails, webhook endpoints,\nfilters, and account settings programmatically.\n\n## Authentication\n\nMost endpoints require a Bearer token in the `Authorization` header:\n\n```\nAuthorization: Bearer prim_<your_api_key>\nAuthorization: Bearer prim_oat_<oauth_access_token>\n```\n\nAPI keys and OAuth access tokens are org-scoped. Create and manage them in your dashboard\nunder Settings > API Keys. CLI login plus CLI/agent signup endpoints\nexplicitly declare `security: []`; they do not require an API key because\nthey are used to create OAuth CLI sessions.\n\n## Rate Limiting\n\nThe API enforces a sliding window rate limit of **120 requests per\n60 seconds** per organization. When exceeded, the API returns `429`\nwith a `Retry-After` header indicating how many seconds to wait.\n\n## Pagination\n\nList endpoints use cursor-based pagination. Responses include a\n`meta` object with `total`, `limit`, and `cursor` fields. Pass the\n`cursor` value as a query parameter to fetch the next page. When\n`cursor` is `null`, there are no more results.\n\n## Response Format\n\nAll responses use a consistent envelope:\n\n```json\n{\n \"success\": true,\n \"data\": { ... },\n \"meta\": { \"total\": 42, \"limit\": 50, \"cursor\": \"...\" }\n}\n```\n\nErrors follow the same pattern:\n\n```json\n{\n \"success\": false,\n \"error\": { \"code\": \"not_found\", \"message\": \"Email not found\" }\n}\n```\n\n## Webhook signing\n\nOutbound webhook deliveries (configured via the `endpoints` API)\nare signed so receivers can verify they came from Primitive and\nhave not been tampered with in transit. The signing scheme is\ndeliberately simple so it can be reimplemented in any language\nin a few lines. The Node SDK's `verifyWebhookSignature` helper\nis the reference implementation; the wire details below let you\nwrite a verifier in Python, Go, Ruby, etc. without reading our\nsource.\n\n**Header**: `Primitive-Signature: t=<unix-seconds>,v1=<hex>`\n\nA legacy `MyMX-Signature` header is also sent on every delivery\nwith the same value, retained for back-compatibility with\nintegrations written before the rename. New code should read\n`Primitive-Signature`.\n\n**Signed string**: `${timestamp}.${rawBody}` where `timestamp`\nis the Unix-seconds integer from the `t=` parameter and\n`rawBody` is the exact bytes of the HTTP request body BEFORE\nany JSON decoding. Verify against the raw body, not a\nre-serialized parse, or you will silently mismatch on\ninsignificant whitespace.\n\n**Signature**: HMAC-SHA256 of the signed string, hex-encoded\n(lowercase). Use the account's webhook secret as the HMAC key,\nas a UTF-8 byte sequence.\n\n**Secret**: returned by `GET /account/webhook-secret`. The\nstring looks base64-shaped (e.g. `XNHBBW8VqoBjRfNs1tkZj11jTk...`)\nbut is NOT base64; use it AS-IS as a UTF-8 string for the HMAC\nkey. Base64-decoding before HMAC will silently produce\nmismatched signatures.\n\n**Tolerance**: by convention, reject deliveries whose `t=`\ntimestamp is more than 5 minutes off your wall-clock to defend\nagainst replay attacks. The Node SDK's helper enforces this by\ndefault.\n\n**Verification recipe** (any language):\n\n```\n1. Read the raw HTTP body (do not parse).\n2. Read `Primitive-Signature: t=<ts>,v1=<sig>`.\n3. Reject if abs(now - ts) > 300 seconds.\n4. expected = HMAC_SHA256_hex(secret_utf8, f\"{ts}.{rawBody}\")\n5. Constant-time compare expected to sig. Reject if not equal.\n```\n\nFor Node, use `verifyWebhookSignature` from\n`@primitivedotdev/sdk/webhook` (or the higher-level\n`handleWebhook` helper if you want a one-liner). For other\nlanguages, the recipe above is everything you need.\n\nTest deliveries: `POST /endpoints/{id}/test` triggers a fake\ndelivery to your endpoint URL, signed with your real account\nsecret, so you can confirm verification end-to-end without\nneeding real inbound mail. The test response carries the exact\n`signature` header value sent on the wire so you can compare\nstrings directly.\n\n\n## Errors\n\nEvery error response is the same JSON envelope (`{ \"success\": false, \"error\": { \"code\", \"message\" } }`), served as `application/json` with HTTP status codes, following the RFC 7807 problem-details shape. The `error.code` is a stable machine-readable string and `error.message` is human-readable.\n\n## Authorization and roles\n\nAccess is governed by organization role-based access control. Every organization member holds one of three roles — `owner`, `admin`, or `member` — and a credential inherits a role. **API keys** always act at `member` level, regardless of the role of the user who created them, so an API key can never perform owner- or admin-only actions. **OAuth access tokens** act with the authorizing user's current organization role, resolved on each request. Every operation in this spec is part of the member-level surface, so any valid credential can call it. Organization administration that is not part of this API — billing and organization settings — requires an `owner` or `admin` and is performed in the dashboard. Fine-grained per-key scopes (e.g. a send-only or read-only key) are on the roadmap; today the role model is the unit of access control.\n\n## Versioning\n\nThe current stable API is **v1**. All endpoints are served under `/v1/` and are covered by a backward-compatibility guarantee: existing fields and status codes will not change without a deprecation notice.\n\nBreaking changes are announced at least 6 months in advance via changelog and email. Deprecated operations and fields are marked `x-deprecated: true` in the spec and carry a plain-English description of the replacement. The `v1` path prefix is guaranteed stable indefinitely; backward-compatible additions (new optional fields, new endpoints) may be made at any time without a version bump."
contact:
name: Primitive
url: https://primitive.dev
license:
name: Proprietary
url: https://primitive.dev/terms
x-stability-level: stable
x-deprecation-policy: 'Breaking changes are announced at least 6 months in advance. Deprecated fields carry x-deprecated: true. The current stable version is v1.'
servers:
- url: https://api.primitive.dev/v1
description: Canonical API host (PRIMITIVE_API_BASE_URL). Carries every public API operation.
tags:
- name: Routes
description: 'Recipient routing: route inbound mail to a single destination per recipient
address. Rules bind an address pattern (exact or wildcard) to an endpoint;
`function_id` routes an address to a function, minting its route-target
endpoint.
'
paths:
/routes:
get:
operationId: listRoutes
summary: List recipient routes
description: 'Returns the org''s recipient routing rules in evaluation order. Each rule
binds a recipient address pattern to one endpoint; inbound mail resolves
to a single destination at delivery time.
'
tags:
- Routes
responses:
'200':
description: List of routes
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
const: true
required:
- success
- data
- type: object
properties:
data:
type: array
items:
type: object
description: A recipient routing rule binding an address pattern to one endpoint.
properties:
id:
type: string
format: uuid
org_id:
type: string
format: uuid
domain_id:
type:
- string
- 'null'
format: uuid
description: Domain the route is scoped to; null = org-wide.
match_type:
type: string
enum:
- exact
- wildcard
- regex
pattern:
type: string
description: The recipient address pattern (an exact address or a wildcard).
pattern_norm:
type:
- string
- 'null'
description: Normalized pattern used for matching.
endpoint_id:
type: string
format: uuid
description: The endpoint inbound mail matching this rule is delivered to.
priority:
type: integer
description: Evaluation order within a scope; lower is checked first.
enabled:
type: boolean
match_count:
type: string
description: How many emails have matched this rule (a bigint, returned as a string).
last_matched_at:
type:
- string
- 'null'
format: date-time
created_at:
type: string
format: date-time
required:
- id
headers:
ratelimit-limit:
description: Maximum number of requests allowed in the current window.
schema:
type: integer
minimum: 1
example: 120
ratelimit-remaining:
description: Remaining requests in the current window.
schema:
type: integer
minimum: 0
example: 118
ratelimit-reset:
description: Unix timestamp (seconds) when the current window resets.
schema:
type: integer
example: 1700000060
ratelimit-policy:
description: Rate-limit policy in `limit;w=seconds` format, e.g. `120;w=60`.
schema:
type: string
example: 120;w=60
'401':
$ref: '#/components/responses/Unauthorized'
description: Invalid or missing API key
security:
- BearerAuth: []
post:
operationId: createRoute
summary: Create a recipient route
description: 'Binds a recipient pattern to a destination. Provide exactly one of
`endpoint_id` (an existing endpoint) or `function_id`. With `function_id`,
a dedicated route-target endpoint is minted for that function in the same
transaction, enabling per-address function routing (e.g.
`alice@acme.com -> functionA`).
'
tags:
- Routes
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
description: 'Provide exactly one of `endpoint_id` or `function_id`. With `function_id`,
a route-target endpoint is minted for that function and the route is bound
to it in one transaction.
'
properties:
match_type:
type: string
enum:
- exact
- wildcard
- regex
pattern:
type: string
minLength: 1
maxLength: 512
endpoint_id:
type: string
format: uuid
description: An existing endpoint to route to. Mutually exclusive with function_id.
function_id:
type: string
format: uuid
description: Route to this function, minting its route-target endpoint if needed. Mutually exclusive with endpoint_id.
domain_id:
type:
- string
- 'null'
format: uuid
description: Scope the route to a domain; defaults to the pattern's domain.
priority:
type: integer
minimum: 0
maximum: 1000000
enabled:
type: boolean
required:
- match_type
- pattern
responses:
'201':
description: Route created
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
const: true
required:
- success
- data
- type: object
properties:
data:
type: object
description: A recipient routing rule binding an address pattern to one endpoint.
properties:
id:
type: string
format: uuid
org_id:
type: string
format: uuid
domain_id:
type:
- string
- 'null'
format: uuid
description: Domain the route is scoped to; null = org-wide.
match_type:
type: string
enum:
- exact
- wildcard
- regex
pattern:
type: string
description: The recipient address pattern (an exact address or a wildcard).
pattern_norm:
type:
- string
- 'null'
description: Normalized pattern used for matching.
endpoint_id:
type: string
format: uuid
description: The endpoint inbound mail matching this rule is delivered to.
priority:
type: integer
description: Evaluation order within a scope; lower is checked first.
enabled:
type: boolean
match_count:
type: string
description: How many emails have matched this rule (a bigint, returned as a string).
last_matched_at:
type:
- string
- 'null'
format: date-time
created_at:
type: string
format: date-time
required:
- id
'400':
$ref: '#/components/responses/ValidationError'
description: Invalid request parameters
'401':
$ref: '#/components/responses/Unauthorized'
description: Invalid or missing API key
'403':
$ref: '#/components/responses/Forbidden'
description: Authenticated caller lacks permission for the operation
'409':
$ref: '#/components/responses/Conflict'
description: The request conflicts with the current state of the resource
security:
- BearerAuth: []
parameters:
- name: Idempotency-Key
in: header
required: false
description: Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.
schema:
type: string
minLength: 1
maxLength: 255
/routes/reorder:
post:
operationId: reorderRoutes
summary: Reorder recipient routes
description: Update the priority of one or more routes in a single call.
tags:
- Routes
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
updates:
type: array
minItems: 1
maxItems: 1000
items:
type: object
additionalProperties: false
properties:
id:
type: string
format: uuid
priority:
type: integer
minimum: 0
maximum: 1000000
required:
- id
- priority
required:
- updates
responses:
'200':
description: Updated route list
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
const: true
required:
- success
- data
- type: object
properties:
data:
type: array
items:
type: object
description: A recipient routing rule binding an address pattern to one endpoint.
properties:
id:
type: string
format: uuid
org_id:
type: string
format: uuid
domain_id:
type:
- string
- 'null'
format: uuid
description: Domain the route is scoped to; null = org-wide.
match_type:
type: string
enum:
- exact
- wildcard
- regex
pattern:
type: string
description: The recipient address pattern (an exact address or a wildcard).
pattern_norm:
type:
- string
- 'null'
description: Normalized pattern used for matching.
endpoint_id:
type: string
format: uuid
description: The endpoint inbound mail matching this rule is delivered to.
priority:
type: integer
description: Evaluation order within a scope; lower is checked first.
enabled:
type: boolean
match_count:
type: string
description: How many emails have matched this rule (a bigint, returned as a string).
last_matched_at:
type:
- string
- 'null'
format: date-time
created_at:
type: string
format: date-time
required:
- id
headers:
ratelimit-limit:
description: Maximum number of requests allowed in the current window.
schema:
type: integer
minimum: 1
example: 120
ratelimit-remaining:
description: Remaining requests in the current window.
schema:
type: integer
minimum: 0
example: 118
ratelimit-reset:
description: Unix timestamp (seconds) when the current window resets.
schema:
type: integer
example: 1700000060
ratelimit-policy:
description: Rate-limit policy in `limit;w=seconds` format, e.g. `120;w=60`.
schema:
type: string
example: 120;w=60
'400':
$ref: '#/components/responses/ValidationError'
description: Invalid request parameters
'401':
$ref: '#/components/responses/Unauthorized'
description: Invalid or missing API key
security:
- BearerAuth: []
parameters:
- name: Idempotency-Key
in: header
required: false
description: Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.
schema:
type: string
minLength: 1
maxLength: 255
/routes/simulate:
post:
operationId: simulateRoute
summary: Simulate routing for a recipient
description: 'Resolves where an inbound email to `recipient` would be delivered, with a
trace of every rule evaluated and why. Read-only; creates nothing.
'
tags:
- Routes
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
recipient:
type: string
minLength: 1
maxLength: 320
event_type:
type: string
minLength: 1
maxLength: 100
description: Event type to model; defaults to email.received.
required:
- recipient
responses:
'200':
description: Routing decision
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
const: true
required:
- success
- data
- type: object
properties:
data:
type: object
description: Where an inbound email to the recipient would be delivered, and why.
properties:
outcome:
type: string
enum:
- matched
- defaulted
- none
recipient:
type: string
endpoint_id:
type:
- string
- 'null'
matched_route_id:
type:
- string
- 'null'
matched_tier:
type:
- string
- 'null'
enum:
- exact
- wildcard
- regex
- null
matched_pattern:
type:
- string
- 'null'
default_scope:
type:
- string
- 'null'
enum:
- domain
- org
- null
evaluated:
type: array
items:
type: object
properties:
route_id:
type: string
tier:
type: string
enum:
- exact
- wildcard
- regex
pattern:
type: string
result:
type: string
enum:
- hit
- miss
- skipped
- error
reason:
type: string
required:
- route_id
- tier
- pattern
- result
truncated:
type: boolean
required:
- outcome
- recipient
- endpoint_id
- matched_route_id
- matched_tier
- matched_pattern
- default_scope
- evaluated
- truncated
headers:
ratelimit-limit:
description: Maximum number of requests allowed in the current window.
schema:
type: integer
minimum: 1
example: 120
ratelimit-remaining:
description: Remaining requests in the current window.
schema:
type: integer
minimum: 0
example: 118
ratelimit-reset:
description: Unix timestamp (seconds) when the current window resets.
schema:
type: integer
example: 1700000060
ratelimit-policy:
description: Rate-limit policy in `limit;w=seconds` format, e.g. `120;w=60`.
schema:
type: string
example: 120;w=60
'400':
$ref: '#/components/responses/ValidationError'
description: Invalid request parameters
'401':
$ref: '#/components/responses/Unauthorized'
description: Invalid or missing API key
security:
- BearerAuth: []
parameters:
- name: Idempotency-Key
in: header
required: false
description: Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.
schema:
type: string
minLength: 1
maxLength: 255
/routes/{id}:
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: Resource UUID
patch:
operationId: updateRoute
summary: Update a recipient route
tags:
- Routes
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
match_type:
type: string
enum:
- exact
- wildcard
- regex
pattern:
type: string
minLength: 1
maxLength: 512
endpoint_id:
type: string
format: uuid
domain_id:
type:
- string
- 'null'
format: uuid
priority:
type: integer
minimum: 0
maximum: 1000000
enabled:
type: boolean
responses:
'200':
description: Updated route
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
const: true
required:
- success
- data
- type: object
properties:
data:
type: object
description: A recipient routing rule binding an address pattern to one endpoint.
properties:
id:
type: string
format: uuid
org_id:
type: string
format: uuid
domain_id:
type:
- string
- 'null'
format: uuid
description: Domain the route is scoped to; null = org-wide.
match_type:
type: string
enum:
- exact
- wildcard
- regex
pattern:
type: string
description: The recipient address pattern (an exact address or a wildcard).
pattern_norm:
type:
- string
- 'null'
description: Normalized pattern used for matching.
endpoint_id:
type: string
format: uuid
description: The endpoint inbound mail matching this rule is delivered to.
priority:
type: integer
description: Evaluation order within a scope; lower is checked first.
enabled:
type: boolean
match_count:
type: string
description: How many emails have matched this rule (a bigint, returned as a string).
last_matched_at:
type:
- string
- 'null'
format: date-time
created_at:
type: string
format: date-time
required:
- id
headers:
ratelimit-limit:
description: Maximum number of requests allowed in the current window.
schema:
type
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/primitive/refs/heads/main/openapi/primitive-routes-api-openapi.yml