Skip to content

CRE GraphQL API documentation - #4129

Open
ejacquier wants to merge 1 commit into
mainfrom
cre-api
Open

CRE GraphQL API documentation#4129
ejacquier wants to merge 1 commit into
mainfrom
cre-api

Conversation

@ejacquier

Copy link
Copy Markdown
Contributor

Add CRE GraphQL API documentation

Adds public developer documentation for the CRE GraphQL API — programmatic, read-only access to CRE workflows, deployments, and execution data — following the Shopify (API reference quality) + Hgraph (task-first Common Queries) model requested.

What's new

New section under CRE → Reference → GraphQL API (src/content/cre/reference/graphql-api/):

  • Overview (index.mdx) — what the API is for, the production endpoint, and scope
  • Authentication — creating an API key (links to existing CLI auth docs) and the Authorization: Apikey <CRE_API_KEY> header
  • Quickstart — first request in cURL, TypeScript, and Go
  • Common Queries — task-first recipes: account/org, workflows, deployments, executions, logs, capability event timelines
  • Query Reference — all 12 workflow/execution/account read queries with arguments, types, examples, and responses
  • Object Reference, Enum Reference, Input Reference — full type reference generated from the schema, with nullability and field descriptions
  • Pagination — the page-number model (no cursors), with a paginate-all-results algorithm and TS/Go examples
  • Errors & Rate Limits — GraphQL vs. HTTP error shapes, auth/validation/not-found behavior

Sidebar entries added under Reference in src/config/sidebar.ts.

@ejacquier
ejacquier requested review from a team as code owners August 31, 2026 15:05
@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview Aug 31, 2026 3:09pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant