Skip to main content
The HTTP API reference lists every operation you can call on Forge. Operations are grouped into families, most families into domains, and each operation has its own page generated from the OpenAPI document. Every path in this reference is under /api/v3 on https://api.forge.gloo.com. Before your first call, read Conventions for the request and response envelope, and Authentication and permissions for the credential you send.

Reading an operation page

Each operation page shows the method and path, the request parameters and body, and every response. Most descriptions end by naming the permission the call requires (“Requires permission runs:read.”) or by saying it requires none. A permission is decided where the record lives, so holding it somewhere else can still answer 403 or 404. A write that takes an Idempotency-Key lists it with its parameters; see Idempotency for when a retry is safe. The OpenAPI document also records facts about each operation that its page does not show:
  • Which permissions it checks (x-forge-permissions): the permission keys the call requires. An empty list means it requires none.
  • Which credentials it accepts (x-forge-actor-kinds): an External App, a platform API key, a Personal key, or a subset of them. Credential kinds lists each operation’s set by its /api/v2 route and operation id.
  • Which rate-limit bucket it spends from (x-forge-rate-limit): read, write, or expensive. Rate limiting lists the expensive operations and each bucket’s size.

Families

Identity and access

The calling credential, Personal keys, External Apps and job roles.

Workforce

Org units, positions, pods, people, workers and the customer directory.

Agents

Agents and their skills, tools, models and memory, plus chat sessions.

Workflows and runs

Author and dispatch workflows, follow and control runs, read outcomes and files.

Planning

Objectives and key results, roadmaps, workstreams, milestones and projects.

Knowledge

Search, ask and add knowledge; curate cases; connect external sources.

Governance

Approvals and human tasks, policies, grants, denial explanations and audit exports.

Quality

Machine judges, rubrics and verdicts, and evaluation sets and runs.

Integrations

Credentials, connections, environments, vendors, sandboxes, webhooks and email.

Cost and operations

Budgets, spending limits, token prices, the attention board and health.

Finding an operation

The /api/v2 paths serve the same operations; API versions explains how the two map. Use /api/v3 in new integrations.