Getting Started›Overview

Overview

Last updated 2026-02-12

Rooaak is an agent orchestration platform with two API surfaces:

  • Customer API (/v1/*) for your app to create agents, send messages, manage memory, and receive webhooks.
  • Runtime API (/runtime/*) used by Rooaak-managed runtime machines to pull messages and push responses.

Official starter repos for common integration paths:

  • rooaak-custom-ui-sample-app
  • rooaak-slack-adapter-starter
  • rooaak-whatsapp-cloud-adapter-starter

Mental model

  1. Your app creates an agent in a project.
  2. Your app sends a message to the agent.
  3. Rooaak ensures the runtime is available.
  4. Runtime pulls pending messages over SSE.
  5. Runtime posts response back.
  6. You get either immediate response (200) or async fallback (202 + polling/webhook).

Authentication model

  • Project API keys authenticate customer calls and are scope-limited.
  • Admin API keys (project_id = null + admin:project) can manage projects cross-tenant.
  • Agent tokens (JWT) authenticate runtime endpoints.

What to read next

  • /docs/getting-started/quickstart
  • /docs/getting-started/auth-and-api-keys
  • /docs/getting-started/first-agent
  • /docs/getting-started/send-your-first-message
  • /docs/core-concepts/message-lifecycle