Skip to main content
POST
Create a reporter run

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Body

application/json

Reporter binding, subject, and run options.

reporter
PinnedReporterRef · object
required

Reporter version to run.

subject
Subject · object
required

Resource the reporter will analyze, such as episodes, a round, league, player, or freeform input.

params
Params · object | null

Parameters passed to the reporter.

limits
ReporterLimitsOverride · object | null

Run-limit overrides.

dependencies
ReporterDependencySpec · object[]

Reporter runs that must complete before this run.

publish_post
boolean
default:false

Whether to publish the completed render output as a post.

debug
boolean
default:false

Whether to retain additional debugging information for the run.

idempotency_key
string | null

Caller-chosen key for reusing the same on-demand run request.

Required string length: 5 - 200

Response

Successful Response

id
string
required

Reporter run ID.

status
enum<string>
required

Current run status.

Available options:
pending,
running,
completed,
failed,
cancelled
reporter_version_id
string
required

Reporter version executed by this run.

subject
Subject · object
required

Resource supplied to the reporter.

status_url
string
required

Relative URL for retrieving the current run state.

output_url
string | null
required

Relative output-list URL after the run completes, otherwise null.

trace_url
string
required

Relative URL for downloading the run trace.

usage
Usage · object | null
required

Recorded resource usage.

output_parts
ReporterOutputPublic · object[] | null
required

Output metadata after the run completes, otherwise null.

created_at
string<date-time>
required

Time the run was created.

running_at
string<date-time> | null
required

Time execution started, if it has started.

completed_at
string<date-time> | null
required

Time execution ended, if it has ended.

error
string | null
required

Run error message, or null when no error was recorded.