Skip to content
CommunicationOS

API reference

API reference specification.

Normalized endpoints for thread management, cross-network retrieval, outbound dispatch, and custody exports.

Threads and messages

Ingest, list, retrieve, and stage messages across all nineteen protocols.

  • GET /v1/threads
  • GET /v1/threads/{id}/messages
  • POST /v1/threads/{id}/drafts
  • POST /v1/threads/{id}/dispatch

Search and retrieval

Query historical records, OCR attachments, and conversational entities.

  • POST /v1/search/query
  • POST /v1/search/semantic
  • GET /v1/attachments/{id}/ocr
  • GET /v1/attachments/{id}/transcript

Counterparties and identities

Manage cross-network identity resolution and profile metadata.

  • GET /v1/counterparties
  • GET /v1/counterparties/{id}
  • POST /v1/counterparties/{id}/merge
  • GET /v1/counterparties/{id}/ledger

Custody and governance

Trigger snapshot exports, manage retention rules, and review audit logs.

  • POST /v1/exports/snapshot
  • GET /v1/exports/{id}/status
  • GET /v1/governance/audit-logs
  • POST /v1/governance/legal-holds

Machine-readable specs

The full OpenAPI document, the event schema and an llms.txt written for coding agents are published alongside the SDK. An agent can read them and produce a working client without a human opening the docs.