{ "openapi": "3.1.0", "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "info": { "title": "Countersign agent API", "version": "1.0.0", "description": "Agents prepare emails; humans approve exact immutable revisions. Agent Bearer keys cannot approve or send. Public skill: /SKILL.md. Walkthrough: /onboarding.md. No account or Resend API key is required from agents. Sending is paused in the local configuration. UTF-8 byte limits and recipient permissions are enforced in addition to JSON Schema." }, "servers": [ { "url": "https://countersign.cristianmartinez.co" } ], "security": [ { "AgentBearer": [] } ], "tags": [ { "name": "Agent API", "description": "Private drafts for the authenticated agent. Reviewer sessions never authenticate these routes." } ], "paths": { "/v1/me": { "get": { "operationId": "getIdentity", "summary": "Discover identity, fixed sender, allowed recipients and limits", "description": "Discover identity, fixed sender, allowed recipients and limits", "tags": [ "Agent API" ], "security": [ { "AgentBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Identity" } } } }, "401": { "description": "Missing or invalid agent credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Transient service failure. Retry mutations with the identical key/body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/drafts": { "post": { "operationId": "createDraft", "summary": "Create a private draft", "description": "Requires Idempotency-Key. Persist key/body before dispatch. Exact successful replays return the original result for 24 hours, even after later edits.", "tags": [ "Agent API" ], "security": [ { "AgentBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Persist one key with the exact body per intended create/revise operation. Reuse both after response loss. Successful replay protection lasts 24 hours.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9._:/-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDraft" }, "example": { "to": [ "delivered@resend.dev" ], "subject": "A human-approved thank you", "html": "Your email approval workflow is ready to review.

Your email approval workflow is ready to review.

‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍ ‌‍

COUNTERSIGN

Thank you, reviewer.

Thank you for trying Countersign. Please review this example before approving it.

This email was prepared as a draft. A human must approve the recipients and both body versions before it can be sent.

Prepared with React Email. Sent through Resend only after approval.

Your email approval workflow is ready to review.

COUNTERSIGN

Thank you, reviewer.

Thank you for trying Countersign. Please review this example before approving it.

This email was prepared as a draft. A human must approve the recipients and both body versions before it can be sent.

Prepared with React Email. Sent through Resend only after approval.

", "text": "COUNTERSIGN\n\n\nTHANK YOU, REVIEWER.\n\nThank you for trying Countersign. Please review this example before approving it.\n\nThis email was prepared as a draft. A human must approve the recipients and both body versions before it can be sent.\n\n----------------------------------------\n\nPrepared with React Email. Sent through Resend only after approval.", "base_revision_id": "11111111-1111-4111-8111-111111111111" } } } }, "responses": { "201": { "description": "Successful result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mutation" } } } }, "400": { "description": "Malformed JSON/headers, missing key or invalid pagination.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid agent credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or out-of-scope object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Revision/state/idempotency conflict. Follow error.code and hint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Entire JSON exceeds 256 KiB.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or disallowed fields/recipient. Correct details.fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Transient service failure. Retry mutations with the identical key/body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "operationId": "listRevisions", "summary": "List revision history", "description": "Revision number then ID descending.", "tags": [ "Agent API" ], "security": [ { "AgentBearer": [] } ], "parameters": [ { "name": "draft", "in": "path", "required": true, "description": "Immutable ID from a previous service response.", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "description": "Opaque, context-bound next_cursor returned by the previous page; URL-encode and preserve unchanged.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevisionPage" } } } }, "400": { "description": "Malformed JSON/headers, missing key or invalid pagination.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid agent credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or out-of-scope object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Transient service failure. Retry mutations with the identical key/body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/drafts/{draft}/submit": { "post": { "operationId": "submitDraft", "summary": "Submit the current revision for human review", "description": "Repeated submission returns current state without resetting review, reopening rejection or restarting sending. Return review_url to the human.", "tags": [ "Agent API" ], "security": [ { "AgentBearer": [] } ], "parameters": [ { "name": "draft", "in": "path", "required": true, "description": "Immutable ID from a previous service response.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitDraft" }, "example": { "revision_id": "11111111-1111-4111-8111-111111111111" } } } }, "responses": { "200": { "description": "Successful result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "400": { "description": "Malformed JSON/headers, missing key or invalid pagination.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid agent credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or out-of-scope object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Revision/state/idempotency conflict. Follow error.code and hint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Entire JSON exceeds 256 KiB.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or disallowed fields/recipient. Correct details.fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Transient service failure. Retry mutations with the identical key/body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/drafts/{draft}/status": { "get": { "operationId": "getDraftStatus", "summary": "Check review, sending and delivery status", "description": "Follow next.action and poll_after_seconds: five seconds in wait states, at most two minutes per waiting session. Then hand back the link/status. contact_operator means stop; never create a replacement automatically. sent means provider acceptance, not delivery.", "tags": [ "Agent API" ], "security": [ { "AgentBearer": [] } ], "parameters": [ { "name": "draft", "in": "path", "required": true, "description": "Immutable ID from a previous service response.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "400": { "description": "Malformed JSON/headers, missing key or invalid pagination.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid agent credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or out-of-scope object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Transient service failure. Retry mutations with the identical key/body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/drafts/{draft}": { "get": { "operationId": "getDraft", "summary": "Read current content and status", "description": "Read current content and status", "tags": [ "Agent API" ], "security": [ { "AgentBearer": [] } ], "parameters": [ { "name": "draft", "in": "path", "required": true, "description": "Immutable ID from a previous service response.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft" } } } }, "400": { "description": "Malformed JSON/headers, missing key or invalid pagination.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid agent credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or out-of-scope object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Transient service failure. Retry mutations with the identical key/body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/drafts/{draft}/revisions/{revision}": { "get": { "operationId": "getRevision", "summary": "Read an immutable revision", "description": "Read an immutable revision", "tags": [ "Agent API" ], "security": [ { "AgentBearer": [] } ], "parameters": [ { "name": "draft", "in": "path", "required": true, "description": "Immutable ID from a previous service response.", "schema": { "type": "string", "format": "uuid" } }, { "name": "revision", "in": "path", "required": true, "description": "Immutable ID from a previous service response.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Revision" } } } }, "400": { "description": "Malformed JSON/headers, missing key or invalid pagination.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid agent credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or out-of-scope object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Transient service failure. Retry mutations with the identical key/body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/drafts/{draft}/events": { "get": { "operationId": "listEvents", "summary": "Inspect verified delivery evidence", "description": "Newest occurrence time then Svix ID descending. Bounce outranks failure/suppression, delivered, then sent. Complaint/delay are details only. Sent alone cannot clear reconciliation.", "tags": [ "Agent API" ], "security": [ { "AgentBearer": [] } ], "parameters": [ { "name": "draft", "in": "path", "required": true, "description": "Immutable ID from a previous service response.", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "cursor", "in": "query", "description": "Opaque, context-bound next_cursor returned by the previous page; URL-encode and preserve unchanged.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPage" } } } }, "400": { "description": "Malformed JSON/headers, missing key or invalid pagination.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid agent credential.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or out-of-scope object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Transient service failure. Retry mutations with the identical key/body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "AgentBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "cs_agent_…", "description": "Agent key from the human’s authenticated Connect page; never a reviewer password or Resend API key." } }, "schemas": { "CreateDraft": { "type": "object", "properties": { "to": { "type": "array", "prefixItems": [ { "type": "string", "description": "One plain address. Allowed inbox/test recipients come from GET /v1/me. Outer whitespace is trimmed and only the domain is lowercased." } ], "items": false, "minItems": 1, "maxItems": 1 }, "subject": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^\\r\\n]+$" }, "text": { "type": "string", "description": "Final supplied body, unchanged after approval. Maximum 100 KiB UTF-8; this byte limit is enforced by the service.", "x-max-utf8-bytes": 102400 }, "html": { "type": "string", "description": "Final supplied body, unchanged after approval. Maximum 100 KiB UTF-8; this byte limit is enforced by the service.", "x-max-utf8-bytes": 102400 } }, "required": [ "to", "subject" ], "additionalProperties": false, "description": "Supply text, HTML or both; at least one must be nonempty. Strict fields: no from, JSX, templates, CC/BCC, attachments or Reply-To. Entire uncompressed JSON is bounded to 256 KiB while streaming.", "anyOf": [ { "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1 } } }, { "required": [ "html" ], "properties": { "html": { "type": "string", "minLength": 1 } } } ], "x-max-request-bytes": 262144 }, "ReviseDraft": { "type": "object", "properties": { "to": { "type": "array", "prefixItems": [ { "type": "string", "description": "One plain address. Allowed inbox/test recipients come from GET /v1/me. Outer whitespace is trimmed and only the domain is lowercased." } ], "items": false, "minItems": 1, "maxItems": 1 }, "subject": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^\\r\\n]+$" }, "text": { "type": "string", "description": "Final supplied body, unchanged after approval. Maximum 100 KiB UTF-8; this byte limit is enforced by the service.", "x-max-utf8-bytes": 102400 }, "html": { "type": "string", "description": "Final supplied body, unchanged after approval. Maximum 100 KiB UTF-8; this byte limit is enforced by the service.", "x-max-utf8-bytes": 102400 }, "base_revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "to", "subject", "base_revision_id" ], "additionalProperties": false, "description": "Supply text, HTML or both; at least one must be nonempty. Strict fields: no from, JSX, templates, CC/BCC, attachments or Reply-To. Entire uncompressed JSON is bounded to 256 KiB while streaming. Full replacement against the current base revision; omitted bodies are removed. Approval locks the draft permanently.", "anyOf": [ { "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1 } } }, { "required": [ "html" ], "properties": { "html": { "type": "string", "minLength": 1 } } } ], "x-max-request-bytes": 262144 }, "SubmitDraft": { "type": "object", "properties": { "revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "revision_id" ], "additionalProperties": false }, "Mutation": { "type": "object", "properties": { "draft_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string", "enum": [ "drafted", "in_review", "rejected", "approved", "sending", "sent", "delivered", "bounced", "failed" ] }, "review_url": { "type": "string", "format": "uri" } }, "required": [ "draft_id", "revision_id", "status", "review_url" ], "additionalProperties": false }, "Revision": { "type": "object", "properties": { "revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "draft_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "number": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "author_agent_id": { "type": "string" }, "author_reviewer_id": { "type": [ "string", "null" ] }, "base_revision_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "from": { "type": "string" }, "to": { "type": "array", "prefixItems": [ { "type": "string" } ], "items": false, "minItems": 1, "maxItems": 1 }, "subject": { "type": "string" }, "text": { "type": "string" }, "html": { "type": "string" }, "content_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "revision_id", "draft_id", "number", "author_agent_id", "author_reviewer_id", "base_revision_id", "from", "to", "subject", "content_hash", "created_at" ], "additionalProperties": false }, "Status": { "type": "object", "properties": { "draft_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string", "enum": [ "drafted", "in_review", "rejected", "approved", "sending", "sent", "delivered", "bounced", "failed" ] }, "current_revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "review_url": { "type": "string", "format": "uri" }, "review": { "anyOf": [ { "type": "object", "properties": { "decision": { "type": "string", "enum": [ "approved", "rejected" ] }, "reason": { "type": [ "string", "null" ] }, "revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "decision", "reason", "revision_id" ], "additionalProperties": false }, { "type": "null" } ] }, "send": { "anyOf": [ { "type": "object", "properties": { "state": { "type": "string", "enum": [ "queued", "sending", "retry_wait", "sent", "failed" ] }, "error": { "type": [ "string", "null" ] }, "needs_reconciliation": { "type": "boolean" }, "resend_email_id": { "type": [ "string", "null" ] }, "delivery_status": { "anyOf": [ { "type": "string", "enum": [ "sent", "delivered", "bounced", "failed", "suppressed" ] }, { "type": "null" } ] }, "events_url": { "type": "string", "format": "uri" } }, "required": [ "state", "error", "needs_reconciliation", "resend_email_id", "delivery_status", "events_url" ], "additionalProperties": false }, { "type": "null" } ] }, "next": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "submit", "revise", "wait", "done", "contact_operator" ] }, "message": { "type": "string" } }, "required": [ "action", "message" ], "additionalProperties": false }, "poll_after_seconds": { "anyOf": [ { "type": "number", "const": 5 }, { "type": "null" } ] } }, "required": [ "draft_id", "status", "current_revision_id", "review_url", "review", "send", "next", "poll_after_seconds" ], "additionalProperties": false }, "Draft": { "type": "object", "properties": { "draft_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string", "enum": [ "drafted", "in_review", "rejected", "approved", "sending", "sent", "delivered", "bounced", "failed" ] }, "current_revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "review_url": { "type": "string", "format": "uri" }, "review": { "anyOf": [ { "type": "object", "properties": { "decision": { "type": "string", "enum": [ "approved", "rejected" ] }, "reason": { "type": [ "string", "null" ] }, "revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "decision", "reason", "revision_id" ], "additionalProperties": false }, { "type": "null" } ] }, "send": { "anyOf": [ { "type": "object", "properties": { "state": { "type": "string", "enum": [ "queued", "sending", "retry_wait", "sent", "failed" ] }, "error": { "type": [ "string", "null" ] }, "needs_reconciliation": { "type": "boolean" }, "resend_email_id": { "type": [ "string", "null" ] }, "delivery_status": { "anyOf": [ { "type": "string", "enum": [ "sent", "delivered", "bounced", "failed", "suppressed" ] }, { "type": "null" } ] }, "events_url": { "type": "string", "format": "uri" } }, "required": [ "state", "error", "needs_reconciliation", "resend_email_id", "delivery_status", "events_url" ], "additionalProperties": false }, { "type": "null" } ] }, "next": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "submit", "revise", "wait", "done", "contact_operator" ] }, "message": { "type": "string" } }, "required": [ "action", "message" ], "additionalProperties": false }, "poll_after_seconds": { "anyOf": [ { "type": "number", "const": 5 }, { "type": "null" } ] }, "revision": { "type": "object", "properties": { "revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "draft_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "number": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "author_agent_id": { "type": "string" }, "author_reviewer_id": { "type": [ "string", "null" ] }, "base_revision_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "from": { "type": "string" }, "to": { "type": "array", "prefixItems": [ { "type": "string" } ], "items": false, "minItems": 1, "maxItems": 1 }, "subject": { "type": "string" }, "text": { "type": "string" }, "html": { "type": "string" }, "content_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "revision_id", "draft_id", "number", "author_agent_id", "author_reviewer_id", "base_revision_id", "from", "to", "subject", "content_hash", "created_at" ], "additionalProperties": false } }, "required": [ "draft_id", "status", "current_revision_id", "review_url", "review", "send", "next", "poll_after_seconds", "revision" ], "additionalProperties": false }, "Identity": { "type": "object", "properties": { "agent_id": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string", "const": "own_drafts" }, "from": { "type": "string" }, "allowed_recipients": { "type": "array", "items": { "type": "string" } }, "test_aliases_supported": { "type": "boolean", "const": false }, "limits": { "type": "object", "properties": { "subjectCodePoints": { "type": "number", "const": 200 }, "bodyBytes": { "type": "number", "const": 102400 }, "requestBytes": { "type": "number", "const": 262144 }, "defaultPageSize": { "type": "number", "const": 20 }, "maxPageSize": { "type": "number", "const": 100 }, "pollSeconds": { "type": "number", "const": 5 }, "pollBudgetSeconds": { "type": "number", "const": 120 }, "requestTimeoutMs": { "type": "number", "const": 10000 }, "leaseSeconds": { "type": "number", "const": 60 }, "maxSendAttempts": { "type": "number", "const": 20 }, "retryWindowSeconds": { "type": "number", "const": 82800 }, "maxBackoffSeconds": { "type": "number", "const": 900 }, "sessionSeconds": { "type": "number", "const": 86400 } }, "required": [ "subjectCodePoints", "bodyBytes", "requestBytes", "defaultPageSize", "maxPageSize", "pollSeconds", "pollBudgetSeconds", "requestTimeoutMs", "leaseSeconds", "maxSendAttempts", "retryWindowSeconds", "maxBackoffSeconds", "sessionSeconds" ], "additionalProperties": false } }, "required": [ "agent_id", "name", "scope", "from", "allowed_recipients", "test_aliases_supported", "limits" ], "additionalProperties": false }, "DraftPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "draft_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string", "enum": [ "drafted", "in_review", "rejected", "approved", "sending", "sent", "delivered", "bounced", "failed" ] }, "current_revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "review_url": { "type": "string", "format": "uri" } }, "required": [ "draft_id", "status", "current_revision_id", "created_at", "updated_at", "review_url" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "RevisionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "revision_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "number": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "author_agent_id": { "type": "string" }, "author_reviewer_id": { "type": [ "string", "null" ] }, "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "revision_id", "number", "author_agent_id", "author_reviewer_id", "created_at" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "EventPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "occurred_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "detail": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] } }, "required": [ "id", "type", "occurred_at", "detail" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor" ], "additionalProperties": false }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "bad_request", "unauthorized", "not_found", "revision_conflict", "revision_changed", "idempotency_conflict", "invalid_state", "validation_error", "payload_too_large", "internal_error" ] }, "message": { "type": "string" }, "hint": { "type": "string" }, "details": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "code", "message", "hint", "details" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }