Terminal
Terminal/Skill
Reference for calling the Inngest REST API v2 directly with raw HTTP, covering API key auth, OpenAPI spec lookup, pagination, and secret redaction.
By Inngest
Works with
npx skills add inngest/inngest-skills --skill inngest-apiFor Cloud operations with connected MCP tools, use inngest-cloud first.
Keep this skill for explicit terminal/HTTP work or a capability missing from
MCP. Do not ask for an API key when OAuth MCP can complete the task.
Use this skill for raw REST API v2 work and API reference lookup. If the task
can be completed through npx inngest-cli@latest api, use inngest-api-cli
instead; the CLI is safer for agents because it handles target/auth flags and
endpoint command wiring.
Use inngest-api-cli for:
Use raw REST API v2 only when:
When precision matters, fetch current docs instead of guessing:
https://api-docs.inngest.com/https://api-docs.inngest.com/authenticationhttps://api-docs.inngest.com/llms.txthttps://api-docs.inngest.com/api-specs/v2.json.md to a docs URL, for example
https://api-docs.inngest.com/v2/runs/GetFunctionTrace.mdIf a Markdown page returns an error or omits generated reference details, use the OpenAPI spec for methods, paths, parameters, request bodies, and schemas.
https://api.inngest.com/v2http://localhost:8288/api/v2The REST API uses Bearer token authentication.
INNGEST_API_KEY for requests from CI, scripts, tools, and agents.X-Inngest-Env or use an environment-scoped API key when operating
outside the default production environment.Example:
curl -fsSL \
-H "Authorization: Bearer $INNGEST_API_KEY" \
-H "X-Inngest-Env: $INNGEST_ENV" \
https://api.inngest.com/v2/account
Use the OpenAPI spec as the source of truth:
curl -fsSL https://api-docs.inngest.com/api-specs/v2.json
Current v2 areas include account, environments, keys, webhooks, apps, function invocation, event-run lookup, function runs, traces, Insights, and partner APIs. Endpoint coverage can change, so inspect the spec before writing a raw request.
For API-only or access-gated endpoints, such as partner-account endpoints, confirm the user has the needed access before attempting a call.
page.hasMore is true and complete results are
needed.data in list responses as an empty list unless an error is
present.Read before write. Confirm target account, environment, resource, and intent before raw HTTP mutations unless the user's instruction already makes all of that explicit.
Treat these categories as mutating or side-effecting:
INNGEST_API_KEY without pasting it
into chat.