Skip to main content
POST
Register a reporter

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Body

application/json

Reporter identity and output contract.

name
string
required

Owner-scoped name used in the reporter handle.

Required string length: 1 - 200
Pattern: ^[a-z0-9][a-z0-9_.-]*$
display_name
string
required

Human-readable reporter name.

Required string length: 1 - 200
description
string
required

Explanation of what the reporter does.

Required string length: 1 - 2000
outputs
OutputDecl · object[]
required

Output parts the reporter may submit.

Required array length: 1 - 50 elements

Response

Successful Response

id
string
required

Reporter ID.

name
string
required

Owner-scoped reporter name.

user_id
string
required

User who owns the reporter.

created
boolean
required

Whether this request created the reporter.

reporter_key
string | null
required

Submission key returned once for a new reporter. Updates return null.

created_at
string<date-time>
required

Time the reporter was created.