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

List experiments

Lists observed experiments in the authenticated environment. Use the nested app and function route to scope results to one function.

Loading API reference…

Get experiment aggregates

Fetches variant run counts and score aggregates for one experiment on one function.

Create replay

Creates an asynchronous replay for matching runs of one function. Cloud bounds have millisecond precision: from rounds down; until includes the end of its millisecond. Dev server bounds are inclusive at stored timestamp precision. Dev server replays run in memory and are lost on restart. Requests are not idempotent: retrying creates another replay. In Inngest Cloud, replays are listed on the function's Replays page in the dashboard. Scheduling is best effort and does not preserve event order.