start_primitives_run
Run one of your saved lab projects (a circuit on the canvas, its latest version) and return a
task id to poll. The project runs as saved, at its point-in-time anchor, and takes no settings but
index. Its card draws the project's own circuit as the lab draws it, lights each card as it runs
and shows the result under it.
Get a project id from list_my_primitives_projects, then poll get_primitives_run_progress:
when the run has finished its answer carries result, each branch of the project under the
card name the project gives it, whether it beat simply holding what it trades over the same
dates, and, for a branch tested over a year or longer, a few rounded figures.
Every account runs it within a daily allowance; a refused call does not count, and get_started and
every run's answer give today's count.
A paper-trade card runs as a marker in the test; start_paper_trade with the run's task_id tracks the
project live, on paper, with a note on it every morning.
The circuit and its settings stay on QuanterLab. This run's curves are in its report
(`report_url`, below); `result.lab_url` opens the project on the canvas, where the person
changes it and saves it.
When the run has finished, its progress answer also carries `report_url`: the run written up
as a QuanterLab report (the circuit drawn, each branch that trades against simply holding and
SPY, and what followed each event of an event-study card). The circuit card shows the result
under the circuit, with the next steps as choices and the report link, so a run started here
needs no `show_report_card`.
Args:
project_id: The `id` of one of your saved lab projects.
question: Optional. One sentence restating what the run should answer, not the person's message:
the title of the report, and kept only as that.
index: Optional. sp500, nasdaq100 or dow30: the project's cards that pick their stocks from an
index QuanterLab has today's members of only (the DAX, the CAC 40, the FTSE 100, the EURO
STOXX 50, the Hang Seng, the Nikkei 225) pick from this US index instead, its members as they
were on each date, for this run only; the saved project is left as it is. QuanterLab's note
offers it after such a run.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | ||
| question | No | ||
| project_id | Yes |