Skip to main content
POST
Submit Agent Forecast

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
file
string | null
prompt
string
default:""
horizon
integer | null
Required range: x >= 1
item_id_column
string
default:item_id
timestamp_column
string
default:timestamp
target_column
string
default:target
external_covariates
string
default:""

Response

Successful Response

Response model for job status queries.

job_id
string
required
status
enum<string>
required

Status values for async forecast jobs.

Available options:
pending,
running,
completed,
failed
created_at
string<date-time>
required
completed_at
string<date-time> | null
elapsed_seconds
number | null
num_items
integer | null
prediction_length
integer | null
error
string | null
error_code
enum<string> | null

Machine-readable error codes for agent-friendly error handling.

Available options:
validation_error,
invalid_preset,
file_too_large,
rate_limited,
server_overloaded,
job_not_found,
job_not_completed,
auth_failed,
internal_error,
timeout,
pipeline_failed,
storage_error,
gpu_offload_unavailable,
connection_not_found,
connector_error,
sandbox_domain_used,
sandbox_captcha_failed,
sandbox_dataset_too_large,
sandbox_corporate_email_required
download_url
string | null
report_url
string | null
external_covariate_metadata
External Covariate Metadata · object | null
explainability
ExplainabilitySummaryResponse · object | null

Explainability execution status for a forecast job.

explainability_url
string | null
forecast_plot_url
string | null
explanation
ExplanationResponse · object | null

Post-forecast business explanation surfaced on a completed job. Written by the explanation agent (the second LLM in the agentic "sandwich"). Always vendor-neutral — the backend sanitizes every field before persisting, so no underlying model/vendor name appears here.

request_id
string | null
config_hash
string | null
dataset_hash
string | null
model_version
string | null
delivery_status
string | null
delivery_connection_id
string | null
delivery_uri
string | null
delivery_error
string | null