Skip to main content
SambungAPI

Docs

Documentation

Read these before you build. Each line says when the page is the one you want.

On this page

A project key is the credential your software uses to run tools for one project. The API guide says where to mint one.

The Glossary says in plain language what each product word on these pages means.

The pages

  • The SambungAPI API: Make the first call: where to mint a key, the tool-execute path and its envelope, and the WhatsApp gateway send.
  • Connect an MCP client: Give an agent the tools through MCP: the endpoint, the project key, the application user, and the connect step.
  • The tool catalog: Plan a call before you sign up: the toolkits SambungAPI offers, and the arguments each tool takes.
  • Coming from the Composio SDK: Why the Composio SDK's tools.execute does not reach this server, and the plain HTTP request to send instead.
  • Moving to SambungAPI from another WhatsApp provider: Already on another WhatsApp provider: connect the same number here, rebuild on SambungAPI, and then remove your source provider.
  • Your first WhatsApp message: Send a first WhatsApp message on Meta's test account, before a production WhatsApp Business Account exists.
  • What SambungAPI owns: Weighing this against calling Meta's WhatsApp Cloud API yourself: the machinery around a send, and the boundary Meta keeps.

Machine-readable descriptions

These files describe the API for programs. A browser shows each one as raw data, not as a page. Every page in this section, this one included, also gives its Markdown source to a request that sends Accept: text/markdown, and at its address with .md added, such as /docs.md.

  • /llms.txt (text): The guide for agents: when to use SambungAPI, and which address to read first.
  • /openapi.json (JSON): The OpenAPI document of the public API. The contracts below describe the rest of the control and messaging routes.
  • /v1/specs/control (JSON): The control-plane contract: organizations, projects, memberships, roles and control-plane tokens.
  • /v1/specs/tools (JSON): The tools contract: tool discovery, connected accounts, auth configs and tool execution.
  • /v1/specs/catalog (JSON): The tool catalog: each toolkit, and each tool with its input schema. It needs no credential.
  • /v1/specs/messaging (JSON): The messaging contract: WhatsApp Business Accounts, the WhatsApp gateway, subscriber endpoints and their Deliveries, and the Send log.
  • /v1/specs/vocabulary (JSON): The intent vocabulary that selects a tool.