Skip to main content

Jaah API reference

The Jaah API is the HTTP API the Jaah console itself calls: every endpoint here is one the console uses to read or change your organization's tasks, projects, nodes and settings. Requests and responses are JSON unless an endpoint says otherwise, and every path starts with /api/.

Start with the three pages that apply to every endpoint, then find the endpoint you need under its product area. Each endpoint page lists its method and path, its path and query parameters, its request body and every response it declares, with the schema of each.

Every endpoint​

  • Errors — the error body, the access-request hint, and what each status code means.
  • Pagination — how a list endpoint hands you its results a page at a time.
  • Rate limits — the endpoints that cap how often you may call them, and what a refused call returns.

Endpoints by product area​

  • Tasks — Tasks are the unit of work an agent runs: create, edit, start, pause and complete them, and follow their comments, questions, attachments and dependencies.
  • Features — Features group a project's tasks into a deliverable that is planned, ordered and shipped as one.
  • Projects — Projects connect a repository to Jaah: its branches, gate commands, members, environment variables, assigned nodes and linked Jira issues.
  • Worktrees — Worktrees are the checked-out working copies a project's tasks run in, one per slot on a node.
  • Nodes — Nodes are the machines that run agents.
  • Agent accounts — Agent accounts are the model-provider accounts your agents run on.
  • Credentials — Credentials store the connection details your tasks use to reach third-party systems such as Jira, Slack or AWS.
  • Forge connections — Forge connections link Jaah and its users to GitHub, GitLab, Bitbucket and Azure DevOps.
  • People and groups — People are the users of your organization, and groups collect them so access can be granted once.
  • Access — Access decides who may do what, and where: role bindings grant a role to a user or group at a scope.
  • Organization — Your organization's profile, domains, setup progress, shared storage and settings.
  • Schedules — Schedules run an activity on a recurring cadence, such as starting a task every hour.
  • Playbooks and personas — Personas are the roles an agent can take on a task, and playbooks define the stages a task moves through.
  • Sessions — Sessions are the recorded agent runs behind your tasks.
  • Support — Support covers the Help assistant's conversations and the tickets they raise.
  • Billing — Billing covers your plan, subscription, invoices, payment methods and usage.
  • Inbox — The inbox is the notification feed behind the bell: mentions, questions and other items that need you.
  • Task tags — Task tags label tasks for filtering and reporting, organized into tag groups.
  • Compliance — Compliance reports how each repository meets the portfolio's rules.
  • Audit and health — The audit log records who changed what, and when.