Workflows

Create a live workflow

Creates a live index: validates the workflow, persists it as stage: "pending", and runs the backtest and live registration in the background. Returns immediately so the call is never held against the gateway's 29-second ceiling.

Poll GET /workflows/{workflow_id} and watch stage: pending becomes live once history is written and the index is registered for continuous calculation, or failed with a failure_reason if validation, execution or the empty-index check rejected it. Failed records are kept, not deleted, so the reason is readable.

Pass websocket_id to stream progress instead of polling, the same way the console does.

This replaces the current go-live path, which is POST /simulate with stage: "live" buried in index_parameters — a call whose name says simulation and whose effect is a production index.

post/workflows

Request

  • Base URL: https://api.indexone.io
  • URL: https://api.indexone.io/workflows
  • Auth: API key in header x-api-key and API key in header Authorization

Request body

namestring required
start_timestring required

Datetime the index history begins at, YYYY-MM-DD or YYYY-MM-DD HH:MM:SS.

exchange_calendarstring

xcals calendar code driving trading days.

team_idstring

Owning team. Would default to the caller's primary team.

Example request

{
  "exchange_calendar": "XNYS"
}

Response

Accepted. The workflow exists as pending; the deploy runs in the background.

idstring
backtest_idstring
stage'pending'
created_atstring

Changes

No recorded changes to this operation across all 1 revision of this API.