API docs

Build against the NatorOS operating layer.

Use the public API, OpenAPI description, OAuth metadata, MCP resources, and sandbox endpoints to integrate with governed AI workers and workflows.

Quickstart

The shortest path for a new integration or agent crawler.

  1. 1

    Read the product context

    Start with /llms-full.txt so your agent understands what NatorOS is and is not.

    Open
  2. 2

    Inspect the schema

    Use /openapi.json for endpoints, response shapes, OAuth scopes, and error models.

    Open
  3. 3

    Check auth metadata

    Use /.well-known/oauth-protected-resource for OAuth protected-resource discovery.

    Open
  4. 4

    Test safely

    Use the sandbox workflow-run endpoint before touching production workspaces.

    Open
Endpoints

Core surfaces

All production writes require scoped credentials. Public sandbox endpoints never read or write customer data.

AgentsGET /api/v1/agents

Discover available AI workers and their capabilities.

WorkflowsGET /api/v1/workflows

List governed workflows available to a workspace.

RunsGET /api/v1/runs

Read workflow-run status, history, and async job progress.

SandboxPOST /api/v1/sandbox/workflow-runs

Safely test a workflow run without customer data.

WebhooksPOST /api/v1/webhooks

Register signed event delivery endpoints.

Scopes

Request only what your integration needs.

agents:readagents:writeworkflows:readworkflows:writeruns:readrecords:readrecords:writewebhooks:write