API Reference

Read-Only Agent API v1

Machine-safe endpoints for external agents to inspect templates, graph state, validation results, and sanitized export previews. No write endpoints exist under /api/v1.

Open /api/v1Open OpenAPIMarkdown Quick Ref

Capabilities

Version

1.0.0

Read Only

Yes

Base Path

/api/v1

Endpoint Matrix

MethodPathPurposeNotes
GET/api/v1API index with version, docs pointers, and endpoint list-
GET/api/v1/openapiOpenAPI 3.1 spec for the read-only API-
GET/api/v1/docsComplete docs bundle for external agent clients-
GET/api/v1/docs/markdownMarkdown quick-reference for API consumers-
GET/api/v1/packs/templatesList available pack templates with summary metadata-
GET/api/v1/packs/{id}/graphRead pack graph (atoms + edges) with sensitive setting values redactedSetting env values are always redacted in this endpoint.
GET/api/v1/packs/{id}/validateRun graph validation plus Claude export compliance checks-
GET/api/v1/packs/{id}/export/previewRead export manifest with .claude/settings.json and .mcp.json secrets redacted-

cURL Examples

Discover API capabilities

curl -s http://localhost:3000/api/v1 | jq

Read docs bundle

curl -s http://localhost:3000/api/v1/docs | jq

Read sanitized team graph

curl -s http://localhost:3000/api/v1/packs/00000000-0000-0000-0000-000000000000/graph | jq

Run validation + compliance checks

curl -s http://localhost:3000/api/v1/packs/00000000-0000-0000-0000-000000000000/validate | jq

Read sanitized export preview

curl -s http://localhost:3000/api/v1/packs/00000000-0000-0000-0000-000000000000/export/preview | jq

Replace 00000000-0000-0000-0000-000000000000 with an actual team ID (pack ID) from your workspace.

Redaction Guarantees

  • SETTING metadata with settingType=environment always redacts environment values.
  • SETTING metadata with settingType=mcp redacts mcpServers[*].env values.
  • Export preview always redacts env values in .claude/settings.json and .mcp.json.

Need product-level guidance and workflow docs? See /docs.