Start a run
start_runStarts a run of a tool, a model or a workflow and returns AT ONCE with the run (id, status queued or running). Runs take seconds to minutes: call get_run with the run id until status is succeeded, failed or cancelled, then read its outputs (signed links) and report. A workflow run also lists its steps, each with its own status and credits. The credits are held when the run starts and settled when it ends. Give one of tool, model and workflow, and the inputs; files are https URLs or file ids from upload_file.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "start_run"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tool | No | A tool id from list_tools. | |
| model | No | A model id from list_models. | |
| inputs | No | The inputs, as list_tools, list_models or list_workflows describe them. | |
| workflow | No | A workflow id from list_workflows. | |
| idempotency_key | No | Optional. Retrying with the same key and the same request within 24 hours returns the first answer instead of doing it twice. | |
| keep_outputs_seconds | No | How long the outputs are kept after the run ends, 600 to 604800 seconds. Default: the key's setting, else 7 days. |