Skip to content
ArchitectureIn development5 min read · updated 2026-07-28

API integration concepts

Resource model, authentication approach and error semantics.

Resource model

ResourcePurpose
WorkspaceTenant boundary for every other resource.
ContactA customer identity with attributes and tags.
ConversationA thread of messages on a channel.
MessageA single inbound or outbound message.
CallA voice interaction with transcript and outcome.

Error semantics

Planned error shape
{
  "error": {
    "type": "invalid_request",
    "message": "contact.phone must be in E.164 format",
    "param": "contact.phone",
    "request_id": "req_01H..."
  }
}

Always log the request identifier. It is the fastest way for support to trace a failing call.

5 min read