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 four 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​

  • Calling the API from a script — the header a script or service sends, the errors it can get, and what it cannot reach.
  • Errors — the error body 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 and ordered as one.
  • Deployments and incidents — Deployments are the deploy runs Jaah recorded for a project, with their commit range, PRs and post-deploy measurements; incidents are the production problems recorded against a project.
  • Releases — Releases move a project's code from one stage to the next, Dev to Production by default.
  • Outcome links — Outcome links are the evidence that a merged task caused a defect: a revert, a later fix referencing its PR, or an operator's "caused by".
  • Projects — Projects connect one or more repositories to Jaah: their branches, gate commands, members, environment variables, node groups, MCP links and issue-tracker links.
  • Hosted apps — Hosted apps are Easy Mode's sponsored web apps: each one is a project with a repo in Jaah's GitHub organization that deploys on every push to main, served at its own address.
  • 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.
  • Agents — Agents are the coding agents a task can run with besides the built-in ones: your organization's own, registered from a GitHub repo or installed from the ACP registry, and the catalog connectors Jaah publishes.
  • 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.
  • Slack — Slack connects your organization's Slack workspace, so its members get task alerts and answer questions there.
  • Email — Email connects your organization's own Gmail mailbox, so mail is sent from your address, lists what was sent from it, and manages the Jaah addresses your automations receive email at.
  • People and groups — People are the users of your organization, and groups collect them so access can be granted once.
  • Compliance — Portfolio Compliance scores every repository against a pack of rules.
  • Compliance manifests — Every finished task and epic gets a signed AI-provenance manifest, read and regenerated from the task's own endpoints.
  • 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, email domains, IP allowlist, setup progress, data region, retention windows, SIEM export, NodeLinks and their storage, settings, and deleting the organization.
  • Automations — Automations run an action when something happens: on a schedule or when an event arrives, on a set of projects or nodes.
  • Schedules — Schedules run an activity on a recurring cadence.
  • Triggers — Triggers file a task in a project when an event arrives, such as a signed webhook.
  • Tracker connections — Tracker connections start tasks from Linear, Jira or Backlog: an issue assigned to Jaah, a comment mentioning Jaah, or the start label files one task in the Jaah project its team or project is mapped to.
  • Webhooks — Outgoing webhooks send your organization's task and pull request events to your own HTTPS endpoints as signed requests; manage the endpoints, their secrets and their delivery logs.
  • Playbooks and personas — Personas are the roles an agent can take on a task, and playbooks define the stages a task moves through.
  • Task templates — Task templates are ready-made tasks you start in one click. Browse, search and star them, and create, edit, duplicate and delete your organization's own.
  • 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 and the nodes it includes, subscription, invoices, payment methods and usage, and what you may host and at what price.
  • 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.
  • Audit and health — The audit log records who changed what, and when. Health reports whether each part of Jaah is working.
  • Command center — The command center is the overview Org Owners and Org Admins get of their organization: projects and their health, people, agents, delivery, cost, quality and risks.
  • Agent performance — Agent performance measures how each agent configuration (agent, model family, persona and review tier) does on your organization's tasks.
  • Routing — The routing scoreboard grades the agent router's picks against what actually ran.