Start a Workflow run
start_workflow_runStart a run of a Workflow’s current version, which spends credits: start one only when the user agrees. A GitHub Workflow translates its primary branch unless given a watched branch, and delivers by pull request unless delivery: "push". A Workflow reading a Contentful space runs over its whole selection and takes neither argument (refused with VALIDATION_ERROR). Refused with INSUFFICIENT_CREDITS (402) when the organisation is out of credits, and with WORKFLOW_AWAITING_CONVERSION_MERGE (409) while the pull request of the Conversion that created the Workflow is open (only it starts runs until it is merged; the error names it). Returns the run at once; poll get_workflow_run. When referring to a project or language in your reply to the user, use its name and locale (e.g. "French (fr-FR)") — ids (UUIDs) are for tool calls only, never show them to the user.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"workflowId": "<workflowId>"
},
"name": "start_workflow_run"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| branch | No | GitHub only: a watched branch; the primary (first) one when absent | |
| delivery | No | GitHub only: "pr" (default) or "push" to the branch | |
| workflowId | Yes | Workflow id, from list_workflows or set_up_workflow |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Pass to get_workflow_run | |
| number | Yes | `run #n`, numbered per Workflow from 1 | |
| status | Yes | pending, processing, held (at an approval Gate), completed, failed or superseded. completed means translated, not delivered: read `outputs` | |
| failure | Yes | Why a failed run failed; null otherwise | |
| outputs | Yes | Each Output of the pinned version and its delivery outcome | |
| trigger | Yes | ||
| createdAt | Yes | ||
| languages | Yes | One per target language, once the run has split into languages; empty before | |
| updatedAt | Yes | ||
| runPageUrl | Yes | The run’s page in the Globalize app | |
| workflowId | Yes | ||
| versionNumber | Yes | The Workflow version the run pinned | |
| pullRequestUrl | Yes | The pull request a GitHub Output opened or updated; null when none |