Skip to the main content
Post Array
Menu

Documentation

One backend, four ways in. Each section documents the same use cases, so a concept you learn in the REST API is the same concept in MCP and in the CLI.

  • Getting started

    Authentication, workspaces, projects, and your first published post.

    Not published yetThis section is written against the shipped API and publishes with it. We would rather show you nothing than documentation for an endpoint that might change.

  • REST API

    Resources, pagination, idempotency, error codes and rate limits.

    Not published yetThis section is written against the shipped API and publishes with it. We would rather show you nothing than documentation for an endpoint that might change.

  • MCP server

    Transport, OAuth, tool catalog, scopes and the approval handshake.

    Not published yetThis section is written against the shipped API and publishes with it. We would rather show you nothing than documentation for an endpoint that might change.

  • CLI

    Install, authenticate, and the machine readable output contract.

    Not published yetThis section is written against the shipped API and publishes with it. We would rather show you nothing than documentation for an endpoint that might change.

  • Webhooks

    Event catalog, signature verification, retries and redelivery.

    Not published yetThis section is written against the shipped API and publishes with it. We would rather show you nothing than documentation for an endpoint that might change.

  • Connectors

    Per platform requirements, account types, limits and known restrictions.

  • Error reference

    Every error code, what causes it, and what to do about it.

    Not published yetThis section is written against the shipped API and publishes with it. We would rather show you nothing than documentation for an endpoint that might change.

What you can rely on

  • Every write takes an idempotency key. Replaying a request with the same key returns the original result rather than creating a second post.
  • Every error carries a stable code, a message key and sanitized details. Codes do not change meaning between versions.
  • Breaking changes get a new version and an announced deprecation window. Additive changes do not.
  • Reading, drafting, requesting approval, scheduling and publishing are separate scopes. A credential gets the smallest set that does its job.

API and MCP Terms