Console
Documentation/API reference

API reference

Versioned resources, authentication and error handling.

The machine-readable API contract is served at /openapi.json by the API service. It is the source for generated client operation registries and should be checked against the deployed version before upgrading an integration.

Authentication

Use Authorization: Bearer <API_KEY> for server integrations. Access is restricted to the credential's organization, project, capabilities and optional number allowlist. A key cannot select an arbitrary tenant by supplying an organization ID. Dashboard sessions use account membership checks.

Resources

The /api/v1 surface covers numbers, connections, contacts, conversations, messages, media, templates, routes, events, webhook subscriptions, usage and API keys. Use the generated SDK rather than constructing undocumented endpoints.

Errors

Inspect HTTP status, machine-readable error code and request ID. Permission errors require a scope or membership correction, not repeated retries. Rate-limit responses require backoff. Validation failures should be corrected before resubmission.

Idempotency

Send an Idempotency-Key header with message creation. Reusing a key for the same request retrieves the original result; changing the payload while reusing it is rejected. Keep the key stable across network retries. An ambiguous upstream timeout must be investigated rather than automatically converted into another send.

Pagination and event cursors

Use cursors returned by the API. Do not parse or manufacture them. Persist an event cursor only after your consumer has durably processed the event. Delivery may be repeated; deduplicate using the event ID.

Compatibility

The public API is versioned independently from Meta Graph API and Embedded Signup. Meta-like messaging payloads do not make Sqkii an unrestricted Graph API proxy. Use documented resources and capabilities.

Prepared 18 November 2026 · Sqkii Pte. Ltd.