Search documentation

Browse Awaken Workforce docs
Docs/Awaken Workforcev0.1.0/Reference/ReferenceHTTP API
Note·You're reading pre-release documentation (v0.1.0). Interfaces and behavior may change before a stable release.

Reference · Reference

HTTP API

What this page covers

Generate the exact OpenAPI contract from the Awaken Workforce router and use task guides for behavioral sequences.

The generated OpenAPI document is the only route and schema inventory. This page deliberately does not copy its paths, fields, or response tables.

Get the contract

From a checkout:

cargo run -q -p awaken-flow-server -- openapi \
  > /tmp/awaken-flow-openapi.json

From a running Server:

curl -fsS http://127.0.0.1:7979/api/openapi.json \
  > /tmp/awaken-flow-openapi.json

Both are generated from the assembled router. Confirm info.title is awaken-flow and retain the document with generated clients or compatibility tests so an upgrade produces a reviewable diff.

Surface ownership

Use OpenAPI tags and paths to locate the exact operation. Use task documentation for ordering and recovery:

JobBehavioral owner
Bootstrap a Project and definitionsDesign and automate
Create and advance IssuesManage work
Inspect or control WorkUnitsOperating Workforce
Resolve approval and AttentionInbox and approvals
Use generic Resource toolsResource and authorization model
Deploy and inspect service endpointsDeployment topologies

Most /api/* operations are protected by the configured IAM mode. Health, metrics, and contract discovery are intentionally assembled outside that layer; verify their exposure at your network boundary.

Do not build new integrations against compatibility routes merely because they remain in OpenAPI. A deprecation description in the generated operation is the authority; new work should use immutable owner revisions and current command surfaces.