Update API specifications with fern api update (#5321)

Co-authored-by: github-actions <github-actions@github.com>
This commit is contained in:
Shuchang Zheng 2026-04-01 00:40:25 -07:00 committed by GitHub
parent dafc7d37b0
commit cbcbb954a6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -871,6 +871,485 @@
]
}
},
"/v1/folders": {
"post": {
"tags": [
"Workflow Folders"
],
"summary": "Create folder",
"description": "Create a new folder to organize workflows",
"operationId": "create_folder_v1_folders_post",
"parameters": [
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"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."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successfully created folder",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folder"
}
}
}
},
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "create_folder"
},
"get": {
"tags": [
"Workflow Folders"
],
"summary": "Get folders",
"description": "Get all folders for the organization",
"operationId": "get_folders_v1_folders_get",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"description": "Page number",
"default": 1,
"title": "Page"
},
"description": "Page number"
},
{
"name": "page_size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Number of folders per page",
"default": 100,
"title": "Page Size"
},
"description": "Number of folders per page"
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Search folders by title or description",
"title": "Search"
},
"description": "Search folders by title or description"
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"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": "Successfully retrieved folders",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Folder"
},
"title": "Response Get Folders V1 Folders Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "get_folders"
}
},
"/v1/folders/{folder_id}": {
"get": {
"tags": [
"Workflow Folders"
],
"summary": "Get folder",
"description": "Get a specific folder by ID",
"operationId": "get_folder_v1_folders__folder_id__get",
"parameters": [
{
"name": "folder_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "Folder ID",
"examples": [
"fld_123"
],
"title": "Folder Id"
},
"description": "Folder ID"
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"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": "Successfully retrieved folder",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folder"
}
}
}
},
"404": {
"description": "Folder not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "get_folder"
},
"put": {
"tags": [
"Workflow Folders"
],
"summary": "Update folder",
"description": "Update a folder's title or description",
"operationId": "update_folder_v1_folders__folder_id__put",
"parameters": [
{
"name": "folder_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "Folder ID",
"examples": [
"fld_123"
],
"title": "Folder Id"
},
"description": "Folder ID"
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"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."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successfully updated folder",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folder"
}
}
}
},
"404": {
"description": "Folder not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "update_folder"
},
"delete": {
"tags": [
"Workflow Folders"
],
"summary": "Delete folder",
"description": "Delete a folder. Optionally delete all workflows in the folder.",
"operationId": "delete_folder_v1_folders__folder_id__delete",
"parameters": [
{
"name": "folder_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "Folder ID",
"examples": [
"fld_123"
],
"title": "Folder Id"
},
"description": "Folder ID"
},
{
"name": "delete_workflows",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "If true, also delete all workflows in this folder",
"default": false,
"title": "Delete Workflows"
},
"description": "If true, also delete all workflows in this folder"
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"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": "Successfully deleted folder",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"title": "Response Delete Folder V1 Folders Folder Id Delete"
}
}
}
},
"404": {
"description": "Folder not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "delete_folder"
}
},
"/v1/workflows/{workflow_permanent_id}/folder": {
"put": {
"tags": [
"Workflow Folders"
],
"summary": "Update workflow folder",
"description": "Update a workflow's folder assignment for the latest version",
"operationId": "update_workflow_folder_v1_workflows__workflow_permanent_id__folder_put",
"parameters": [
{
"name": "workflow_permanent_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "Workflow permanent ID",
"examples": [
"wpid_123"
],
"title": "Workflow Permanent Id"
},
"description": "Workflow permanent ID"
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"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."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWorkflowFolderRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successfully updated workflow folder",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Workflow"
}
}
}
},
"400": {
"description": "Folder not found"
},
"404": {
"description": "Workflow not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "update_workflow_folder"
}
},
"/v1/artifacts/{artifact_id}/content": {
"get": {
"tags": [
@ -1196,6 +1675,128 @@
]
}
},
"/v1/runs": {
"get": {
"tags": [
"agent"
],
"summary": "Get Runs V2",
"operationId": "get_runs_v2_v1_runs_get",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 1,
"title": "Page"
}
},
{
"name": "page_size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 10,
"title": "Page Size"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RunStatus"
}
},
{
"type": "null"
}
],
"title": "Status"
}
},
{
"name": "search_key",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"minLength": 3
},
{
"type": "null"
}
],
"description": "Case-insensitive substring search (min 3 chars for trigram index).",
"examples": [
"login_url",
"wr_abc123"
],
"title": "Search Key"
},
"description": "Case-insensitive substring search (min 3 chars for trigram index)."
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"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/TaskRunListItem"
},
"title": "Response Get Runs V2 V1 Runs Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "get_runs_v2"
}
},
"/v1/workflows/runs": {
"get": {
"tags": [
@ -8660,6 +9261,125 @@
],
"title": "FileUploadBlockYAML"
},
"Folder": {
"properties": {
"title": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"title": "Title",
"description": "Folder title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Folder description"
},
"folder_id": {
"type": "string",
"title": "Folder Id"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"workflow_count": {
"type": "integer",
"title": "Workflow Count",
"description": "Number of workflows in this folder",
"default": 0
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"modified_at": {
"type": "string",
"format": "date-time",
"title": "Modified At"
}
},
"type": "object",
"required": [
"title",
"folder_id",
"organization_id",
"created_at",
"modified_at"
],
"title": "Folder",
"description": "Response model for a folder"
},
"FolderCreate": {
"properties": {
"title": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"title": "Title",
"description": "Folder title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Folder description"
}
},
"type": "object",
"required": [
"title"
],
"title": "FolderCreate",
"description": "Request model for creating a folder"
},
"FolderUpdate": {
"properties": {
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 255,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Title",
"description": "Folder title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Folder description"
}
},
"type": "object",
"title": "FolderUpdate",
"description": "Request model for updating a folder"
},
"ForLoopBlock": {
"properties": {
"label": {
@ -13496,6 +14216,92 @@
],
"title": "TaskBlockYAML"
},
"TaskRunListItem": {
"properties": {
"task_run_id": {
"type": "string",
"title": "Task Run Id"
},
"run_id": {
"type": "string",
"title": "Run Id"
},
"task_run_type": {
"type": "string",
"title": "Task Run Type"
},
"status": {
"type": "string",
"title": "Status"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"started_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Started At"
},
"finished_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Finished At"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"workflow_permanent_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Workflow Permanent Id"
},
"script_run": {
"type": "boolean",
"title": "Script Run",
"default": false
}
},
"type": "object",
"required": [
"task_run_id",
"run_id",
"task_run_type",
"status",
"created_at"
],
"title": "TaskRunListItem",
"description": "Lightweight run-history item backed by the task_runs table."
},
"TaskRunRequest": {
"properties": {
"prompt": {
@ -14784,6 +15590,25 @@
"title": "TotpType",
"description": "Type of 2FA/TOTP method used."
},
"UpdateWorkflowFolderRequest": {
"properties": {
"folder_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Folder Id",
"description": "Folder ID to assign workflow to. Set to null to remove from folder."
}
},
"type": "object",
"title": "UpdateWorkflowFolderRequest",
"description": "Request model for updating a workflow's folder assignment"
},
"UploadFileResponse": {
"properties": {
"s3_uri": {
@ -18382,9 +19207,11 @@
"enum": [
"manual",
"api",
"scheduled"
"scheduled",
"webhook"
],
"title": "WorkflowRunTriggerType"
"title": "WorkflowRunTriggerType",
"description": "How a workflow run was initiated.\n\n- manual: User clicked \"Run\" in the UI\n- api: Direct API call to the run endpoint\n- scheduled: Triggered by a cron schedule\n- webhook: Triggered by an external system via the webhook endpoint"
},
"WorkflowStatus": {
"type": "string",