Update API specifications with fern api update (#6265)

Co-authored-by: github-actions <github-actions@github.com>
This commit is contained in:
Shuchang Zheng 2026-05-29 22:46:56 -07:00 committed by GitHub
parent f090dcfa5a
commit 3189947744
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1430,6 +1430,584 @@
"x-fern-sdk-method-name": "update_workflow_folder"
}
},
"/v1/workflows/{workflow_permanent_id}/tags": {
"post": {
"tags": [
"Workflow Tags"
],
"summary": "Apply workflow tags",
"description": "Atomically apply tag changes to a workflow. Sets and deletes happen in one transaction; same-key collisions resolve set-wins.",
"operationId": "apply_workflow_tags_v1_workflows__workflow_permanent_id__tags_post",
"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"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagApplyRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successfully applied tag changes",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagsResponse"
}
}
}
},
"404": {
"description": "Workflow not found"
},
"422": {
"description": "Invalid tag key or value"
}
},
"x-fern-sdk-method-name": "apply_workflow_tags"
},
"get": {
"tags": [
"Workflow Tags"
],
"summary": "Get workflow tags",
"description": "Get the current tag state for a workflow.",
"operationId": "get_workflow_tags_v1_workflows__workflow_permanent_id__tags_get",
"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."
}
],
"responses": {
"200": {
"description": "Successfully retrieved tags",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagsResponse"
}
}
}
},
"404": {
"description": "Workflow not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "get_workflow_tags"
}
},
"/v1/workflows/{workflow_permanent_id}/tags/{key}": {
"delete": {
"tags": [
"Workflow Tags"
],
"summary": "Delete workflow tag",
"description": "Soft-delete a single tag from a workflow. Writes a DELETE event row.",
"operationId": "delete_workflow_tag_v1_workflows__workflow_permanent_id__tags__key__delete",
"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": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "Tag key to delete",
"examples": [
"env"
],
"title": "Key"
},
"description": "Tag key to delete"
}
],
"responses": {
"200": {
"description": "Successfully deleted tag (or no-op if absent)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagsResponse"
}
}
}
},
"404": {
"description": "Workflow not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "delete_workflow_tag"
}
},
"/v1/workflows/{workflow_permanent_id}/tags/history": {
"get": {
"tags": [
"Workflow Tags"
],
"summary": "Get workflow tag history",
"description": "Chronological tag-event log for a workflow (newest first). Includes SET and DELETE events.",
"operationId": "get_workflow_tag_history_v1_workflows__workflow_permanent_id__tags_history_get",
"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": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max events to return",
"default": 100,
"title": "Limit"
},
"description": "Max events to return"
},
{
"name": "since",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"description": "Only return events at or after this timestamp",
"title": "Since"
},
"description": "Only return events at or after this timestamp"
},
{
"name": "key",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Filter to events for a single tag key",
"title": "Key"
},
"description": "Filter to events for a single tag key"
},
{
"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 tag history",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagHistoryResponse"
}
}
}
},
"404": {
"description": "Workflow not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "get_workflow_tag_history"
}
},
"/v1/tag-keys": {
"get": {
"tags": [
"Workflow Tags"
],
"summary": "List tag keys",
"description": "List all tag keys registered for the organization with their descriptions.",
"operationId": "list_tag_keys_v1_tag_keys_get",
"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."
}
],
"responses": {
"200": {
"description": "Successfully retrieved tag keys",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagKey"
},
"title": "Response List Tag Keys V1 Tag Keys Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "list_tag_keys"
}
},
"/v1/tag-keys/{key}": {
"patch": {
"tags": [
"Workflow Tags"
],
"summary": "Update tag key",
"description": "Update the description for a tag key.",
"operationId": "update_tag_key_v1_tag_keys__key__patch",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "Tag key to update",
"title": "Key"
},
"description": "Tag key to update"
},
{
"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/TagKeyUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successfully updated tag key",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagKey"
}
}
}
},
"404": {
"description": "Tag key not found"
},
"422": {
"description": "Description too long"
}
},
"x-fern-sdk-method-name": "update_tag_key"
}
},
"/v1/workflow-tags": {
"get": {
"tags": [
"Workflow Tags"
],
"summary": "Batch get workflow tags",
"description": "Batch fetch current tags for many workflows. Avoids N+1 on the workflows-list page.",
"operationId": "batch_get_workflow_tags_v1_workflow_tags_get",
"parameters": [
{
"name": "workflow_permanent_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Comma-separated workflow permanent IDs",
"examples": [
"wpid_123,wpid_456"
],
"title": "Workflow Permanent Ids"
},
"description": "Comma-separated workflow permanent IDs"
},
{
"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 tags",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowTagsBatchResponse"
}
}
}
},
"400": {
"description": "Too many workflow IDs requested"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "batch_get_workflow_tags"
},
"post": {
"tags": [
"Workflow Tags"
],
"summary": "Batch get workflow tags (POST)",
"description": "Batch fetch current tags for many workflows (POST variant for id lists exceeding URL length).",
"operationId": "batch_get_workflow_tags_post_v1_workflow_tags_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/WorkflowTagsBatchRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successfully retrieved tags",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowTagsBatchResponse"
}
}
}
},
"400": {
"description": "Too many workflow IDs requested"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "batch_get_workflow_tags_post"
}
},
"/v1/artifacts/{artifact_id}/content": {
"get": {
"tags": [
@ -5203,6 +5781,15 @@
},
"components": {
"schemas": {
"AIFallbackMode": {
"type": "string",
"enum": [
"fallback",
"proactive"
],
"title": "AIFallbackMode",
"description": "Controls how an action block uses a CSS/XPath selector relative to AI.\n\n- `fallback`: attempt the selector first; fall back to AI on failure.\n- `proactive`: always use AI; the selector (if any) is a hint only.\n\nWhen `selector` is None, both modes degrade to AI-only — the difference\nis purely semantic (whether the author expected to have a selector here)."
},
"AWSSecretParameter": {
"properties": {
"parameter_type": {
@ -6105,6 +6692,21 @@
"type": "boolean",
"title": "Include Extracted Text",
"default": true
},
"selector": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Selector"
},
"ai_fallback": {
"$ref": "#/components/schemas/AIFallbackMode",
"default": "fallback"
}
},
"type": "object",
@ -6197,6 +6799,21 @@
],
"title": "Navigation Goal"
},
"selector": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Selector"
},
"ai_fallback": {
"$ref": "#/components/schemas/AIFallbackMode",
"default": "fallback"
},
"error_code_mapping": {
"anyOf": [
{
@ -16797,6 +17414,210 @@
],
"title": "TOTPCodeCreate"
},
"TagApplyRequest": {
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Tags",
"description": "Tags to set (overwrite). Map of key to value."
},
"tags_to_delete": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags To Delete",
"description": "Tag keys to soft-delete."
}
},
"type": "object",
"title": "TagApplyRequest",
"description": "Body for ``POST /v1/workflows/{wpid}/tags``. Either field may be empty;\nboth empty is a valid no-op. Same-key collisions: set wins over delete."
},
"TagHistoryItem": {
"properties": {
"tag_event_id": {
"type": "string",
"title": "Tag Event Id"
},
"key": {
"type": "string",
"title": "Key"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Value"
},
"event_type": {
"type": "string",
"title": "Event Type"
},
"source": {
"type": "string",
"title": "Source"
},
"set_at": {
"type": "string",
"format": "date-time",
"title": "Set At"
},
"set_by": {
"type": "string",
"title": "Set By"
},
"superseded_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Superseded At"
}
},
"type": "object",
"required": [
"tag_event_id",
"key",
"value",
"event_type",
"source",
"set_at",
"set_by"
],
"title": "TagHistoryItem",
"description": "One row from ``GET /v1/workflows/{wpid}/tags/history``."
},
"TagHistoryResponse": {
"properties": {
"workflow_permanent_id": {
"type": "string",
"title": "Workflow Permanent Id"
},
"events": {
"items": {
"$ref": "#/components/schemas/TagHistoryItem"
},
"type": "array",
"title": "Events"
}
},
"type": "object",
"required": [
"workflow_permanent_id",
"events"
],
"title": "TagHistoryResponse"
},
"TagKey": {
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
}
},
"type": "object",
"required": [
"key"
],
"title": "TagKey",
"description": "Tag-key registry entry."
},
"TagKeyUpdate": {
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Free-form description (max 500 chars). Pass null to clear."
}
},
"type": "object",
"title": "TagKeyUpdate",
"description": "Body for ``PATCH /v1/tag-keys/{key}``."
},
"TagResponse": {
"properties": {
"value": {
"type": "string",
"title": "Value"
},
"source": {
"type": "string",
"title": "Source"
},
"set_at": {
"type": "string",
"format": "date-time",
"title": "Set At"
},
"set_by": {
"type": "string",
"title": "Set By"
}
},
"type": "object",
"required": [
"value",
"source",
"set_at",
"set_by"
],
"title": "TagResponse",
"description": "Current state of one tag (``GET /v1/workflows/{wpid}/tags`` row)."
},
"TagsResponse": {
"properties": {
"workflow_permanent_id": {
"type": "string",
"title": "Workflow Permanent Id"
},
"tags": {
"additionalProperties": {
"$ref": "#/components/schemas/TagResponse"
},
"type": "object",
"title": "Tags"
}
},
"type": "object",
"required": [
"workflow_permanent_id",
"tags"
],
"title": "TagsResponse",
"description": "Current tag map for a workflow."
},
"TaskBlock": {
"properties": {
"label": {
@ -24007,6 +24828,41 @@
],
"title": "WorkflowStatus"
},
"WorkflowTagsBatchRequest": {
"properties": {
"workflow_permanent_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Workflow Permanent Ids",
"description": "Workflow permanent IDs to fetch tags for."
}
},
"type": "object",
"title": "WorkflowTagsBatchRequest",
"description": "Body for ``POST /v1/workflow-tags`` (used when the wpid list would\nexceed the URL length cap)."
},
"WorkflowTagsBatchResponse": {
"properties": {
"workflow_tags": {
"additionalProperties": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "object",
"title": "Workflow Tags"
}
},
"type": "object",
"required": [
"workflow_tags"
],
"title": "WorkflowTagsBatchResponse",
"description": "Response for the batch endpoint.\n\nWorkflows with no tags are present with an empty dict so the frontend can\ndistinguish \"fetched, none set\" from \"not fetched\" without a second call.\nWorkflows outside the caller's org are silently absent (no leakage)."
},
"WorkflowTriggerBlock": {
"properties": {
"label": {