Skip to main content
POST
Start a saved or prebuilt Play run
Authentication: workspace API key in Authorization: Bearer <key>.

Errors

Authorizations

Authorization
string
header
required

Create a workspace API key in the Deepline dashboard before calling authenticated endpoints.

Body

application/json

A saved or prebuilt Play reference with its typed input.

name
string
required

Saved or prebuilt Play reference.

input
object

Input matching the selected Play schema.

revisionId
string

Run a specific saved revision belonging to the named Play.

force
boolean

Compatibility flag. Active sibling runs are allowed.

forceToolRefresh
boolean

Bypass cached dataset and tool-call reuse.

maxCredits
number

Per-run Deepline-credit cap. Replaces the Play’s declared maxCreditsPerRun for this run.

maxConcurrentExternalCalls
integer
default:64

Per-run ceiling on concurrently resident provider-tool executions and direct HTTP calls.

Required range: 1 <= x <= 1000
maxConcurrentRows
integer

Run-wide default and ceiling for live dataset-map row resolvers.

Required range: 1 <= x <= 1000
waitForCompletionMs
integer
default:0

Briefly wait for completion. A timeout returns the existing run, not a new execution.

Required range: 0 <= x <= 15000
terminalStatus
enum<string>

With a completion wait, request the full terminal detail wrapper.

Available options:
full

Response

A successful Runtime API response.

schemaVersion
integer
required
kind
string
required
Allowed value: "play_run"
run
object
required
steps
object[]
required
outputs
object
required
datasets
object[]
required
next
object
required