mirror of
https://github.com/Skyvern-AI/skyvern.git
synced 2026-07-09 16:09:13 +00:00
Add workflow run retry APIs (#6195)
Co-authored-by: Suchintan Singh <suchintan@skyvern.com>
This commit is contained in:
Suchintan
GitHub
parent
d13f6c23de
commit
85f15450fd
21 changed files with 2286 additions and 45 deletions
|
|
@ -228,7 +228,8 @@
|
|||
"get": {
|
||||
"tags": [
|
||||
"Agent",
|
||||
"Workflow Runs"
|
||||
"Workflow Runs",
|
||||
"Workflows"
|
||||
],
|
||||
"summary": "Get a run by id",
|
||||
"description": "Get run information (task run, workflow run)",
|
||||
|
|
@ -1589,7 +1590,8 @@
|
|||
"get": {
|
||||
"tags": [
|
||||
"Agent",
|
||||
"Workflow Runs"
|
||||
"Workflow Runs",
|
||||
"Workflows"
|
||||
],
|
||||
"summary": "Get run timeline",
|
||||
"description": "Get timeline for a run (workflow run or task_v2 run)",
|
||||
|
|
@ -1952,6 +1954,224 @@
|
|||
"x-fern-sdk-method-name": "get_workflow_runs"
|
||||
}
|
||||
},
|
||||
"/v1/workflows/{workflow_id}/runs": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Workflow Runs"
|
||||
],
|
||||
"summary": "List runs for a workflow",
|
||||
"description": "List runs for a specific workflow. Supports filtering by status, search_key, and error_code. All filters are combined with AND logic.",
|
||||
"operationId": "get_workflow_runs_by_id_v1_workflows__workflow_id__runs_get",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "workflow_id",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"description": "Workflow permanent ID. Workflow ID starts with `wpid_`.",
|
||||
"example": "wpid_123",
|
||||
"title": "Workflow Id"
|
||||
},
|
||||
"description": "Workflow permanent ID. Workflow ID starts with `wpid_`."
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"description": "Page number for pagination.",
|
||||
"default": 1,
|
||||
"title": "Page"
|
||||
},
|
||||
"description": "Page number for pagination."
|
||||
},
|
||||
{
|
||||
"name": "page_size",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"description": "Number of runs to return per page.",
|
||||
"default": 10,
|
||||
"title": "Page Size"
|
||||
},
|
||||
"description": "Number of runs to return per page."
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/WorkflowRunStatus"
|
||||
},
|
||||
"nullable": true,
|
||||
"description": "Filter by one or more run statuses.",
|
||||
"title": "Status"
|
||||
},
|
||||
"description": "Filter by one or more run statuses."
|
||||
},
|
||||
{
|
||||
"name": "search_key",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"maxLength": 500,
|
||||
"description": "Case-insensitive substring search across workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers.",
|
||||
"title": "Search Key"
|
||||
},
|
||||
"description": "Case-insensitive substring search across workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers."
|
||||
},
|
||||
{
|
||||
"name": "error_code",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"maxLength": 500,
|
||||
"description": "Exact-match filter on the error_code field inside each task's errors JSON array.",
|
||||
"title": "Error Code"
|
||||
},
|
||||
"description": "Exact-match filter on the error_code field inside each task's errors JSON array."
|
||||
},
|
||||
{
|
||||
"name": "x-api-key",
|
||||
"in": "header",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
||||
"title": "X-Api-Key"
|
||||
},
|
||||
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/WorkflowRun"
|
||||
},
|
||||
"title": "Response Get Workflow Runs By Id V1 Workflows Workflow Id Runs Get"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-fern-sdk-method-name": "get_workflow_runs_by_id"
|
||||
}
|
||||
},
|
||||
"/v1/workflows/runs/{workflow_run_id}/retry": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Workflow Runs",
|
||||
"Workflows"
|
||||
],
|
||||
"summary": "Retry workflow run",
|
||||
"description": "Retry a workflow run using the original run parameters.",
|
||||
"operationId": "retry_workflow_run_v1_workflows_runs__workflow_run_id__retry_post",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "workflow_run_id",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"description": "The id of the workflow run to retry.",
|
||||
"examples": [
|
||||
"wr_123"
|
||||
],
|
||||
"title": "Workflow Run Id"
|
||||
},
|
||||
"description": "The id of the workflow run to retry."
|
||||
},
|
||||
{
|
||||
"name": "x-api-key",
|
||||
"in": "header",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
||||
"title": "X-Api-Key"
|
||||
},
|
||||
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
||||
},
|
||||
{
|
||||
"name": "x-max-steps-override",
|
||||
"in": "header",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"nullable": true,
|
||||
"title": "X-Max-Steps-Override"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "x-user-agent",
|
||||
"in": "header",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"title": "X-User-Agent"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully retried workflow run",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/WorkflowRunResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Workflow run is not retryable"
|
||||
},
|
||||
"404": {
|
||||
"description": "Workflow run not found"
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-fern-sdk-method-name": "retry_workflow_run"
|
||||
}
|
||||
},
|
||||
"/v1/workflows/{workflow_permanent_id}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
|
|
@ -3464,6 +3684,7 @@
|
|||
},
|
||||
"/v1/run/tasks/login": {
|
||||
"post": {
|
||||
"x-excluded": true,
|
||||
"tags": [
|
||||
"Agent"
|
||||
],
|
||||
|
|
@ -3573,6 +3794,7 @@
|
|||
},
|
||||
"/v1/run/tasks/download_files": {
|
||||
"post": {
|
||||
"x-excluded": true,
|
||||
"tags": [
|
||||
"Agent"
|
||||
],
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue