Inngest API Docs

Inngest API Docs

API Overview Authentication

Account

Apps

Get apps Get app Sync app

Functions

Get functions Get function Invoke function Pause a function Resume a function

Experiments

List experiments for a function Get experiment aggregates List experiments

Runs

Create replay List runs for a function Get event runs List runs Get function run Cancel function run Rerun function run Create score Get function trace

Builds

List recent workspace builds Get a build Cancel an unfinished build Create a build Commit an upload and start the build

Webhooks

List webhooks Create webhook

Environments

List environments Create environment Update environment

Events

Insights

List event type schemas Query insights Generate insights query from prompt List insights tables

Keys

List account event keys List account signing keys

Partner API

List partner accounts Create partner account

Sandboxes

List sandboxes Create a sandbox Get a sandbox Destroy a sandbox Execute a command in a sandbox Read a sandbox file Write a sandbox file Stream sandbox logs Pause a sandbox List sandbox processes Start a sandbox process Get a sandbox process Get sandbox process output Stream sandbox process output Signal a sandbox process Wait for a sandbox process Resume a sandbox Create a sandbox snapshot List sandbox snapshots Get a sandbox snapshot Delete a sandbox snapshot

Sessions

List session keys List sessions List session runs

v2

Invoke function

Invokes a function, executing the function either asynchronously or synchronously based on the mode parameter in the request body

Loading API reference…

Get function

Fetches function configuration and status details for a function within an app

Pause a function

Pauses a function. Idempotent: pausing a paused function returns 200 and changes nothing. Send no request body. Runs already executing may continue. In Cloud, the pause can take up to a minute to apply, new runs are skipped while paused, and runs still unfinished after 7 days paused are cancelled, same as pausing in the dashboard. Wait for a pause or resume to finish before sending the opposite action: requests sent close together can be skipped or apply out of order. Confirm with GetFunction after the cache has refreshed and retry if needed. In the dev server, the pause applies right away, new runs stay queued, and it lasts until resumed or restarted. No bulk pause; call once per function.