API Reference
Log In
API Reference

Report Job Outcome

post
https://api.revenium.ai/profitstream/v2/api/jobs//outcome

Report the final execution status and business outcome for a completed job. Use outcomeReason to explain a FAILED or CANCELLED status — it is the prescribed field for a failure reason and should not be encoded inside metadata. Once reported, outcomes can be updated using PATCH /{agenticJobId}/outcome. Returns 409 Conflict if an outcome has already been reported for this job.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

User-supplied external identifier for the job.

Query Params
string
required

Unique identifier of the team (organization). Format: Revenium hashid (URL-safe encoded string).

Body Params

Request to report a job outcome

string
enum
required

Execution status of the completed job

Allowed:
string | null
enum

Business outcome type

Allowed:
number | null

Monetary value of the outcome

string | null
enum

Currency for the outcome value. Defaults to USD.

string | null

Additional outcome metadata as JSON string

string | null

Human-readable explanation of the outcome — why the job failed or was cancelled. This is the prescribed field for a failure reason; do not encode it inside metadata.

string | null

Identifier of who reported the outcome (user ID or API key). Auto-set if not provided.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/hal+json
*/*

Updated 4 months ago

Did this page help you?