Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Body

application/json
payload
object

The body a real delivery would carry; the run receives it as event.data. Defaults to {}.

Response

Accepted — the test runs execute in the background.

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string
required