Aurora WorkOS

Developer documentation

Developer documentation for Aurora's external API.

Aurora WorkOS provides a workspace-scoped API for projects, issues, comments, meetings, and automation. This documentation covers setup, route reference, and long-lived client behavior.

Aurora API essentials

  • Workspace-scoped bearer-token API
  • Natural key lookup for projects and issues
  • Retry-safe create routes with Idempotency-Key
  • Cursor pagination for large list routes
  • Issue comments, meeting workflows, and agenda work links included
  • Structured machine-readable errors for automation clients

Core guides

Choose a guide

Quickstart, reference, and operational guidance for Aurora integrations.

API quickstart

Get a token, validate it, run discovery, and make your first read and write calls without guessing at ids.

Open guide

API reference

Browse endpoint families, supported methods, parameters, and operational notes for projects, issues, comments, and meetings.

Open guide

Developer guide

Build retry-safe clients with caching, pagination, structured errors, automation queues, and agent-aware workflows.

Open guide

Structure

What these docs cover

Quickstart material, endpoint reference, and operational guidance for authentication, retries, pagination, and automation.

Core API model

Understand the external API shape before you make your first call.

  • Workspace-scoped authentication
  • Natural key lookup for projects and issues
  • Human and automation assignment models
  • Comments and meetings in the same contract

Operational integration guidance

Build clients that stay correct when tokens, queues, retries, and pagination are in play.

  • Discovery-first bootstrapping
  • Idempotency patterns for create flows
  • Cursor pagination and cache strategy
  • Structured error recovery for agents

Documentation structure

Quickstart covers token setup, discovery, and first requests. Reference groups routes by resource family. The developer guide covers retries, caching, automation queues, and structured error handling.

Use cases

Common build paths

Representative integration shapes across automation, backend sync, agent workflows, and meeting pipelines.

Personal automation

Use a workspace token to script issue triage, reporting, comments, or project setup for one workspace.

Backend integration

Mirror Aurora data into another service or push execution updates in from your internal systems.

AI agent workflows

Treat Aurora as an execution system of record with discovery-first reads, idempotent writes, and visible follow-up comments.

Meeting-to-task pipelines

Use the meetings and agenda endpoints to convert discussions into issues while preserving owners and workflow state.

Guide order

Documentation map

Quickstart first, reference second, operational guidance after that.

1. Quickstart

Use /docs/api when you need a token, a first request, a discovery pass, and working cURL examples.

2. Reference

Use /docs/api/reference when you need paths, methods, and endpoint-family behavior in one place.

3. Developer guide

Use /docs/api/developer-guide when you are building long-lived clients, agents, or queue-driven workflows.