Create Run
Creates a new workflow run in submitted status from either a self-contained legacy manifest or an immutable workflow-version intent. Creation does not start or schedule the run.
Failures return the standard error body. The intent lane responds 404 (workflow_version_not_found, environment_not_found), 422 (run_intent_invalid, target_invalid, target_environment_unsupported, workflow_version_unusable, run_compile_invalid), 503 (integration_unavailable), or 500 (workflow_version_store_error, credential_store_error, variable_store_error, run_persistence_failed).
Request body
Example request
{
"version": 1,
"parent_id": "01HV6D7S5YF4Z4B2M7K4N0Q6T8",
"title": "Add rate limiting to auth endpoints",
"cwd": "/tmp/project",
"git": {
"origin_url": "https://github.com/acme/my-app.git",
"branch": "feature/foo",
"sha": "abc123def"
},
"target": {
"path": ".fabro/workflows/smoke/workflow.fabro"
}
}Response
Run created
Example response
{
"repository": {
"name": "fabro-sh/fabro",
"origin_url": "https://github.com/fabro-sh/fabro.git"
},
"lifecycle": {
"error": {
"message": "Stage 'apply-changes' exceeded maximum retries."
}
},
"timing": {
"wall_time_ms": 420000,
"inference_time_ms": 120000,
"tool_time_ms": 60000,
"active_time_ms": 180000
},
"diff": {
"files_changed": 42,
"additions": 567,
"deletions": 234
},
"pull_request": {
"owner": "fabro-sh",
"repo": "fabro",
"number": 123,
"html_url": "https://github.com/fabro-sh/fabro/pull/123"
},
"current_question": {
"text": "Accept or push for another round?"
}
}Changes
Changed in 28 of the 134 revisions of this API.142542
- ○
added the new optional request property
oneOf[RunIntent]/target/oneOf[GitRunTarget]/tagnew-optional-request-property
- ○
- ○
added
folderdiscriminator mapping keys to theoneOf[RunIntent]/targetrequest propertyrequest-property-discriminator-mapping-added
- ○
added
FolderRunTargetto theoneOf[RunIntent]/targetrequest propertyoneOflistrequest-property-one-of-added
- ○
- ○
added
nonediscriminator mapping keys to theoneOf[RunIntent]/targetrequest propertyrequest-property-discriminator-mapping-added
- ○
added
NoneRunTargetto theoneOf[RunIntent]/targetrequest propertyoneOflistrequest-property-one-of-added
- ○
- ▲
removed
NoneRunTargetfrom theoneOf[RunIntent]/targetrequest propertyoneOflistrequest-property-one-of-removed
- ○
removed
nonediscriminator mapping keys from theoneOf[RunIntent]/targetrequest propertyrequest-property-discriminator-mapping-deleted
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
added
nonediscriminator mapping keys to theoneOf[RunIntent]/targetrequest propertyrequest-property-discriminator-mapping-added
- ○
added
NoneRunTargetto theoneOf[RunIntent]/targetrequest propertyoneOflistrequest-property-one-of-added
- ○
removed the non-success response with the status
404response-non-success-status-removed
- ○
removed the non-success response with the status
422response-non-success-status-removed
- ○
removed the non-success response with the status
500response-non-success-status-removed
- ○
removed the non-success response with the status
503response-non-success-status-removed
- ○
- ▲
the request's body type/format changed from
object/to/request-body-type-changed
- ●
removed the request property
argsrequest-property-removed
- ●
removed the request property
configsrequest-property-removed
- ●
removed the request property
cwdrequest-property-removed
- ●
removed the request property
gitrequest-property-removed
- ●
removed the request property
goalrequest-property-removed
- ●
removed the request property
parent_idrequest-property-removed
- ●
removed the request property
targetrequest-property-removed
- ●
removed the request property
titlerequest-property-removed
- ●
removed the request property
versionrequest-property-removed
- ●
removed the request property
workflowsrequest-property-removed
- ○
added
RunManifestRunIntentto the request bodyoneOflistrequest-body-one-of-added
- ○
added the non-success response with the status
404response-non-success-status-added
- ○
added the non-success response with the status
422response-non-success-status-added
- ○
added the non-success response with the status
500response-non-success-status-added
- ○
added the non-success response with the status
503response-non-success-status-added
- ▲
- ●
removed the request property
git/push_outcomerequest-property-removed
- ●
removed the request property
goal/pathrequest-property-removed
- ●
removed the request property
run_idrequest-property-removed
- ●
removed the request property
target/identifierrequest-property-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
added the new required request property
git/push_outcomenew-required-request-property
- ▲
added the new required request property
target/identifiernew-required-request-property
- ○
added the new optional request property
goal/pathnew-optional-request-property
- ○
added the new optional request property
run_idnew-optional-request-property
- ▲
- ●
removed the request property
git/push_outcomerequest-property-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
removed the request property
goal/pathrequest-property-removed
- ●
removed the request property
target/identifierrequest-property-removed
- ●