From 4030497cb1d27efa6e65efc6eeaf629504362b9f Mon Sep 17 00:00:00 2001 From: Suchintan Singh Date: Thu, 30 Jan 2025 11:27:19 -0500 Subject: [PATCH 1/2] OpenAPI Spec --- fern/docs.yml | 1 + fern/fern.config.json | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/fern/docs.yml b/fern/docs.yml index 8301c1a193..d42fc0d6eb 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -14,6 +14,7 @@ colors: dark: '#000000' light: '#FFFFFF' navigation: + - api: API Reference - section: Getting Started contents: - page: Introduction diff --git a/fern/fern.config.json b/fern/fern.config.json index f459022e91..c433a97c75 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { - "version": "0.47.2", - "organization": "skyverndocs" + "organization": "skyverndocs", + "version": "0.51.11" } \ No newline at end of file From 2684730b47cafc1879599b324ef985dfb80c9b9b Mon Sep 17 00:00:00 2001 From: Suchintan Singh Date: Thu, 30 Jan 2025 11:27:31 -0500 Subject: [PATCH 2/2] OpenAPI Spec --- fern/generators.yml | 12 + fern/openapi/skyvern_openapi.yml | 9512 ++++++++++++++++++++++++++++++ 2 files changed, 9524 insertions(+) create mode 100644 fern/generators.yml create mode 100644 fern/openapi/skyvern_openapi.yml diff --git a/fern/generators.yml b/fern/generators.yml new file mode 100644 index 0000000000..ba0d1bfc4f --- /dev/null +++ b/fern/generators.yml @@ -0,0 +1,12 @@ +# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json +default-group: local +groups: + local: + generators: + - name: fernapi/fern-typescript-node-sdk + version: 0.39.3 + output: + location: local-file-system + path: ../sdks/typescript +api: + path: openapi/skyvern_openapi.yml diff --git a/fern/openapi/skyvern_openapi.yml b/fern/openapi/skyvern_openapi.yml new file mode 100644 index 0000000000..139b7a352a --- /dev/null +++ b/fern/openapi/skyvern_openapi.yml @@ -0,0 +1,9512 @@ +openapi: 3.1.0 +info: + title: FastAPI + version: 0.1.0 +paths: + /api/v1/webhook: + post: + tags: + - server + summary: Webhook + operationId: webhook_api_v1_webhook_post + parameters: + - name: x-skyvern-signature + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Skyvern-Signature + - name: x-skyvern-timestamp + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Skyvern-Timestamp + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/heartbeat: + get: + tags: + - server + summary: Check Server Status + description: Check if the server is running. + operationId: check_server_status_api_v1_heartbeat_get + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + /api/v1/tasks: + post: + tags: + - agent + summary: Create Agent Task + operationId: create_agent_task_api_v1_tasks_post + parameters: + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: x-max-steps-override + in: header + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: X-Max-Steps-Override + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TaskRequest' + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTaskResponse' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + get: + tags: + - agent + summary: Get Agent Tasks + description: >- + Get all tasks. + + :param page: Starting page, defaults to 1 + + :param page_size: Page size, defaults to 10 + + :param task_status: Task status filter + + :param workflow_run_id: Workflow run id filter + + :param only_standalone_tasks: Only standalone tasks, tasks which are + part of a workflow run will be filtered out + + :param order: Direction to sort by, ascending or descending + + :param sort: Column to sort by, created_at or modified_at + + :return: List of tasks with pagination without steps populated. Steps + can be populated by calling the + get_agent_task endpoint. + operationId: get_agent_tasks_api_v1_tasks_get + parameters: + - name: page + in: query + required: false + schema: + type: integer + minimum: 1 + default: 1 + title: Page + - name: page_size + in: query + required: false + schema: + type: integer + minimum: 1 + default: 10 + title: Page Size + - name: task_status + in: query + required: false + schema: + anyOf: + - type: array + items: + $ref: '#/components/schemas/TaskStatus' + - type: 'null' + title: Task Status + - name: workflow_run_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Workflow Run Id + - name: only_standalone_tasks + in: query + required: false + schema: + type: boolean + default: false + title: Only Standalone Tasks + - name: application + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Application + - name: sort + in: query + required: false + schema: + $ref: '#/components/schemas/OrderBy' + default: created_at + - name: order + in: query + required: false + schema: + $ref: '#/components/schemas/SortDirection' + default: desc + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Task' + title: Response Get Agent Tasks Api V1 Tasks Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/tasks/{task_id}/steps: + post: + tags: + - agent + summary: Executes the next step + operationId: execute_agent_task_step_api_v1_tasks__task_id__steps_post + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: step_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Step Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/Step' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + get: + tags: + - agent + summary: Get Agent Task Steps + description: |- + Get all steps for a task. + :param task_id: + :return: List of steps for a task with pagination. + operationId: get_agent_task_steps_api_v1_tasks__task_id__steps_get + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Step' + title: Response Get Agent Task Steps Api V1 Tasks Task Id Steps Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/tasks/{task_id}/steps/{step_id}: + post: + tags: + - agent + summary: Executes a specific step + operationId: execute_agent_task_step_api_v1_tasks__task_id__steps__step_id__post + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: step_id + in: path + required: true + schema: + anyOf: + - type: string + - type: 'null' + title: Step Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/Step' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/tasks/{task_id}: + get: + summary: Get Task + operationId: get_task_api_v1_tasks__task_id__get + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/TaskResponse' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/tasks/{task_id}/cancel: + post: + summary: Cancel Task + operationId: cancel_task_api_v1_tasks__task_id__cancel_post + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows/runs/{workflow_run_id}/cancel: + post: + summary: Cancel Workflow Run + operationId: cancel_workflow_run_api_v1_workflows_runs__workflow_run_id__cancel_post + parameters: + - name: workflow_run_id + in: path + required: true + schema: + type: string + title: Workflow Run Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/tasks/{task_id}/retry_webhook: + post: + tags: + - agent + summary: Retry Webhook + operationId: retry_webhook_api_v1_tasks__task_id__retry_webhook_post + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/TaskResponse' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/internal/tasks/{task_id}: + get: + summary: Get Task Internal + description: >- + Get all tasks. + + :param page: Starting page, defaults to 1 + + :param page_size: + + :return: List of tasks with pagination without steps populated. Steps + can be populated by calling the + get_agent_task endpoint. + operationId: get_task_internal_api_v1_internal_tasks__task_id__get + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Task' + title: Response Get Task Internal Api V1 Internal Tasks Task Id Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/internal/tasks: + get: + tags: + - agent + summary: Get Agent Tasks Internal + description: >- + Get all tasks. + + :param page: Starting page, defaults to 1 + + :param page_size: Page size, defaults to 10 + + :return: List of tasks with pagination without steps populated. Steps + can be populated by calling the + get_agent_task endpoint. + operationId: get_agent_tasks_internal_api_v1_internal_tasks_get + parameters: + - name: page + in: query + required: false + schema: + type: integer + minimum: 1 + default: 1 + title: Page + - name: page_size + in: query + required: false + schema: + type: integer + minimum: 1 + default: 10 + title: Page Size + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Task' + title: Response Get Agent Tasks Internal Api V1 Internal Tasks Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/{entity_type}/{entity_id}/artifacts: + get: + tags: + - agent + summary: Get Agent Entity Artifacts + description: |- + Get all artifacts for an entity (step, task, workflow_run). + + Args: + entity_type: Type of entity to fetch artifacts for + entity_id: ID of the entity + current_org: Current organization from auth + + Returns: + List of artifacts for the entity + + Raises: + HTTPException: If entity is not supported + operationId: >- + get_agent_entity_artifacts_api_v1__entity_type___entity_id__artifacts_get + parameters: + - name: entity_type + in: path + required: true + schema: + $ref: '#/components/schemas/EntityType' + - name: entity_id + in: path + required: true + schema: + type: string + title: Entity Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Artifact' + title: >- + Response Get Agent Entity Artifacts Api V1 Entity Type + Entity Id Artifacts Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/tasks/{task_id}/steps/{step_id}/artifacts: + get: + tags: + - agent + summary: Get Agent Task Step Artifacts + description: |- + Get all artifacts for a list of steps. + :param task_id: + :param step_id: + :return: List of artifacts for a list of steps. + operationId: >- + get_agent_task_step_artifacts_api_v1_tasks__task_id__steps__step_id__artifacts_get + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: step_id + in: path + required: true + schema: + type: string + title: Step Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Artifact' + title: >- + Response Get Agent Task Step Artifacts Api V1 Tasks Task Id + Steps Step Id Artifacts Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/tasks/{task_id}/actions: + get: + summary: Get Task Actions + operationId: get_task_actions_api_v1_tasks__task_id__actions_get + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Action' + title: Response Get Task Actions Api V1 Tasks Task Id Actions Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows/{workflow_id}/run: + post: + summary: Execute Workflow + operationId: execute_workflow_api_v1_workflows__workflow_id__run_post + parameters: + - name: workflow_id + in: path + required: true + schema: + type: string + title: Workflow Id + - name: version + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Version + - name: template + in: query + required: false + schema: + type: boolean + default: false + title: Template + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: x-max-steps-override + in: header + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: X-Max-Steps-Override + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/WorkflowRequestBody' + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/RunWorkflowResponse' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows/runs: + get: + summary: Get Workflow Runs + operationId: get_workflow_runs_api_v1_workflows_runs_get + parameters: + - name: page + in: query + required: false + schema: + type: integer + minimum: 1 + default: 1 + title: Page + - name: page_size + in: query + required: false + schema: + type: integer + minimum: 1 + default: 10 + title: Page Size + - name: status + in: query + required: false + schema: + anyOf: + - type: array + items: + $ref: '#/components/schemas/WorkflowRunStatus' + - type: 'null' + title: Status + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WorkflowRun' + title: Response Get Workflow Runs Api V1 Workflows Runs Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows/{workflow_permanent_id}/runs: + get: + summary: Get Workflow Runs For Workflow Permanent Id + operationId: >- + get_workflow_runs_for_workflow_permanent_id_api_v1_workflows__workflow_permanent_id__runs_get + parameters: + - name: workflow_permanent_id + in: path + required: true + schema: + type: string + title: Workflow Permanent Id + - name: page + in: query + required: false + schema: + type: integer + minimum: 1 + default: 1 + title: Page + - name: page_size + in: query + required: false + schema: + type: integer + minimum: 1 + default: 10 + title: Page Size + - name: status + in: query + required: false + schema: + anyOf: + - type: array + items: + $ref: '#/components/schemas/WorkflowRunStatus' + - type: 'null' + title: Status + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WorkflowRun' + title: >- + Response Get Workflow Runs For Workflow Permanent Id Api V1 + Workflows Workflow Permanent Id Runs Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows/{workflow_id}/runs/{workflow_run_id}: + get: + summary: Get Workflow Run + operationId: >- + get_workflow_run_api_v1_workflows__workflow_id__runs__workflow_run_id__get + parameters: + - name: workflow_id + in: path + required: true + schema: + type: string + title: Workflow Id + - name: workflow_run_id + in: path + required: true + schema: + type: string + title: Workflow Run Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: object + title: >- + Response Get Workflow Run Api V1 Workflows Workflow Id Runs + Workflow Run Id Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows/{workflow_id}/runs/{workflow_run_id}/timeline: + get: + summary: Get Workflow Run Timeline + operationId: >- + get_workflow_run_timeline_api_v1_workflows__workflow_id__runs__workflow_run_id__timeline_get + parameters: + - name: workflow_run_id + in: path + required: true + schema: + type: string + title: Workflow Run Id + - name: page + in: query + required: false + schema: + type: integer + minimum: 1 + default: 1 + title: Page + - name: page_size + in: query + required: false + schema: + type: integer + minimum: 1 + default: 20 + title: Page Size + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WorkflowRunTimeline' + title: >- + Response Get Workflow Run Timeline Api V1 Workflows Workflow + Id Runs Workflow Run Id Timeline Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows/runs/{workflow_run_id}: + get: + summary: Get Workflow Run By Run Id + operationId: get_workflow_run_by_run_id_api_v1_workflows_runs__workflow_run_id__get + parameters: + - name: workflow_run_id + in: path + required: true + schema: + type: string + title: Workflow Run Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkflowRunStatusResponse' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows: + post: + summary: Create Workflow + operationId: create_workflow_api_v1_workflows_post + parameters: + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/Workflow' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + requestBody: + content: + application/x-yaml: + schema: + $defs: + AWSSecretParameterYAML: + properties: + parameter_type: + const: aws_secret + default: aws_secret + enum: + - aws_secret + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + aws_key: + title: Aws Key + type: string + required: + - key + - aws_key + title: AWSSecretParameterYAML + type: object + ActionBlockYAML: + properties: + block_type: + const: action + default: action + enum: + - action + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + default: 0 + title: Max Retries + type: integer + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + complete_on_download: + default: false + title: Complete On Download + type: boolean + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + default: false + title: Cache Actions + type: boolean + required: + - label + title: ActionBlockYAML + type: object + BitwardenCreditCardDataParameterYAML: + properties: + parameter_type: + const: bitwarden_credit_card_data + default: bitwarden_credit_card_data + enum: + - bitwarden_credit_card_data + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + bitwarden_client_id_aws_secret_key: + title: Bitwarden Client Id Aws Secret Key + type: string + bitwarden_client_secret_aws_secret_key: + title: Bitwarden Client Secret Aws Secret Key + type: string + bitwarden_master_password_aws_secret_key: + title: Bitwarden Master Password Aws Secret Key + type: string + bitwarden_collection_id: + title: Bitwarden Collection Id + type: string + bitwarden_item_id: + title: Bitwarden Item Id + type: string + required: + - key + - bitwarden_client_id_aws_secret_key + - bitwarden_client_secret_aws_secret_key + - bitwarden_master_password_aws_secret_key + - bitwarden_collection_id + - bitwarden_item_id + title: BitwardenCreditCardDataParameterYAML + type: object + BitwardenLoginCredentialParameterYAML: + properties: + parameter_type: + const: bitwarden_login_credential + default: bitwarden_login_credential + enum: + - bitwarden_login_credential + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + bitwarden_client_id_aws_secret_key: + title: Bitwarden Client Id Aws Secret Key + type: string + bitwarden_client_secret_aws_secret_key: + title: Bitwarden Client Secret Aws Secret Key + type: string + bitwarden_master_password_aws_secret_key: + title: Bitwarden Master Password Aws Secret Key + type: string + url_parameter_key: + title: Url Parameter Key + type: string + bitwarden_collection_id: + anyOf: + - type: string + - type: 'null' + title: Bitwarden Collection Id + required: + - key + - bitwarden_client_id_aws_secret_key + - bitwarden_client_secret_aws_secret_key + - bitwarden_master_password_aws_secret_key + - url_parameter_key + title: BitwardenLoginCredentialParameterYAML + type: object + BitwardenSensitiveInformationParameterYAML: + properties: + parameter_type: + const: bitwarden_sensitive_information + default: bitwarden_sensitive_information + enum: + - bitwarden_sensitive_information + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + bitwarden_client_id_aws_secret_key: + title: Bitwarden Client Id Aws Secret Key + type: string + bitwarden_client_secret_aws_secret_key: + title: Bitwarden Client Secret Aws Secret Key + type: string + bitwarden_master_password_aws_secret_key: + title: Bitwarden Master Password Aws Secret Key + type: string + bitwarden_collection_id: + title: Bitwarden Collection Id + type: string + bitwarden_identity_key: + title: Bitwarden Identity Key + type: string + bitwarden_identity_fields: + items: + type: string + title: Bitwarden Identity Fields + type: array + required: + - key + - bitwarden_client_id_aws_secret_key + - bitwarden_client_secret_aws_secret_key + - bitwarden_master_password_aws_secret_key + - bitwarden_collection_id + - bitwarden_identity_key + - bitwarden_identity_fields + title: BitwardenSensitiveInformationParameterYAML + type: object + CodeBlockYAML: + properties: + block_type: + const: code + default: code + enum: + - code + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + code: + title: Code + type: string + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + required: + - label + - code + title: CodeBlockYAML + type: object + ContextParameterYAML: + properties: + parameter_type: + const: context + default: context + enum: + - context + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + source_parameter_key: + title: Source Parameter Key + type: string + required: + - key + - source_parameter_key + title: ContextParameterYAML + type: object + DownloadToS3BlockYAML: + properties: + block_type: + const: download_to_s3 + default: download_to_s3 + enum: + - download_to_s3 + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + url: + title: Url + type: string + required: + - label + - url + title: DownloadToS3BlockYAML + type: object + ExtractionBlockYAML: + properties: + block_type: + const: extraction + default: extraction + enum: + - extraction + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + data_extraction_goal: + title: Data Extraction Goal + type: string + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + max_retries: + default: 0 + title: Max Retries + type: integer + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + cache_actions: + default: false + title: Cache Actions + type: boolean + required: + - label + - data_extraction_goal + title: ExtractionBlockYAML + type: object + FileDownloadBlockYAML: + properties: + block_type: + const: file_download + default: file_download + enum: + - file_download + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + navigation_goal: + title: Navigation Goal + type: string + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + default: 0 + title: Max Retries + type: integer + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + default: false + title: Cache Actions + type: boolean + required: + - label + - navigation_goal + title: FileDownloadBlockYAML + type: object + FileParserBlockYAML: + properties: + block_type: + const: file_url_parser + default: file_url_parser + enum: + - file_url_parser + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + file_url: + title: File Url + type: string + file_type: + $ref: '#/$defs/FileType' + required: + - label + - file_url + - file_type + title: FileParserBlockYAML + type: object + FileType: + const: csv + enum: + - csv + title: FileType + type: string + ForLoopBlockYAML: + properties: + block_type: + const: for_loop + default: for_loop + enum: + - for_loop + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + loop_blocks: + items: + anyOf: + - $ref: '#/$defs/TaskBlockYAML' + - $ref: '#/$defs/ForLoopBlockYAML' + - $ref: '#/$defs/CodeBlockYAML' + - $ref: '#/$defs/TextPromptBlockYAML' + - $ref: '#/$defs/DownloadToS3BlockYAML' + - $ref: '#/$defs/UploadToS3BlockYAML' + - $ref: '#/$defs/SendEmailBlockYAML' + - $ref: '#/$defs/FileParserBlockYAML' + - $ref: '#/$defs/ValidationBlockYAML' + - $ref: '#/$defs/ActionBlockYAML' + - $ref: '#/$defs/NavigationBlockYAML' + - $ref: '#/$defs/ExtractionBlockYAML' + - $ref: '#/$defs/LoginBlockYAML' + - $ref: '#/$defs/WaitBlockYAML' + - $ref: '#/$defs/FileDownloadBlockYAML' + - $ref: '#/$defs/UrlBlockYAML' + - $ref: '#/$defs/PDFParserBlockYAML' + - $ref: '#/$defs/TaskV2BlockYAML' + title: Loop Blocks + type: array + loop_over_parameter_key: + default: '' + title: Loop Over Parameter Key + type: string + loop_variable_reference: + anyOf: + - type: string + - type: 'null' + title: Loop Variable Reference + complete_if_empty: + default: false + title: Complete If Empty + type: boolean + required: + - label + - loop_blocks + title: ForLoopBlockYAML + type: object + LoginBlockYAML: + properties: + block_type: + const: login + default: login + enum: + - login + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + default: 0 + title: Max Retries + type: integer + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + default: false + title: Cache Actions + type: boolean + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + required: + - label + title: LoginBlockYAML + type: object + NavigationBlockYAML: + properties: + block_type: + const: navigation + default: navigation + enum: + - navigation + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + navigation_goal: + title: Navigation Goal + type: string + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + default: 0 + title: Max Retries + type: integer + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + complete_on_download: + default: false + title: Complete On Download + type: boolean + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + default: false + title: Cache Actions + type: boolean + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + required: + - label + - navigation_goal + title: NavigationBlockYAML + type: object + OutputParameterYAML: + properties: + parameter_type: + const: output + default: output + enum: + - output + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + required: + - key + title: OutputParameterYAML + type: object + PDFParserBlockYAML: + properties: + block_type: + const: pdf_parser + default: pdf_parser + enum: + - pdf_parser + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + file_url: + title: File Url + type: string + json_schema: + anyOf: + - type: object + - type: 'null' + title: Json Schema + required: + - label + - file_url + title: PDFParserBlockYAML + type: object + ProxyLocation: + enum: + - US-CA + - US-NY + - US-TX + - US-FL + - US-WA + - RESIDENTIAL + - RESIDENTIAL_ES + - RESIDENTIAL_IE + - RESIDENTIAL_GB + - RESIDENTIAL_IN + - RESIDENTIAL_JP + - RESIDENTIAL_FR + - NONE + title: ProxyLocation + type: string + SendEmailBlockYAML: + properties: + block_type: + const: send_email + default: send_email + enum: + - send_email + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + smtp_host_secret_parameter_key: + title: Smtp Host Secret Parameter Key + type: string + smtp_port_secret_parameter_key: + title: Smtp Port Secret Parameter Key + type: string + smtp_username_secret_parameter_key: + title: Smtp Username Secret Parameter Key + type: string + smtp_password_secret_parameter_key: + title: Smtp Password Secret Parameter Key + type: string + sender: + title: Sender + type: string + recipients: + items: + type: string + title: Recipients + type: array + subject: + title: Subject + type: string + body: + title: Body + type: string + file_attachments: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: File Attachments + required: + - label + - smtp_host_secret_parameter_key + - smtp_port_secret_parameter_key + - smtp_username_secret_parameter_key + - smtp_password_secret_parameter_key + - sender + - recipients + - subject + - body + title: SendEmailBlockYAML + type: object + TaskBlockYAML: + properties: + block_type: + const: task + default: task + enum: + - task + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + default: 0 + title: Max Retries + type: integer + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + complete_on_download: + default: false + title: Complete On Download + type: boolean + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + default: false + title: Cache Actions + type: boolean + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + required: + - label + title: TaskBlockYAML + type: object + TaskV2BlockYAML: + properties: + block_type: + const: task_v2 + default: task_v2 + enum: + - task_v2 + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + prompt: + title: Prompt + type: string + url: + anyOf: + - type: string + - type: 'null' + title: Url + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + max_iterations: + default: 10 + title: Max Iterations + type: integer + required: + - label + - prompt + title: TaskV2BlockYAML + type: object + TextPromptBlockYAML: + properties: + block_type: + const: text_prompt + default: text_prompt + enum: + - text_prompt + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + llm_key: + default: OPENAI_GPT4O_MINI + title: Llm Key + type: string + prompt: + title: Prompt + type: string + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + json_schema: + anyOf: + - type: object + - type: 'null' + title: Json Schema + required: + - label + - prompt + title: TextPromptBlockYAML + type: object + UploadToS3BlockYAML: + properties: + block_type: + const: upload_to_s3 + default: upload_to_s3 + enum: + - upload_to_s3 + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + path: + anyOf: + - type: string + - type: 'null' + title: Path + required: + - label + title: UploadToS3BlockYAML + type: object + UrlBlockYAML: + properties: + block_type: + const: goto_url + default: goto_url + enum: + - goto_url + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + url: + title: Url + type: string + required: + - label + - url + title: UrlBlockYAML + type: object + ValidationBlockYAML: + properties: + block_type: + const: validation + default: validation + enum: + - validation + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + required: + - label + title: ValidationBlockYAML + type: object + WaitBlockYAML: + properties: + block_type: + const: wait + default: wait + enum: + - wait + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + wait_sec: + default: 0 + title: Wait Sec + type: integer + required: + - label + title: WaitBlockYAML + type: object + WorkflowDefinitionYAML: + properties: + parameters: + items: + discriminator: + mapping: + aws_secret: '#/$defs/AWSSecretParameterYAML' + bitwarden_credit_card_data: '#/$defs/BitwardenCreditCardDataParameterYAML' + bitwarden_login_credential: '#/$defs/BitwardenLoginCredentialParameterYAML' + bitwarden_sensitive_information: '#/$defs/BitwardenSensitiveInformationParameterYAML' + context: '#/$defs/ContextParameterYAML' + output: '#/$defs/OutputParameterYAML' + workflow: '#/$defs/WorkflowParameterYAML' + propertyName: parameter_type + oneOf: + - $ref: '#/$defs/AWSSecretParameterYAML' + - $ref: '#/$defs/BitwardenLoginCredentialParameterYAML' + - $ref: '#/$defs/BitwardenSensitiveInformationParameterYAML' + - $ref: '#/$defs/BitwardenCreditCardDataParameterYAML' + - $ref: '#/$defs/WorkflowParameterYAML' + - $ref: '#/$defs/ContextParameterYAML' + - $ref: '#/$defs/OutputParameterYAML' + title: Parameters + type: array + blocks: + items: + discriminator: + mapping: + action: '#/$defs/ActionBlockYAML' + code: '#/$defs/CodeBlockYAML' + download_to_s3: '#/$defs/DownloadToS3BlockYAML' + extraction: '#/$defs/ExtractionBlockYAML' + file_download: '#/$defs/FileDownloadBlockYAML' + file_url_parser: '#/$defs/FileParserBlockYAML' + for_loop: '#/$defs/ForLoopBlockYAML' + goto_url: '#/$defs/UrlBlockYAML' + login: '#/$defs/LoginBlockYAML' + navigation: '#/$defs/NavigationBlockYAML' + pdf_parser: '#/$defs/PDFParserBlockYAML' + send_email: '#/$defs/SendEmailBlockYAML' + task: '#/$defs/TaskBlockYAML' + task_v2: '#/$defs/TaskV2BlockYAML' + text_prompt: '#/$defs/TextPromptBlockYAML' + upload_to_s3: '#/$defs/UploadToS3BlockYAML' + validation: '#/$defs/ValidationBlockYAML' + wait: '#/$defs/WaitBlockYAML' + propertyName: block_type + oneOf: + - $ref: '#/$defs/TaskBlockYAML' + - $ref: '#/$defs/ForLoopBlockYAML' + - $ref: '#/$defs/CodeBlockYAML' + - $ref: '#/$defs/TextPromptBlockYAML' + - $ref: '#/$defs/DownloadToS3BlockYAML' + - $ref: '#/$defs/UploadToS3BlockYAML' + - $ref: '#/$defs/SendEmailBlockYAML' + - $ref: '#/$defs/FileParserBlockYAML' + - $ref: '#/$defs/ValidationBlockYAML' + - $ref: '#/$defs/ActionBlockYAML' + - $ref: '#/$defs/NavigationBlockYAML' + - $ref: '#/$defs/ExtractionBlockYAML' + - $ref: '#/$defs/LoginBlockYAML' + - $ref: '#/$defs/WaitBlockYAML' + - $ref: '#/$defs/FileDownloadBlockYAML' + - $ref: '#/$defs/UrlBlockYAML' + - $ref: '#/$defs/PDFParserBlockYAML' + - $ref: '#/$defs/TaskV2BlockYAML' + title: Blocks + type: array + required: + - parameters + - blocks + title: WorkflowDefinitionYAML + type: object + WorkflowParameterType: + enum: + - string + - integer + - float + - boolean + - json + - file_url + title: WorkflowParameterType + type: string + WorkflowParameterYAML: + properties: + parameter_type: + const: workflow + default: workflow + enum: + - workflow + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + workflow_parameter_type: + $ref: '#/$defs/WorkflowParameterType' + default_value: + anyOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: object + - items: {} + type: array + - type: 'null' + title: Default Value + required: + - key + - workflow_parameter_type + title: WorkflowParameterYAML + type: object + WorkflowStatus: + enum: + - published + - draft + - auto_generated + title: WorkflowStatus + type: string + properties: + title: + title: Title + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + proxy_location: + anyOf: + - $ref: '#/$defs/ProxyLocation' + - type: 'null' + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + persist_browser_session: + default: false + title: Persist Browser Session + type: boolean + workflow_definition: + $ref: '#/$defs/WorkflowDefinitionYAML' + is_saved_task: + default: false + title: Is Saved Task + type: boolean + status: + $ref: '#/$defs/WorkflowStatus' + default: published + required: + - title + - workflow_definition + title: WorkflowCreateYAMLRequest + type: object + required: true + get: + summary: Get Workflows + description: Get all workflows with the latest version for the organization. + operationId: get_workflows_api_v1_workflows_get + parameters: + - name: page + in: query + required: false + schema: + type: integer + minimum: 1 + default: 1 + title: Page + - name: page_size + in: query + required: false + schema: + type: integer + minimum: 1 + default: 10 + title: Page Size + - name: only_saved_tasks + in: query + required: false + schema: + type: boolean + default: false + title: Only Saved Tasks + - name: only_workflows + in: query + required: false + schema: + type: boolean + default: false + title: Only Workflows + - name: title + in: query + required: false + schema: + type: string + default: '' + title: Title + - name: template + in: query + required: false + schema: + type: boolean + default: false + title: Template + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Workflow' + title: Response Get Workflows Api V1 Workflows Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows/{workflow_permanent_id}: + put: + summary: Update Workflow + operationId: update_workflow_api_v1_workflows__workflow_permanent_id__put + parameters: + - name: workflow_permanent_id + in: path + required: true + schema: + type: string + title: Workflow Permanent Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/Workflow' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + requestBody: + content: + application/x-yaml: + schema: + $defs: + AWSSecretParameterYAML: + properties: + parameter_type: + const: aws_secret + default: aws_secret + enum: + - aws_secret + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + aws_key: + title: Aws Key + type: string + required: + - key + - aws_key + title: AWSSecretParameterYAML + type: object + ActionBlockYAML: + properties: + block_type: + const: action + default: action + enum: + - action + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + default: 0 + title: Max Retries + type: integer + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + complete_on_download: + default: false + title: Complete On Download + type: boolean + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + default: false + title: Cache Actions + type: boolean + required: + - label + title: ActionBlockYAML + type: object + BitwardenCreditCardDataParameterYAML: + properties: + parameter_type: + const: bitwarden_credit_card_data + default: bitwarden_credit_card_data + enum: + - bitwarden_credit_card_data + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + bitwarden_client_id_aws_secret_key: + title: Bitwarden Client Id Aws Secret Key + type: string + bitwarden_client_secret_aws_secret_key: + title: Bitwarden Client Secret Aws Secret Key + type: string + bitwarden_master_password_aws_secret_key: + title: Bitwarden Master Password Aws Secret Key + type: string + bitwarden_collection_id: + title: Bitwarden Collection Id + type: string + bitwarden_item_id: + title: Bitwarden Item Id + type: string + required: + - key + - bitwarden_client_id_aws_secret_key + - bitwarden_client_secret_aws_secret_key + - bitwarden_master_password_aws_secret_key + - bitwarden_collection_id + - bitwarden_item_id + title: BitwardenCreditCardDataParameterYAML + type: object + BitwardenLoginCredentialParameterYAML: + properties: + parameter_type: + const: bitwarden_login_credential + default: bitwarden_login_credential + enum: + - bitwarden_login_credential + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + bitwarden_client_id_aws_secret_key: + title: Bitwarden Client Id Aws Secret Key + type: string + bitwarden_client_secret_aws_secret_key: + title: Bitwarden Client Secret Aws Secret Key + type: string + bitwarden_master_password_aws_secret_key: + title: Bitwarden Master Password Aws Secret Key + type: string + url_parameter_key: + title: Url Parameter Key + type: string + bitwarden_collection_id: + anyOf: + - type: string + - type: 'null' + title: Bitwarden Collection Id + required: + - key + - bitwarden_client_id_aws_secret_key + - bitwarden_client_secret_aws_secret_key + - bitwarden_master_password_aws_secret_key + - url_parameter_key + title: BitwardenLoginCredentialParameterYAML + type: object + BitwardenSensitiveInformationParameterYAML: + properties: + parameter_type: + const: bitwarden_sensitive_information + default: bitwarden_sensitive_information + enum: + - bitwarden_sensitive_information + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + bitwarden_client_id_aws_secret_key: + title: Bitwarden Client Id Aws Secret Key + type: string + bitwarden_client_secret_aws_secret_key: + title: Bitwarden Client Secret Aws Secret Key + type: string + bitwarden_master_password_aws_secret_key: + title: Bitwarden Master Password Aws Secret Key + type: string + bitwarden_collection_id: + title: Bitwarden Collection Id + type: string + bitwarden_identity_key: + title: Bitwarden Identity Key + type: string + bitwarden_identity_fields: + items: + type: string + title: Bitwarden Identity Fields + type: array + required: + - key + - bitwarden_client_id_aws_secret_key + - bitwarden_client_secret_aws_secret_key + - bitwarden_master_password_aws_secret_key + - bitwarden_collection_id + - bitwarden_identity_key + - bitwarden_identity_fields + title: BitwardenSensitiveInformationParameterYAML + type: object + CodeBlockYAML: + properties: + block_type: + const: code + default: code + enum: + - code + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + code: + title: Code + type: string + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + required: + - label + - code + title: CodeBlockYAML + type: object + ContextParameterYAML: + properties: + parameter_type: + const: context + default: context + enum: + - context + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + source_parameter_key: + title: Source Parameter Key + type: string + required: + - key + - source_parameter_key + title: ContextParameterYAML + type: object + DownloadToS3BlockYAML: + properties: + block_type: + const: download_to_s3 + default: download_to_s3 + enum: + - download_to_s3 + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + url: + title: Url + type: string + required: + - label + - url + title: DownloadToS3BlockYAML + type: object + ExtractionBlockYAML: + properties: + block_type: + const: extraction + default: extraction + enum: + - extraction + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + data_extraction_goal: + title: Data Extraction Goal + type: string + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + max_retries: + default: 0 + title: Max Retries + type: integer + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + cache_actions: + default: false + title: Cache Actions + type: boolean + required: + - label + - data_extraction_goal + title: ExtractionBlockYAML + type: object + FileDownloadBlockYAML: + properties: + block_type: + const: file_download + default: file_download + enum: + - file_download + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + navigation_goal: + title: Navigation Goal + type: string + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + default: 0 + title: Max Retries + type: integer + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + default: false + title: Cache Actions + type: boolean + required: + - label + - navigation_goal + title: FileDownloadBlockYAML + type: object + FileParserBlockYAML: + properties: + block_type: + const: file_url_parser + default: file_url_parser + enum: + - file_url_parser + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + file_url: + title: File Url + type: string + file_type: + $ref: '#/$defs/FileType' + required: + - label + - file_url + - file_type + title: FileParserBlockYAML + type: object + FileType: + const: csv + enum: + - csv + title: FileType + type: string + ForLoopBlockYAML: + properties: + block_type: + const: for_loop + default: for_loop + enum: + - for_loop + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + loop_blocks: + items: + anyOf: + - $ref: '#/$defs/TaskBlockYAML' + - $ref: '#/$defs/ForLoopBlockYAML' + - $ref: '#/$defs/CodeBlockYAML' + - $ref: '#/$defs/TextPromptBlockYAML' + - $ref: '#/$defs/DownloadToS3BlockYAML' + - $ref: '#/$defs/UploadToS3BlockYAML' + - $ref: '#/$defs/SendEmailBlockYAML' + - $ref: '#/$defs/FileParserBlockYAML' + - $ref: '#/$defs/ValidationBlockYAML' + - $ref: '#/$defs/ActionBlockYAML' + - $ref: '#/$defs/NavigationBlockYAML' + - $ref: '#/$defs/ExtractionBlockYAML' + - $ref: '#/$defs/LoginBlockYAML' + - $ref: '#/$defs/WaitBlockYAML' + - $ref: '#/$defs/FileDownloadBlockYAML' + - $ref: '#/$defs/UrlBlockYAML' + - $ref: '#/$defs/PDFParserBlockYAML' + - $ref: '#/$defs/TaskV2BlockYAML' + title: Loop Blocks + type: array + loop_over_parameter_key: + default: '' + title: Loop Over Parameter Key + type: string + loop_variable_reference: + anyOf: + - type: string + - type: 'null' + title: Loop Variable Reference + complete_if_empty: + default: false + title: Complete If Empty + type: boolean + required: + - label + - loop_blocks + title: ForLoopBlockYAML + type: object + LoginBlockYAML: + properties: + block_type: + const: login + default: login + enum: + - login + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + default: 0 + title: Max Retries + type: integer + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + default: false + title: Cache Actions + type: boolean + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + required: + - label + title: LoginBlockYAML + type: object + NavigationBlockYAML: + properties: + block_type: + const: navigation + default: navigation + enum: + - navigation + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + navigation_goal: + title: Navigation Goal + type: string + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + default: 0 + title: Max Retries + type: integer + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + complete_on_download: + default: false + title: Complete On Download + type: boolean + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + default: false + title: Cache Actions + type: boolean + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + required: + - label + - navigation_goal + title: NavigationBlockYAML + type: object + OutputParameterYAML: + properties: + parameter_type: + const: output + default: output + enum: + - output + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + required: + - key + title: OutputParameterYAML + type: object + PDFParserBlockYAML: + properties: + block_type: + const: pdf_parser + default: pdf_parser + enum: + - pdf_parser + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + file_url: + title: File Url + type: string + json_schema: + anyOf: + - type: object + - type: 'null' + title: Json Schema + required: + - label + - file_url + title: PDFParserBlockYAML + type: object + ProxyLocation: + enum: + - US-CA + - US-NY + - US-TX + - US-FL + - US-WA + - RESIDENTIAL + - RESIDENTIAL_ES + - RESIDENTIAL_IE + - RESIDENTIAL_GB + - RESIDENTIAL_IN + - RESIDENTIAL_JP + - RESIDENTIAL_FR + - NONE + title: ProxyLocation + type: string + SendEmailBlockYAML: + properties: + block_type: + const: send_email + default: send_email + enum: + - send_email + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + smtp_host_secret_parameter_key: + title: Smtp Host Secret Parameter Key + type: string + smtp_port_secret_parameter_key: + title: Smtp Port Secret Parameter Key + type: string + smtp_username_secret_parameter_key: + title: Smtp Username Secret Parameter Key + type: string + smtp_password_secret_parameter_key: + title: Smtp Password Secret Parameter Key + type: string + sender: + title: Sender + type: string + recipients: + items: + type: string + title: Recipients + type: array + subject: + title: Subject + type: string + body: + title: Body + type: string + file_attachments: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: File Attachments + required: + - label + - smtp_host_secret_parameter_key + - smtp_port_secret_parameter_key + - smtp_username_secret_parameter_key + - smtp_password_secret_parameter_key + - sender + - recipients + - subject + - body + title: SendEmailBlockYAML + type: object + TaskBlockYAML: + properties: + block_type: + const: task + default: task + enum: + - task + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + default: '' + title: Title + type: string + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + default: 0 + title: Max Retries + type: integer + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + complete_on_download: + default: false + title: Complete On Download + type: boolean + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + default: false + title: Cache Actions + type: boolean + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + required: + - label + title: TaskBlockYAML + type: object + TaskV2BlockYAML: + properties: + block_type: + const: task_v2 + default: task_v2 + enum: + - task_v2 + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + prompt: + title: Prompt + type: string + url: + anyOf: + - type: string + - type: 'null' + title: Url + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + max_iterations: + default: 10 + title: Max Iterations + type: integer + required: + - label + - prompt + title: TaskV2BlockYAML + type: object + TextPromptBlockYAML: + properties: + block_type: + const: text_prompt + default: text_prompt + enum: + - text_prompt + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + llm_key: + default: OPENAI_GPT4O_MINI + title: Llm Key + type: string + prompt: + title: Prompt + type: string + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + json_schema: + anyOf: + - type: object + - type: 'null' + title: Json Schema + required: + - label + - prompt + title: TextPromptBlockYAML + type: object + UploadToS3BlockYAML: + properties: + block_type: + const: upload_to_s3 + default: upload_to_s3 + enum: + - upload_to_s3 + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + path: + anyOf: + - type: string + - type: 'null' + title: Path + required: + - label + title: UploadToS3BlockYAML + type: object + UrlBlockYAML: + properties: + block_type: + const: goto_url + default: goto_url + enum: + - goto_url + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + url: + title: Url + type: string + required: + - label + - url + title: UrlBlockYAML + type: object + ValidationBlockYAML: + properties: + block_type: + const: validation + default: validation + enum: + - validation + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + parameter_keys: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Parameter Keys + required: + - label + title: ValidationBlockYAML + type: object + WaitBlockYAML: + properties: + block_type: + const: wait + default: wait + enum: + - wait + title: Block Type + type: string + label: + title: Label + type: string + continue_on_failure: + default: false + title: Continue On Failure + type: boolean + wait_sec: + default: 0 + title: Wait Sec + type: integer + required: + - label + title: WaitBlockYAML + type: object + WorkflowDefinitionYAML: + properties: + parameters: + items: + discriminator: + mapping: + aws_secret: '#/$defs/AWSSecretParameterYAML' + bitwarden_credit_card_data: '#/$defs/BitwardenCreditCardDataParameterYAML' + bitwarden_login_credential: '#/$defs/BitwardenLoginCredentialParameterYAML' + bitwarden_sensitive_information: '#/$defs/BitwardenSensitiveInformationParameterYAML' + context: '#/$defs/ContextParameterYAML' + output: '#/$defs/OutputParameterYAML' + workflow: '#/$defs/WorkflowParameterYAML' + propertyName: parameter_type + oneOf: + - $ref: '#/$defs/AWSSecretParameterYAML' + - $ref: '#/$defs/BitwardenLoginCredentialParameterYAML' + - $ref: '#/$defs/BitwardenSensitiveInformationParameterYAML' + - $ref: '#/$defs/BitwardenCreditCardDataParameterYAML' + - $ref: '#/$defs/WorkflowParameterYAML' + - $ref: '#/$defs/ContextParameterYAML' + - $ref: '#/$defs/OutputParameterYAML' + title: Parameters + type: array + blocks: + items: + discriminator: + mapping: + action: '#/$defs/ActionBlockYAML' + code: '#/$defs/CodeBlockYAML' + download_to_s3: '#/$defs/DownloadToS3BlockYAML' + extraction: '#/$defs/ExtractionBlockYAML' + file_download: '#/$defs/FileDownloadBlockYAML' + file_url_parser: '#/$defs/FileParserBlockYAML' + for_loop: '#/$defs/ForLoopBlockYAML' + goto_url: '#/$defs/UrlBlockYAML' + login: '#/$defs/LoginBlockYAML' + navigation: '#/$defs/NavigationBlockYAML' + pdf_parser: '#/$defs/PDFParserBlockYAML' + send_email: '#/$defs/SendEmailBlockYAML' + task: '#/$defs/TaskBlockYAML' + task_v2: '#/$defs/TaskV2BlockYAML' + text_prompt: '#/$defs/TextPromptBlockYAML' + upload_to_s3: '#/$defs/UploadToS3BlockYAML' + validation: '#/$defs/ValidationBlockYAML' + wait: '#/$defs/WaitBlockYAML' + propertyName: block_type + oneOf: + - $ref: '#/$defs/TaskBlockYAML' + - $ref: '#/$defs/ForLoopBlockYAML' + - $ref: '#/$defs/CodeBlockYAML' + - $ref: '#/$defs/TextPromptBlockYAML' + - $ref: '#/$defs/DownloadToS3BlockYAML' + - $ref: '#/$defs/UploadToS3BlockYAML' + - $ref: '#/$defs/SendEmailBlockYAML' + - $ref: '#/$defs/FileParserBlockYAML' + - $ref: '#/$defs/ValidationBlockYAML' + - $ref: '#/$defs/ActionBlockYAML' + - $ref: '#/$defs/NavigationBlockYAML' + - $ref: '#/$defs/ExtractionBlockYAML' + - $ref: '#/$defs/LoginBlockYAML' + - $ref: '#/$defs/WaitBlockYAML' + - $ref: '#/$defs/FileDownloadBlockYAML' + - $ref: '#/$defs/UrlBlockYAML' + - $ref: '#/$defs/PDFParserBlockYAML' + - $ref: '#/$defs/TaskV2BlockYAML' + title: Blocks + type: array + required: + - parameters + - blocks + title: WorkflowDefinitionYAML + type: object + WorkflowParameterType: + enum: + - string + - integer + - float + - boolean + - json + - file_url + title: WorkflowParameterType + type: string + WorkflowParameterYAML: + properties: + parameter_type: + const: workflow + default: workflow + enum: + - workflow + title: Parameter Type + type: string + key: + title: Key + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + workflow_parameter_type: + $ref: '#/$defs/WorkflowParameterType' + default_value: + anyOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: object + - items: {} + type: array + - type: 'null' + title: Default Value + required: + - key + - workflow_parameter_type + title: WorkflowParameterYAML + type: object + WorkflowStatus: + enum: + - published + - draft + - auto_generated + title: WorkflowStatus + type: string + properties: + title: + title: Title + type: string + description: + anyOf: + - type: string + - type: 'null' + title: Description + proxy_location: + anyOf: + - $ref: '#/$defs/ProxyLocation' + - type: 'null' + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + persist_browser_session: + default: false + title: Persist Browser Session + type: boolean + workflow_definition: + $ref: '#/$defs/WorkflowDefinitionYAML' + is_saved_task: + default: false + title: Is Saved Task + type: boolean + status: + $ref: '#/$defs/WorkflowStatus' + default: published + required: + - title + - workflow_definition + title: WorkflowCreateYAMLRequest + type: object + required: true + delete: + summary: Delete Workflow + operationId: delete_workflow_api_v1_workflows__workflow_permanent_id__delete + parameters: + - name: workflow_permanent_id + in: path + required: true + schema: + type: string + title: Workflow Permanent Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + get: + summary: Get Workflow + operationId: get_workflow_api_v1_workflows__workflow_permanent_id__get + parameters: + - name: workflow_permanent_id + in: path + required: true + schema: + type: string + title: Workflow Permanent Id + - name: version + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Version + - name: template + in: query + required: false + schema: + type: boolean + default: false + title: Template + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/Workflow' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows/: + get: + summary: Get Workflows + description: Get all workflows with the latest version for the organization. + operationId: get_workflows_api_v1_workflows__get + parameters: + - name: page + in: query + required: false + schema: + type: integer + minimum: 1 + default: 1 + title: Page + - name: page_size + in: query + required: false + schema: + type: integer + minimum: 1 + default: 10 + title: Page Size + - name: only_saved_tasks + in: query + required: false + schema: + type: boolean + default: false + title: Only Saved Tasks + - name: only_workflows + in: query + required: false + schema: + type: boolean + default: false + title: Only Workflows + - name: title + in: query + required: false + schema: + type: string + default: '' + title: Title + - name: template + in: query + required: false + schema: + type: boolean + default: false + title: Template + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Workflow' + title: Response Get Workflows Api V1 Workflows Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/workflows/{workflow_permanent_id}/: + get: + summary: Get Workflow + operationId: get_workflow_api_v1_workflows__workflow_permanent_id___get + parameters: + - name: workflow_permanent_id + in: path + required: true + schema: + type: string + title: Workflow Permanent Id + - name: version + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Version + - name: template + in: query + required: false + schema: + type: boolean + default: false + title: Template + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/Workflow' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/suggest/{ai_suggestion_type}/: + post: + summary: Make Ai Suggestion + operationId: make_ai_suggestion_api_v1_suggest__ai_suggestion_type___post + parameters: + - name: ai_suggestion_type + in: path + required: true + schema: + $ref: '#/components/schemas/AISuggestionType' + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AISuggestionRequest' + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/AISuggestionBase' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/generate/task/: + post: + summary: Generate Task + operationId: generate_task_api_v1_generate_task__post + parameters: + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GenerateTaskRequest' + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/TaskGeneration' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/organizations: + put: + summary: Update Organization + operationId: update_organization_api_v1_organizations_put + parameters: + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OrganizationUpdate' + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/Organization' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + get: + summary: Get Organizations + operationId: get_organizations_api_v1_organizations_get + parameters: + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrganizationsResponse' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/organizations/{organization_id}/apikeys: + get: + summary: Get Org Api Keys + operationId: get_org_api_keys_api_v1_organizations__organization_id__apikeys_get + parameters: + - name: organization_id + in: path + required: true + schema: + type: string + title: Organization Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrganizationAPIKeysResponse' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/upload_file: + post: + summary: Upload File + operationId: upload_file_api_v1_upload_file_post + parameters: + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/Body_upload_file_api_v1_upload_file_post' + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/browser_sessions/{browser_session_id}: + get: + summary: Get Browser Session By Id + operationId: >- + get_browser_session_by_id_api_v1_browser_sessions__browser_session_id__get + parameters: + - name: browser_session_id + in: path + required: true + schema: + type: string + title: Browser Session Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/BrowserSessionResponse' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/browser_sessions: + get: + summary: Get Browser Sessions + description: Get all active browser sessions for the organization + operationId: get_browser_sessions_api_v1_browser_sessions_get + parameters: + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BrowserSessionResponse' + title: Response Get Browser Sessions Api V1 Browser Sessions Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + post: + summary: Create Browser Session + operationId: create_browser_session_api_v1_browser_sessions_post + parameters: + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/BrowserSessionResponse' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/browser_sessions/close: + post: + summary: Close Browser Sessions + operationId: close_browser_sessions_api_v1_browser_sessions_close_post + parameters: + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/browser_sessions/{session_id}/close: + post: + summary: Close Browser Session + operationId: close_browser_session_api_v1_browser_sessions__session_id__close_post + parameters: + - name: session_id + in: path + required: true + schema: + type: string + title: Session Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: {} + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v2/tasks: + post: + summary: Observer Task + operationId: observer_task_api_v2_tasks_post + parameters: + - name: x-max-iterations-override + in: header + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: X-Max-Iterations-Override + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ObserverTaskRequest' + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: object + title: Response Observer Task Api V2 Tasks Post + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v2/tasks/{task_id}: + get: + summary: Get Observer Task + operationId: get_observer_task_api_v2_tasks__task_id__get + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: object + title: Response Get Observer Task Api V2 Tasks Task Id Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/totp: + post: + summary: Save Totp Code + operationId: save_totp_code_api_v1_totp_post + parameters: + - name: x-api-key + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: X-Api-Key + - name: authorization + in: header + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Authorization + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TOTPCodeCreate' + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/TOTPCode' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/workflows/runs: + get: + summary: Get Workflow Runs + operationId: get_workflow_runs_api_v1_eval_workflows_runs_get + parameters: + - name: page + in: query + required: false + schema: + type: integer + minimum: 1 + default: 1 + title: Page + - name: page_size + in: query + required: false + schema: + type: integer + minimum: 1 + default: 10 + title: Page Size + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WorkflowRun' + title: Response Get Workflow Runs Api V1 Eval Workflows Runs Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/workflows/{workflow_id}/runs/{workflow_run_id}: + get: + summary: Get Workflow Run + operationId: >- + get_workflow_run_api_v1_eval_workflows__workflow_id__runs__workflow_run_id__get + parameters: + - name: workflow_id + in: path + required: true + schema: + type: string + title: Workflow Id + - name: workflow_run_id + in: path + required: true + schema: + type: string + title: Workflow Run Id + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: object + title: >- + Response Get Workflow Run Api V1 Eval Workflows Workflow Id + Runs Workflow Run Id Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/workflows/{workflow_id}/runs/{workflow_run_id}/timeline/: + get: + summary: Get Workflow Run Timeline + operationId: >- + get_workflow_run_timeline_api_v1_eval_workflows__workflow_id__runs__workflow_run_id__timeline__get + parameters: + - name: workflow_run_id + in: path + required: true + schema: + type: string + title: Workflow Run Id + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WorkflowRunTimeline' + title: >- + Response Get Workflow Run Timeline Api V1 Eval Workflows + Workflow Id Runs Workflow Run Id Timeline Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/workflows/{workflow_id}/runs/{workflow_run_id}/timeline: + get: + summary: Get Workflow Run Timeline + operationId: >- + get_workflow_run_timeline_api_v1_eval_workflows__workflow_id__runs__workflow_run_id__timeline_get + parameters: + - name: workflow_run_id + in: path + required: true + schema: + type: string + title: Workflow Run Id + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WorkflowRunTimeline' + title: >- + Response Get Workflow Run Timeline Api V1 Eval Workflows + Workflow Id Runs Workflow Run Id Timeline Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/workflows/runs/{workflow_run_id}: + get: + summary: Get Workflow Run By Run Id + operationId: >- + get_workflow_run_by_run_id_api_v1_eval_workflows_runs__workflow_run_id__get + parameters: + - name: workflow_run_id + in: path + required: true + schema: + type: string + title: Workflow Run Id + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkflowRunStatusResponse' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/workflows/{workflow_permanent_id}/: + get: + summary: Get Workflow + operationId: get_workflow_api_v1_eval_workflows__workflow_permanent_id___get + parameters: + - name: workflow_permanent_id + in: path + required: true + schema: + type: string + title: Workflow Permanent Id + - name: version + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Version + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/Workflow' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/workflows/{workflow_permanent_id}: + get: + summary: Get Workflow + operationId: get_workflow_api_v1_eval_workflows__workflow_permanent_id__get + parameters: + - name: workflow_permanent_id + in: path + required: true + schema: + type: string + title: Workflow Permanent Id + - name: version + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Version + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/Workflow' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/workflows/{workflow_permanent_id}/runs: + get: + summary: Get Workflow Runs For Workflow Permanent Id + operationId: >- + get_workflow_runs_for_workflow_permanent_id_api_v1_eval_workflows__workflow_permanent_id__runs_get + parameters: + - name: workflow_permanent_id + in: path + required: true + schema: + type: string + title: Workflow Permanent Id + - name: page + in: query + required: false + schema: + type: integer + minimum: 1 + default: 1 + title: Page + - name: page_size + in: query + required: false + schema: + type: integer + minimum: 1 + default: 10 + title: Page Size + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WorkflowRun' + title: >- + Response Get Workflow Runs For Workflow Permanent Id Api V1 + Eval Workflows Workflow Permanent Id Runs Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/{entity_type}/{entity_id}/artifacts: + get: + tags: + - agent + summary: Get Agent Entity Artifacts + description: |- + Get all artifacts for an entity (step, task, workflow_run). + + Args: + entity_type: Type of entity to fetch artifacts for + entity_id: ID of the entity + current_org: Current organization from auth + + Returns: + List of artifacts for the entity + + Raises: + HTTPException: If entity is not supported + operationId: >- + get_agent_entity_artifacts_api_v1_eval__entity_type___entity_id__artifacts_get + parameters: + - name: entity_type + in: path + required: true + schema: + $ref: '#/components/schemas/EntityType' + - name: entity_id + in: path + required: true + schema: + type: string + title: Entity Id + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Artifact' + title: >- + Response Get Agent Entity Artifacts Api V1 Eval Entity Type + Entity Id Artifacts Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/tasks/{task_id}/actions: + get: + summary: Get Task Actions + operationId: get_task_actions_api_v1_eval_tasks__task_id__actions_get + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Action' + title: >- + Response Get Task Actions Api V1 Eval Tasks Task Id Actions + Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/tasks/{task_id}/steps/{step_id}/artifacts: + get: + tags: + - agent + summary: Get Agent Task Step Artifacts + description: |- + Get all artifacts for a list of steps. + :param task_id: + :param step_id: + :return: List of artifacts for a list of steps. + operationId: >- + get_agent_task_step_artifacts_api_v1_eval_tasks__task_id__steps__step_id__artifacts_get + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + - name: step_id + in: path + required: true + schema: + type: string + title: Step Id + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Artifact' + title: >- + Response Get Agent Task Step Artifacts Api V1 Eval Tasks Task + Id Steps Step Id Artifacts Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/tasks/{task_id}/steps: + get: + tags: + - agent + summary: Get Agent Task Steps + description: |- + Get all steps for a task. + :param task_id: + :return: List of steps for a task with pagination. + operationId: get_agent_task_steps_api_v1_eval_tasks__task_id__steps_get + parameters: + - name: task_id + in: path + required: true + schema: + type: string + title: Task Id + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Step' + title: >- + Response Get Agent Task Steps Api V1 Eval Tasks Task Id + Steps Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + /api/v1/eval/tasks: + get: + tags: + - agent + summary: Get Agent Tasks + description: >- + Get all tasks. + + :param page: Starting page, defaults to 1 + + :param page_size: Page size, defaults to 10 + + :param task_status: Task status filter + + :param workflow_run_id: Workflow run id filter + + :param only_standalone_tasks: Only standalone tasks, tasks which are + part of a workflow run will be filtered out + + :param order: Direction to sort by, ascending or descending + + :param sort: Column to sort by, created_at or modified_at + + :return: List of tasks with pagination without steps populated. Steps + can be populated by calling the + get_agent_task endpoint. + operationId: get_agent_tasks_api_v1_eval_tasks_get + parameters: + - name: page + in: query + required: false + schema: + type: integer + minimum: 1 + default: 1 + title: Page + - name: page_size + in: query + required: false + schema: + type: integer + minimum: 1 + default: 10 + title: Page Size + - name: task_status + in: query + required: false + schema: + anyOf: + - type: array + items: + $ref: '#/components/schemas/TaskStatus' + - type: 'null' + title: Task Status + - name: workflow_run_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Workflow Run Id + - name: only_standalone_tasks + in: query + required: false + schema: + type: boolean + default: false + title: Only Standalone Tasks + - name: application + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Application + - name: sort + in: query + required: false + schema: + $ref: '#/components/schemas/OrderBy' + default: created_at + - name: order + in: query + required: false + schema: + $ref: '#/components/schemas/SortDirection' + default: desc + responses: + '200': + description: Successful Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Task' + title: Response Get Agent Tasks Api V1 Eval Tasks Get + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' +components: + schemas: + AISuggestionBase: + properties: + output: + anyOf: + - type: object + - type: string + - type: 'null' + title: Output + type: object + title: AISuggestionBase + AISuggestionRequest: + properties: + input: + type: string + minLength: 1 + title: Input + context: + anyOf: + - type: object + - type: 'null' + title: Context + type: object + required: + - input + title: AISuggestionRequest + AISuggestionType: + type: string + enum: + - data_schema + const: data_schema + title: AISuggestionType + AWSSecretParameter: + properties: + parameter_type: + type: string + enum: + - aws_secret + const: aws_secret + title: Parameter Type + default: aws_secret + key: + type: string + title: Key + description: + anyOf: + - type: string + - type: 'null' + title: Description + aws_secret_parameter_id: + type: string + title: Aws Secret Parameter Id + workflow_id: + type: string + title: Workflow Id + aws_key: + type: string + title: Aws Key + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + deleted_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Deleted At + type: object + required: + - key + - aws_secret_parameter_id + - workflow_id + - aws_key + - created_at + - modified_at + title: AWSSecretParameter + Action: + properties: + action_type: + $ref: '#/components/schemas/ActionType' + status: + $ref: '#/components/schemas/ActionStatus' + default: pending + action_id: + anyOf: + - type: string + - type: 'null' + title: Action Id + source_action_id: + anyOf: + - type: string + - type: 'null' + title: Source Action Id + organization_id: + anyOf: + - type: string + - type: 'null' + title: Organization Id + workflow_run_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Run Id + task_id: + anyOf: + - type: string + - type: 'null' + title: Task Id + step_id: + anyOf: + - type: string + - type: 'null' + title: Step Id + step_order: + anyOf: + - type: integer + - type: 'null' + title: Step Order + action_order: + anyOf: + - type: integer + - type: 'null' + title: Action Order + confidence_float: + anyOf: + - type: number + - type: 'null' + title: Confidence Float + description: + anyOf: + - type: string + - type: 'null' + title: Description + reasoning: + anyOf: + - type: string + - type: 'null' + title: Reasoning + intention: + anyOf: + - type: string + - type: 'null' + title: Intention + response: + anyOf: + - type: string + - type: 'null' + title: Response + element_id: + anyOf: + - type: string + - type: 'null' + title: Element Id + skyvern_element_hash: + anyOf: + - type: string + - type: 'null' + title: Skyvern Element Hash + skyvern_element_data: + anyOf: + - type: object + - type: 'null' + title: Skyvern Element Data + errors: + anyOf: + - items: + $ref: '#/components/schemas/UserDefinedError' + type: array + - type: 'null' + title: Errors + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + file_name: + anyOf: + - type: string + - type: 'null' + title: File Name + file_url: + anyOf: + - type: string + - type: 'null' + title: File Url + download: + anyOf: + - type: boolean + - type: 'null' + title: Download + is_upload_file_tag: + anyOf: + - type: boolean + - type: 'null' + title: Is Upload File Tag + text: + anyOf: + - type: string + - type: 'null' + title: Text + option: + anyOf: + - $ref: '#/components/schemas/SelectOption' + - type: 'null' + is_checked: + anyOf: + - type: boolean + - type: 'null' + title: Is Checked + created_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Created At + modified_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Modified At + type: object + required: + - action_type + title: Action + ActionBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - action + const: action + title: Block Type + default: action + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + task_type: + type: string + title: Task Type + default: general + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + type: string + title: Title + default: '' + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + type: integer + title: Max Retries + default: 0 + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + complete_on_download: + type: boolean + title: Complete On Download + default: false + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + type: boolean + title: Cache Actions + default: false + type: object + required: + - label + - output_parameter + title: ActionBlock + ActionResult: + properties: + success: + type: boolean + title: Success + stop_execution_on_failure: + type: boolean + title: Stop Execution On Failure + default: true + exception_type: + anyOf: + - type: string + - type: 'null' + title: Exception Type + exception_message: + anyOf: + - type: string + - type: 'null' + title: Exception Message + data: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Data + step_retry_number: + anyOf: + - type: integer + - type: 'null' + title: Step Retry Number + step_order: + anyOf: + - type: integer + - type: 'null' + title: Step Order + download_triggered: + anyOf: + - type: boolean + - type: 'null' + title: Download Triggered + interacted_with_sibling: + anyOf: + - type: boolean + - type: 'null' + title: Interacted With Sibling + interacted_with_parent: + anyOf: + - type: boolean + - type: 'null' + title: Interacted With Parent + skip_remaining_actions: + anyOf: + - type: boolean + - type: 'null' + title: Skip Remaining Actions + type: object + required: + - success + title: ActionResult + ActionStatus: + type: string + enum: + - pending + - skipped + - failed + - completed + title: ActionStatus + ActionType: + type: string + enum: + - click + - input_text + - upload_file + - download_file + - select_option + - checkbox + - wait + - null_action + - solve_captcha + - terminate + - complete + - reload_page + - extract + title: ActionType + AgentStepOutput: + properties: + action_results: + anyOf: + - items: + $ref: '#/components/schemas/ActionResult' + type: array + - type: 'null' + title: Action Results + actions_and_results: + anyOf: + - items: + prefixItems: + - $ref: '#/components/schemas/Action' + - items: + $ref: '#/components/schemas/ActionResult' + type: array + type: array + maxItems: 2 + minItems: 2 + type: array + - type: 'null' + title: Actions And Results + errors: + items: + $ref: '#/components/schemas/UserDefinedError' + type: array + title: Errors + default: [] + type: object + title: AgentStepOutput + description: Output of the agent step, this is recorded in the database. + Artifact: + properties: + created_at: + type: string + title: Created At + description: The creation datetime of the task. + examples: + - '2023-01-01T00:00:00Z' + modified_at: + type: string + title: Modified At + description: The modification datetime of the task. + examples: + - '2023-01-01T00:00:00Z' + artifact_id: + type: string + title: Artifact Id + artifact_type: + $ref: '#/components/schemas/ArtifactType' + uri: + type: string + title: Uri + task_id: + anyOf: + - type: string + - type: 'null' + title: Task Id + step_id: + anyOf: + - type: string + - type: 'null' + title: Step Id + workflow_run_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Run Id + workflow_run_block_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Run Block Id + observer_cruise_id: + anyOf: + - type: string + - type: 'null' + title: Observer Cruise Id + observer_thought_id: + anyOf: + - type: string + - type: 'null' + title: Observer Thought Id + ai_suggestion_id: + anyOf: + - type: string + - type: 'null' + title: Ai Suggestion Id + signed_url: + anyOf: + - type: string + - type: 'null' + title: Signed Url + organization_id: + anyOf: + - type: string + - type: 'null' + title: Organization Id + type: object + required: + - created_at + - modified_at + - artifact_id + - artifact_type + - uri + title: Artifact + ArtifactType: + type: string + enum: + - recording + - browser_console_log + - skyvern_log + - skyvern_log_raw + - screenshot + - screenshot_llm + - screenshot_action + - screenshot_final + - llm_prompt + - llm_request + - llm_response + - llm_response_parsed + - llm_response_rendered + - visible_elements_id_css_map + - visible_elements_id_frame_map + - visible_elements_tree + - visible_elements_tree_trimmed + - visible_elements_tree_in_prompt + - hashed_href_map + - visible_elements_id_xpath_map + - html + - html_scrape + - html_action + - trace + - har + title: ArtifactType + BitwardenCreditCardDataParameter: + properties: + parameter_type: + type: string + enum: + - bitwarden_credit_card_data + const: bitwarden_credit_card_data + title: Parameter Type + default: bitwarden_credit_card_data + key: + type: string + title: Key + description: + anyOf: + - type: string + - type: 'null' + title: Description + bitwarden_credit_card_data_parameter_id: + type: string + title: Bitwarden Credit Card Data Parameter Id + workflow_id: + type: string + title: Workflow Id + bitwarden_client_id_aws_secret_key: + type: string + title: Bitwarden Client Id Aws Secret Key + bitwarden_client_secret_aws_secret_key: + type: string + title: Bitwarden Client Secret Aws Secret Key + bitwarden_master_password_aws_secret_key: + type: string + title: Bitwarden Master Password Aws Secret Key + bitwarden_collection_id: + type: string + title: Bitwarden Collection Id + bitwarden_item_id: + type: string + title: Bitwarden Item Id + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + deleted_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Deleted At + type: object + required: + - key + - bitwarden_credit_card_data_parameter_id + - workflow_id + - bitwarden_client_id_aws_secret_key + - bitwarden_client_secret_aws_secret_key + - bitwarden_master_password_aws_secret_key + - bitwarden_collection_id + - bitwarden_item_id + - created_at + - modified_at + title: BitwardenCreditCardDataParameter + BitwardenLoginCredentialParameter: + properties: + parameter_type: + type: string + enum: + - bitwarden_login_credential + const: bitwarden_login_credential + title: Parameter Type + default: bitwarden_login_credential + key: + type: string + title: Key + description: + anyOf: + - type: string + - type: 'null' + title: Description + bitwarden_login_credential_parameter_id: + type: string + title: Bitwarden Login Credential Parameter Id + workflow_id: + type: string + title: Workflow Id + bitwarden_client_id_aws_secret_key: + type: string + title: Bitwarden Client Id Aws Secret Key + bitwarden_client_secret_aws_secret_key: + type: string + title: Bitwarden Client Secret Aws Secret Key + bitwarden_master_password_aws_secret_key: + type: string + title: Bitwarden Master Password Aws Secret Key + url_parameter_key: + type: string + title: Url Parameter Key + bitwarden_collection_id: + anyOf: + - type: string + - type: 'null' + title: Bitwarden Collection Id + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + deleted_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Deleted At + type: object + required: + - key + - bitwarden_login_credential_parameter_id + - workflow_id + - bitwarden_client_id_aws_secret_key + - bitwarden_client_secret_aws_secret_key + - bitwarden_master_password_aws_secret_key + - url_parameter_key + - created_at + - modified_at + title: BitwardenLoginCredentialParameter + BitwardenSensitiveInformationParameter: + properties: + parameter_type: + type: string + enum: + - bitwarden_sensitive_information + const: bitwarden_sensitive_information + title: Parameter Type + default: bitwarden_sensitive_information + key: + type: string + title: Key + description: + anyOf: + - type: string + - type: 'null' + title: Description + bitwarden_sensitive_information_parameter_id: + type: string + title: Bitwarden Sensitive Information Parameter Id + workflow_id: + type: string + title: Workflow Id + bitwarden_client_id_aws_secret_key: + type: string + title: Bitwarden Client Id Aws Secret Key + bitwarden_client_secret_aws_secret_key: + type: string + title: Bitwarden Client Secret Aws Secret Key + bitwarden_master_password_aws_secret_key: + type: string + title: Bitwarden Master Password Aws Secret Key + bitwarden_collection_id: + type: string + title: Bitwarden Collection Id + bitwarden_identity_key: + type: string + title: Bitwarden Identity Key + bitwarden_identity_fields: + items: + type: string + type: array + title: Bitwarden Identity Fields + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + deleted_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Deleted At + type: object + required: + - key + - bitwarden_sensitive_information_parameter_id + - workflow_id + - bitwarden_client_id_aws_secret_key + - bitwarden_client_secret_aws_secret_key + - bitwarden_master_password_aws_secret_key + - bitwarden_collection_id + - bitwarden_identity_key + - bitwarden_identity_fields + - created_at + - modified_at + title: BitwardenSensitiveInformationParameter + BlockType: + type: string + enum: + - task + - task_v2 + - for_loop + - code + - text_prompt + - download_to_s3 + - upload_to_s3 + - send_email + - file_url_parser + - validation + - action + - navigation + - extraction + - login + - wait + - file_download + - goto_url + - pdf_parser + title: BlockType + Body_upload_file_api_v1_upload_file_post: + properties: + file: + type: string + format: binary + title: File + type: object + required: + - file + title: Body_upload_file_api_v1_upload_file_post + BrowserSessionResponse: + properties: + session_id: + type: string + title: Session Id + organization_id: + type: string + title: Organization Id + runnable_type: + anyOf: + - type: string + - type: 'null' + title: Runnable Type + runnable_id: + anyOf: + - type: string + - type: 'null' + title: Runnable Id + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + deleted_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Deleted At + type: object + required: + - session_id + - organization_id + - created_at + - modified_at + title: BrowserSessionResponse + CodeBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - code + const: code + title: Block Type + default: code + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + code: + type: string + title: Code + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + type: object + required: + - label + - output_parameter + - code + title: CodeBlock + ContextParameter: + properties: + parameter_type: + type: string + enum: + - context + const: context + title: Parameter Type + default: context + key: + type: string + title: Key + description: + anyOf: + - type: string + - type: 'null' + title: Description + source: + anyOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + title: Source + value: + anyOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: object + - items: {} + type: array + - type: 'null' + title: Value + type: object + required: + - key + - source + title: ContextParameter + CreateTaskResponse: + properties: + task_id: + type: string + title: Task Id + type: object + required: + - task_id + title: CreateTaskResponse + DownloadToS3Block: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - download_to_s3 + const: download_to_s3 + title: Block Type + default: download_to_s3 + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + url: + type: string + title: Url + type: object + required: + - label + - output_parameter + - url + title: DownloadToS3Block + EntityType: + type: string + enum: + - step + - task + - workflow_run + - workflow_run_block + - observer_thought + title: EntityType + ExtractionBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - extraction + const: extraction + title: Block Type + default: extraction + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + task_type: + type: string + title: Task Type + default: general + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + type: string + title: Title + default: '' + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + data_extraction_goal: + type: string + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + type: integer + title: Max Retries + default: 0 + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + complete_on_download: + type: boolean + title: Complete On Download + default: false + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + type: boolean + title: Cache Actions + default: false + type: object + required: + - label + - output_parameter + - data_extraction_goal + title: ExtractionBlock + FileDownloadBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - file_download + const: file_download + title: Block Type + default: file_download + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + task_type: + type: string + title: Task Type + default: general + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + type: string + title: Title + default: '' + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + type: integer + title: Max Retries + default: 0 + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + complete_on_download: + type: boolean + title: Complete On Download + default: false + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + type: boolean + title: Cache Actions + default: false + type: object + required: + - label + - output_parameter + title: FileDownloadBlock + FileParserBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - file_url_parser + const: file_url_parser + title: Block Type + default: file_url_parser + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + file_url: + type: string + title: File Url + file_type: + $ref: '#/components/schemas/FileType' + type: object + required: + - label + - output_parameter + - file_url + - file_type + title: FileParserBlock + FileType: + type: string + enum: + - csv + const: csv + title: FileType + ForLoopBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - for_loop + const: for_loop + title: Block Type + default: for_loop + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + loop_blocks: + items: + oneOf: + - $ref: '#/components/schemas/ForLoopBlock' + - $ref: '#/components/schemas/TaskBlock' + - $ref: '#/components/schemas/CodeBlock' + - $ref: '#/components/schemas/TextPromptBlock' + - $ref: '#/components/schemas/DownloadToS3Block' + - $ref: '#/components/schemas/UploadToS3Block' + - $ref: '#/components/schemas/SendEmailBlock' + - $ref: '#/components/schemas/FileParserBlock' + - $ref: '#/components/schemas/PDFParserBlock' + - $ref: '#/components/schemas/ValidationBlock' + - $ref: '#/components/schemas/ActionBlock' + - $ref: '#/components/schemas/NavigationBlock' + - $ref: '#/components/schemas/ExtractionBlock' + - $ref: '#/components/schemas/LoginBlock' + - $ref: '#/components/schemas/WaitBlock' + - $ref: '#/components/schemas/FileDownloadBlock' + - $ref: '#/components/schemas/UrlBlock' + - $ref: '#/components/schemas/TaskV2Block' + discriminator: + propertyName: block_type + mapping: + action: '#/components/schemas/ActionBlock' + code: '#/components/schemas/CodeBlock' + download_to_s3: '#/components/schemas/DownloadToS3Block' + extraction: '#/components/schemas/ExtractionBlock' + file_download: '#/components/schemas/FileDownloadBlock' + file_url_parser: '#/components/schemas/FileParserBlock' + for_loop: '#/components/schemas/ForLoopBlock' + goto_url: '#/components/schemas/UrlBlock' + login: '#/components/schemas/LoginBlock' + navigation: '#/components/schemas/NavigationBlock' + pdf_parser: '#/components/schemas/PDFParserBlock' + send_email: '#/components/schemas/SendEmailBlock' + task: '#/components/schemas/TaskBlock' + task_v2: '#/components/schemas/TaskV2Block' + text_prompt: '#/components/schemas/TextPromptBlock' + upload_to_s3: '#/components/schemas/UploadToS3Block' + validation: '#/components/schemas/ValidationBlock' + wait: '#/components/schemas/WaitBlock' + type: array + title: Loop Blocks + loop_over: + anyOf: + - oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + - type: 'null' + title: Loop Over + loop_variable_reference: + anyOf: + - type: string + - type: 'null' + title: Loop Variable Reference + complete_if_empty: + type: boolean + title: Complete If Empty + default: false + type: object + required: + - label + - output_parameter + - loop_blocks + title: ForLoopBlock + GenerateTaskRequest: + properties: + prompt: + type: string + minLength: 1 + title: Prompt + type: object + required: + - prompt + title: GenerateTaskRequest + GetOrganizationAPIKeysResponse: + properties: + api_keys: + items: + $ref: '#/components/schemas/OrganizationAuthToken' + type: array + title: Api Keys + type: object + required: + - api_keys + title: GetOrganizationAPIKeysResponse + GetOrganizationsResponse: + properties: + organizations: + items: + $ref: '#/components/schemas/Organization' + type: array + title: Organizations + type: object + required: + - organizations + title: GetOrganizationsResponse + HTTPValidationError: + properties: + detail: + items: + $ref: '#/components/schemas/ValidationError' + type: array + title: Detail + type: object + title: HTTPValidationError + LoginBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - login + const: login + title: Block Type + default: login + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + task_type: + type: string + title: Task Type + default: general + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + type: string + title: Title + default: '' + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + type: integer + title: Max Retries + default: 0 + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + complete_on_download: + type: boolean + title: Complete On Download + default: false + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + type: boolean + title: Cache Actions + default: false + type: object + required: + - label + - output_parameter + title: LoginBlock + NavigationBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - navigation + const: navigation + title: Block Type + default: navigation + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + task_type: + type: string + title: Task Type + default: general + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + type: string + title: Title + default: '' + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + navigation_goal: + type: string + title: Navigation Goal + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + type: integer + title: Max Retries + default: 0 + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + complete_on_download: + type: boolean + title: Complete On Download + default: false + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + type: boolean + title: Cache Actions + default: false + type: object + required: + - label + - output_parameter + - navigation_goal + title: NavigationBlock + ObserverTask: + properties: + task_id: + type: string + title: Task Id + status: + $ref: '#/components/schemas/ObserverTaskStatus' + organization_id: + anyOf: + - type: string + - type: 'null' + title: Organization Id + workflow_run_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Run Id + workflow_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Id + workflow_permanent_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Permanent Id + prompt: + anyOf: + - type: string + - type: 'null' + title: Prompt + url: + anyOf: + - type: string + - type: 'null' + title: Url + summary: + anyOf: + - type: string + - type: 'null' + title: Summary + output: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Output + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + proxy_location: + anyOf: + - $ref: '#/components/schemas/ProxyLocation' + - type: 'null' + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + type: object + required: + - task_id + - status + - created_at + - modified_at + title: ObserverTask + ObserverTaskRequest: + properties: + user_prompt: + type: string + title: User Prompt + url: + anyOf: + - type: string + - type: 'null' + title: Url + browser_session_id: + anyOf: + - type: string + - type: 'null' + title: Browser Session Id + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + proxy_location: + anyOf: + - $ref: '#/components/schemas/ProxyLocation' + - type: 'null' + publish_workflow: + type: boolean + title: Publish Workflow + default: false + type: object + required: + - user_prompt + title: ObserverTaskRequest + ObserverTaskStatus: + type: string + enum: + - created + - queued + - running + - failed + - terminated + - canceled + - timed_out + - completed + title: ObserverTaskStatus + ObserverThought: + properties: + thought_id: + type: string + title: Thought Id + task_id: + type: string + title: Task Id + organization_id: + anyOf: + - type: string + - type: 'null' + title: Organization Id + workflow_run_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Run Id + workflow_run_block_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Run Block Id + workflow_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Id + workflow_permanent_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Permanent Id + user_input: + anyOf: + - type: string + - type: 'null' + title: User Input + observation: + anyOf: + - type: string + - type: 'null' + title: Observation + thought: + anyOf: + - type: string + - type: 'null' + title: Thought + answer: + anyOf: + - type: string + - type: 'null' + title: Answer + thought_type: + anyOf: + - $ref: '#/components/schemas/ObserverThoughtType' + - type: 'null' + default: plan + thought_scenario: + anyOf: + - $ref: '#/components/schemas/ObserverThoughtScenario' + - type: 'null' + output: + anyOf: + - type: object + - type: 'null' + title: Output + input_token_count: + anyOf: + - type: integer + - type: 'null' + title: Input Token Count + output_token_count: + anyOf: + - type: integer + - type: 'null' + title: Output Token Count + thought_cost: + anyOf: + - type: number + - type: 'null' + title: Thought Cost + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + type: object + required: + - thought_id + - task_id + - created_at + - modified_at + title: ObserverThought + ObserverThoughtScenario: + type: string + enum: + - generate_plan + - user_goal_check + - summarization + - generate_metadata + - extract_loop_values + - generate_task_in_loop + - generate_general_task + title: ObserverThoughtScenario + ObserverThoughtType: + type: string + enum: + - plan + - metadata + - user_goal_check + - internal_plan + title: ObserverThoughtType + OrderBy: + type: string + enum: + - created_at + - modified_at + title: OrderBy + Organization: + properties: + organization_id: + type: string + title: Organization Id + organization_name: + type: string + title: Organization Name + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + max_retries_per_step: + anyOf: + - type: integer + - type: 'null' + title: Max Retries Per Step + domain: + anyOf: + - type: string + - type: 'null' + title: Domain + bw_organization_id: + anyOf: + - type: string + - type: 'null' + title: Bw Organization Id + bw_collection_ids: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Bw Collection Ids + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + type: object + required: + - organization_id + - organization_name + - created_at + - modified_at + title: Organization + OrganizationAuthToken: + properties: + id: + type: string + title: Id + organization_id: + type: string + title: Organization Id + token_type: + $ref: '#/components/schemas/OrganizationAuthTokenType' + token: + type: string + title: Token + valid: + type: boolean + title: Valid + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + type: object + required: + - id + - organization_id + - token_type + - token + - valid + - created_at + - modified_at + title: OrganizationAuthToken + OrganizationAuthTokenType: + type: string + enum: + - api + const: api + title: OrganizationAuthTokenType + OrganizationUpdate: + properties: + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + type: object + title: OrganizationUpdate + OutputParameter: + properties: + parameter_type: + type: string + enum: + - output + const: output + title: Parameter Type + default: output + key: + type: string + title: Key + description: + anyOf: + - type: string + - type: 'null' + title: Description + output_parameter_id: + type: string + title: Output Parameter Id + workflow_id: + type: string + title: Workflow Id + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + deleted_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Deleted At + type: object + required: + - key + - output_parameter_id + - workflow_id + - created_at + - modified_at + title: OutputParameter + PDFParserBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - pdf_parser + const: pdf_parser + title: Block Type + default: pdf_parser + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + file_url: + type: string + title: File Url + json_schema: + anyOf: + - type: object + - type: 'null' + title: Json Schema + type: object + required: + - label + - output_parameter + - file_url + title: PDFParserBlock + ProxyLocation: + type: string + enum: + - US-CA + - US-NY + - US-TX + - US-FL + - US-WA + - RESIDENTIAL + - RESIDENTIAL_ES + - RESIDENTIAL_IE + - RESIDENTIAL_GB + - RESIDENTIAL_IN + - RESIDENTIAL_JP + - RESIDENTIAL_FR + - NONE + title: ProxyLocation + RunWorkflowResponse: + properties: + workflow_id: + type: string + title: Workflow Id + workflow_run_id: + type: string + title: Workflow Run Id + type: object + required: + - workflow_id + - workflow_run_id + title: RunWorkflowResponse + SelectOption: + properties: + label: + anyOf: + - type: string + - type: 'null' + title: Label + value: + anyOf: + - type: string + - type: 'null' + title: Value + index: + anyOf: + - type: integer + - type: 'null' + title: Index + type: object + title: SelectOption + SendEmailBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - send_email + const: send_email + title: Block Type + default: send_email + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + smtp_host: + $ref: '#/components/schemas/AWSSecretParameter' + smtp_port: + $ref: '#/components/schemas/AWSSecretParameter' + smtp_username: + $ref: '#/components/schemas/AWSSecretParameter' + smtp_password: + $ref: '#/components/schemas/AWSSecretParameter' + sender: + type: string + title: Sender + recipients: + items: + type: string + type: array + title: Recipients + subject: + type: string + title: Subject + body: + type: string + title: Body + file_attachments: + items: + type: string + type: array + title: File Attachments + default: [] + type: object + required: + - label + - output_parameter + - smtp_host + - smtp_port + - smtp_username + - smtp_password + - sender + - recipients + - subject + - body + title: SendEmailBlock + SortDirection: + type: string + enum: + - asc + - desc + title: SortDirection + Step: + properties: + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + task_id: + type: string + title: Task Id + step_id: + type: string + title: Step Id + status: + $ref: '#/components/schemas/StepStatus' + output: + anyOf: + - $ref: '#/components/schemas/AgentStepOutput' + - type: 'null' + order: + type: integer + title: Order + is_last: + type: boolean + title: Is Last + retry_index: + type: integer + title: Retry Index + default: 0 + organization_id: + anyOf: + - type: string + - type: 'null' + title: Organization Id + input_token_count: + type: integer + title: Input Token Count + default: 0 + output_token_count: + type: integer + title: Output Token Count + default: 0 + step_cost: + type: number + title: Step Cost + default: 0 + type: object + required: + - created_at + - modified_at + - task_id + - step_id + - status + - order + - is_last + title: Step + StepStatus: + type: string + enum: + - created + - running + - failed + - completed + - canceled + title: StepStatus + TOTPCode: + properties: + totp_identifier: + type: string + title: Totp Identifier + task_id: + anyOf: + - type: string + - type: 'null' + title: Task Id + workflow_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Id + source: + anyOf: + - type: string + - type: 'null' + title: Source + content: + type: string + title: Content + expired_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Expired At + totp_code_id: + type: string + title: Totp Code Id + code: + type: string + title: Code + organization_id: + type: string + title: Organization Id + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + type: object + required: + - totp_identifier + - content + - totp_code_id + - code + - organization_id + - created_at + - modified_at + title: TOTPCode + TOTPCodeCreate: + properties: + totp_identifier: + type: string + title: Totp Identifier + task_id: + anyOf: + - type: string + - type: 'null' + title: Task Id + workflow_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Id + source: + anyOf: + - type: string + - type: 'null' + title: Source + content: + type: string + title: Content + expired_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Expired At + type: object + required: + - totp_identifier + - content + title: TOTPCodeCreate + Task: + properties: + title: + anyOf: + - type: string + - type: 'null' + title: Title + description: The title of the task. + examples: + - Get a quote for car insurance + url: + type: string + title: Url + description: Starting URL for the task. + examples: + - https://www.geico.com + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + description: The URL to call when the task is completed. + examples: + - https://my-webhook.com + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + description: The user's goal for the task. + examples: + - Get a quote for car insurance + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + description: The user's goal for data extraction. + examples: + - Extract the quote price + navigation_payload: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Navigation Payload + description: The user's details needed to achieve the task. + examples: + - email: john@doe.com + name: John Doe + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + description: The mapping of error codes and their descriptions. + examples: + - not_found: Return this error when the product is not found + out_of_stock: Return this error when the product is out of stock + proxy_location: + anyOf: + - $ref: '#/components/schemas/ProxyLocation' + - type: 'null' + description: The location of the proxy to use for the task. + examples: + - US-WA + - US-CA + - US-FL + - US-NY + - US-TX + extracted_information_schema: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Extracted Information Schema + description: The requested schema of the extracted information. + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + description: Criterion to complete + examples: + - Complete if 'hello world' shows up on the page + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + description: Criterion to terminate + examples: + - Terminate if 'existing account' shows up on the page + task_type: + anyOf: + - $ref: '#/components/schemas/TaskType' + - type: 'null' + description: The type of the task + default: general + examples: + - general + - validation + application: + anyOf: + - type: string + - type: 'null' + title: Application + description: The application for which the task is running + examples: + - forms + created_at: + type: string + format: date-time + title: Created At + description: The creation datetime of the task. + examples: + - '2023-01-01T00:00:00Z' + modified_at: + type: string + format: date-time + title: Modified At + description: The modification datetime of the task. + examples: + - '2023-01-01T00:00:00Z' + task_id: + type: string + title: Task Id + description: The ID of the task. + examples: + - 50da533e-3904-4401-8a07-c49adf88b5eb + status: + $ref: '#/components/schemas/TaskStatus' + description: The status of the task. + examples: + - created + extracted_information: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Extracted Information + description: The extracted information from the task. + failure_reason: + anyOf: + - type: string + - type: 'null' + title: Failure Reason + description: The reason for the task failure. + organization_id: + anyOf: + - type: string + - type: 'null' + title: Organization Id + workflow_run_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Run Id + order: + anyOf: + - type: integer + - type: 'null' + title: Order + retry: + anyOf: + - type: integer + - type: 'null' + title: Retry + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + errors: + items: + type: object + type: array + title: Errors + default: [] + type: object + required: + - url + - created_at + - modified_at + - task_id + - status + title: Task + TaskBase: + properties: + title: + anyOf: + - type: string + - type: 'null' + title: Title + description: The title of the task. + examples: + - Get a quote for car insurance + url: + type: string + title: Url + description: Starting URL for the task. + examples: + - https://www.geico.com + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + description: The URL to call when the task is completed. + examples: + - https://my-webhook.com + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + description: The user's goal for the task. + examples: + - Get a quote for car insurance + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + description: The user's goal for data extraction. + examples: + - Extract the quote price + navigation_payload: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Navigation Payload + description: The user's details needed to achieve the task. + examples: + - email: john@doe.com + name: John Doe + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + description: The mapping of error codes and their descriptions. + examples: + - not_found: Return this error when the product is not found + out_of_stock: Return this error when the product is out of stock + proxy_location: + anyOf: + - $ref: '#/components/schemas/ProxyLocation' + - type: 'null' + description: The location of the proxy to use for the task. + examples: + - US-WA + - US-CA + - US-FL + - US-NY + - US-TX + extracted_information_schema: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Extracted Information Schema + description: The requested schema of the extracted information. + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + description: Criterion to complete + examples: + - Complete if 'hello world' shows up on the page + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + description: Criterion to terminate + examples: + - Terminate if 'existing account' shows up on the page + task_type: + anyOf: + - $ref: '#/components/schemas/TaskType' + - type: 'null' + description: The type of the task + default: general + examples: + - general + - validation + application: + anyOf: + - type: string + - type: 'null' + title: Application + description: The application for which the task is running + examples: + - forms + type: object + required: + - url + title: TaskBase + TaskBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - task + const: task + title: Block Type + default: task + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + task_type: + type: string + title: Task Type + default: general + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + type: string + title: Title + default: '' + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + type: integer + title: Max Retries + default: 0 + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + complete_on_download: + type: boolean + title: Complete On Download + default: false + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + type: boolean + title: Cache Actions + default: false + type: object + required: + - label + - output_parameter + title: TaskBlock + TaskGeneration: + properties: + organization_id: + type: string + title: Organization Id + user_prompt: + type: string + title: User Prompt + user_prompt_hash: + type: string + title: User Prompt Hash + url: + anyOf: + - type: string + - type: 'null' + title: Url + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + navigation_payload: + anyOf: + - type: object + - type: 'null' + title: Navigation Payload + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + extracted_information_schema: + anyOf: + - type: object + - type: 'null' + title: Extracted Information Schema + llm: + anyOf: + - type: string + - type: 'null' + title: Llm + llm_prompt: + anyOf: + - type: string + - type: 'null' + title: Llm Prompt + llm_response: + anyOf: + - type: string + - type: 'null' + title: Llm Response + suggested_title: + anyOf: + - type: string + - type: 'null' + title: Suggested Title + task_generation_id: + type: string + title: Task Generation Id + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + type: object + required: + - organization_id + - user_prompt + - user_prompt_hash + - task_generation_id + - created_at + - modified_at + title: TaskGeneration + TaskRequest: + properties: + title: + anyOf: + - type: string + - type: 'null' + title: Title + description: The title of the task. + examples: + - Get a quote for car insurance + url: + type: string + title: Url + description: Starting URL for the task. + examples: + - https://www.geico.com + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + description: The URL to call when the task is completed. + examples: + - https://my-webhook.com + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + description: The user's goal for the task. + examples: + - Get a quote for car insurance + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + description: The user's goal for data extraction. + examples: + - Extract the quote price + navigation_payload: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Navigation Payload + description: The user's details needed to achieve the task. + examples: + - email: john@doe.com + name: John Doe + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + description: The mapping of error codes and their descriptions. + examples: + - not_found: Return this error when the product is not found + out_of_stock: Return this error when the product is out of stock + proxy_location: + anyOf: + - $ref: '#/components/schemas/ProxyLocation' + - type: 'null' + description: The location of the proxy to use for the task. + examples: + - US-WA + - US-CA + - US-FL + - US-NY + - US-TX + extracted_information_schema: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Extracted Information Schema + description: The requested schema of the extracted information. + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + description: Criterion to complete + examples: + - Complete if 'hello world' shows up on the page + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + description: Criterion to terminate + examples: + - Terminate if 'existing account' shows up on the page + task_type: + anyOf: + - $ref: '#/components/schemas/TaskType' + - type: 'null' + description: The type of the task + default: general + examples: + - general + - validation + application: + anyOf: + - type: string + - type: 'null' + title: Application + description: The application for which the task is running + examples: + - forms + browser_session_id: + anyOf: + - type: string + - type: 'null' + title: Browser Session Id + type: object + required: + - url + title: TaskRequest + TaskResponse: + properties: + request: + $ref: '#/components/schemas/TaskBase' + task_id: + type: string + title: Task Id + status: + $ref: '#/components/schemas/TaskStatus' + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + extracted_information: + anyOf: + - items: {} + type: array + - type: object + - type: string + - type: 'null' + title: Extracted Information + action_screenshot_urls: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Action Screenshot Urls + screenshot_url: + anyOf: + - type: string + - type: 'null' + title: Screenshot Url + recording_url: + anyOf: + - type: string + - type: 'null' + title: Recording Url + browser_console_log_url: + anyOf: + - type: string + - type: 'null' + title: Browser Console Log Url + downloaded_file_urls: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Downloaded File Urls + failure_reason: + anyOf: + - type: string + - type: 'null' + title: Failure Reason + errors: + items: + type: object + type: array + title: Errors + default: [] + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + workflow_run_id: + anyOf: + - type: string + - type: 'null' + title: Workflow Run Id + type: object + required: + - request + - task_id + - status + - created_at + - modified_at + title: TaskResponse + TaskStatus: + type: string + enum: + - created + - queued + - running + - timed_out + - failed + - terminated + - completed + - canceled + title: TaskStatus + TaskType: + type: string + enum: + - general + - validation + - action + title: TaskType + TaskV2Block: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - task_v2 + const: task_v2 + title: Block Type + default: task_v2 + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + prompt: + type: string + title: Prompt + url: + anyOf: + - type: string + - type: 'null' + title: Url + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + max_iterations: + type: integer + title: Max Iterations + default: 10 + type: object + required: + - label + - output_parameter + - prompt + title: TaskV2Block + TextPromptBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - text_prompt + const: text_prompt + title: Block Type + default: text_prompt + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + llm_key: + type: string + title: Llm Key + default: OPENAI_GPT4O_MINI + prompt: + type: string + title: Prompt + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + json_schema: + anyOf: + - type: object + - type: 'null' + title: Json Schema + type: object + required: + - label + - output_parameter + - prompt + title: TextPromptBlock + UploadToS3Block: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - upload_to_s3 + const: upload_to_s3 + title: Block Type + default: upload_to_s3 + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + path: + anyOf: + - type: string + - type: 'null' + title: Path + type: object + required: + - label + - output_parameter + title: UploadToS3Block + UrlBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - goto_url + const: goto_url + title: Block Type + default: goto_url + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + task_type: + type: string + title: Task Type + default: general + url: + type: string + title: Url + title: + type: string + title: Title + default: '' + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + type: integer + title: Max Retries + default: 0 + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + complete_on_download: + type: boolean + title: Complete On Download + default: false + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + type: boolean + title: Cache Actions + default: false + type: object + required: + - label + - output_parameter + - url + title: UrlBlock + UserDefinedError: + properties: + error_code: + type: string + title: Error Code + reasoning: + type: string + title: Reasoning + confidence_float: + type: number + maximum: 1 + minimum: 0 + title: Confidence Float + type: object + required: + - error_code + - reasoning + - confidence_float + title: UserDefinedError + ValidationBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - validation + const: validation + title: Block Type + default: validation + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + task_type: + type: string + title: Task Type + default: general + url: + anyOf: + - type: string + - type: 'null' + title: Url + title: + type: string + title: Title + default: '' + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: 'null' + title: Data Schema + error_code_mapping: + anyOf: + - additionalProperties: + type: string + type: object + - type: 'null' + title: Error Code Mapping + max_retries: + type: integer + title: Max Retries + default: 0 + max_steps_per_run: + anyOf: + - type: integer + - type: 'null' + title: Max Steps Per Run + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + complete_on_download: + type: boolean + title: Complete On Download + default: false + download_suffix: + anyOf: + - type: string + - type: 'null' + title: Download Suffix + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + cache_actions: + type: boolean + title: Cache Actions + default: false + type: object + required: + - label + - output_parameter + title: ValidationBlock + ValidationError: + properties: + loc: + items: + anyOf: + - type: string + - type: integer + type: array + title: Location + msg: + type: string + title: Message + type: + type: string + title: Error Type + type: object + required: + - loc + - msg + - type + title: ValidationError + WaitBlock: + properties: + label: + type: string + title: Label + block_type: + type: string + enum: + - wait + const: wait + title: Block Type + default: wait + output_parameter: + $ref: '#/components/schemas/OutputParameter' + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + wait_sec: + type: integer + title: Wait Sec + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + default: [] + type: object + required: + - label + - output_parameter + - wait_sec + title: WaitBlock + Workflow: + properties: + workflow_id: + type: string + title: Workflow Id + organization_id: + type: string + title: Organization Id + title: + type: string + title: Title + workflow_permanent_id: + type: string + title: Workflow Permanent Id + version: + type: integer + title: Version + is_saved_task: + type: boolean + title: Is Saved Task + description: + anyOf: + - type: string + - type: 'null' + title: Description + workflow_definition: + $ref: '#/components/schemas/WorkflowDefinition' + proxy_location: + anyOf: + - $ref: '#/components/schemas/ProxyLocation' + - type: 'null' + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + persist_browser_session: + type: boolean + title: Persist Browser Session + default: false + status: + $ref: '#/components/schemas/WorkflowStatus' + default: published + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + deleted_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Deleted At + type: object + required: + - workflow_id + - organization_id + - title + - workflow_permanent_id + - version + - is_saved_task + - workflow_definition + - created_at + - modified_at + title: Workflow + WorkflowDefinition: + properties: + parameters: + items: + oneOf: + - $ref: '#/components/schemas/WorkflowParameter' + - $ref: '#/components/schemas/ContextParameter' + - $ref: '#/components/schemas/AWSSecretParameter' + - $ref: '#/components/schemas/BitwardenLoginCredentialParameter' + - $ref: '#/components/schemas/BitwardenSensitiveInformationParameter' + - $ref: '#/components/schemas/BitwardenCreditCardDataParameter' + - $ref: '#/components/schemas/OutputParameter' + discriminator: + propertyName: parameter_type + mapping: + aws_secret: '#/components/schemas/AWSSecretParameter' + bitwarden_credit_card_data: '#/components/schemas/BitwardenCreditCardDataParameter' + bitwarden_login_credential: '#/components/schemas/BitwardenLoginCredentialParameter' + bitwarden_sensitive_information: '#/components/schemas/BitwardenSensitiveInformationParameter' + context: '#/components/schemas/ContextParameter' + output: '#/components/schemas/OutputParameter' + workflow: '#/components/schemas/WorkflowParameter' + type: array + title: Parameters + blocks: + items: + oneOf: + - $ref: '#/components/schemas/ForLoopBlock' + - $ref: '#/components/schemas/TaskBlock' + - $ref: '#/components/schemas/CodeBlock' + - $ref: '#/components/schemas/TextPromptBlock' + - $ref: '#/components/schemas/DownloadToS3Block' + - $ref: '#/components/schemas/UploadToS3Block' + - $ref: '#/components/schemas/SendEmailBlock' + - $ref: '#/components/schemas/FileParserBlock' + - $ref: '#/components/schemas/PDFParserBlock' + - $ref: '#/components/schemas/ValidationBlock' + - $ref: '#/components/schemas/ActionBlock' + - $ref: '#/components/schemas/NavigationBlock' + - $ref: '#/components/schemas/ExtractionBlock' + - $ref: '#/components/schemas/LoginBlock' + - $ref: '#/components/schemas/WaitBlock' + - $ref: '#/components/schemas/FileDownloadBlock' + - $ref: '#/components/schemas/UrlBlock' + - $ref: '#/components/schemas/TaskV2Block' + discriminator: + propertyName: block_type + mapping: + action: '#/components/schemas/ActionBlock' + code: '#/components/schemas/CodeBlock' + download_to_s3: '#/components/schemas/DownloadToS3Block' + extraction: '#/components/schemas/ExtractionBlock' + file_download: '#/components/schemas/FileDownloadBlock' + file_url_parser: '#/components/schemas/FileParserBlock' + for_loop: '#/components/schemas/ForLoopBlock' + goto_url: '#/components/schemas/UrlBlock' + login: '#/components/schemas/LoginBlock' + navigation: '#/components/schemas/NavigationBlock' + pdf_parser: '#/components/schemas/PDFParserBlock' + send_email: '#/components/schemas/SendEmailBlock' + task: '#/components/schemas/TaskBlock' + task_v2: '#/components/schemas/TaskV2Block' + text_prompt: '#/components/schemas/TextPromptBlock' + upload_to_s3: '#/components/schemas/UploadToS3Block' + validation: '#/components/schemas/ValidationBlock' + wait: '#/components/schemas/WaitBlock' + type: array + title: Blocks + type: object + required: + - parameters + - blocks + title: WorkflowDefinition + WorkflowParameter: + properties: + parameter_type: + type: string + enum: + - workflow + const: workflow + title: Parameter Type + default: workflow + key: + type: string + title: Key + description: + anyOf: + - type: string + - type: 'null' + title: Description + workflow_parameter_id: + type: string + title: Workflow Parameter Id + workflow_parameter_type: + $ref: '#/components/schemas/WorkflowParameterType' + workflow_id: + type: string + title: Workflow Id + default_value: + anyOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: object + - items: {} + type: array + - type: 'null' + title: Default Value + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + deleted_at: + anyOf: + - type: string + format: date-time + - type: 'null' + title: Deleted At + type: object + required: + - key + - workflow_parameter_id + - workflow_parameter_type + - workflow_id + - created_at + - modified_at + title: WorkflowParameter + WorkflowParameterType: + type: string + enum: + - string + - integer + - float + - boolean + - json + - file_url + title: WorkflowParameterType + WorkflowRequestBody: + properties: + data: + anyOf: + - type: object + - type: 'null' + title: Data + proxy_location: + anyOf: + - $ref: '#/components/schemas/ProxyLocation' + - type: 'null' + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + browser_session_id: + anyOf: + - type: string + - type: 'null' + title: Browser Session Id + type: object + title: WorkflowRequestBody + WorkflowRun: + properties: + workflow_run_id: + type: string + title: Workflow Run Id + workflow_id: + type: string + title: Workflow Id + workflow_permanent_id: + type: string + title: Workflow Permanent Id + organization_id: + type: string + title: Organization Id + status: + $ref: '#/components/schemas/WorkflowRunStatus' + proxy_location: + anyOf: + - $ref: '#/components/schemas/ProxyLocation' + - type: 'null' + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + failure_reason: + anyOf: + - type: string + - type: 'null' + title: Failure Reason + parent_workflow_run_id: + anyOf: + - type: string + - type: 'null' + title: Parent Workflow Run Id + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + type: object + required: + - workflow_run_id + - workflow_id + - workflow_permanent_id + - organization_id + - status + - created_at + - modified_at + title: WorkflowRun + WorkflowRunBlock: + properties: + workflow_run_block_id: + type: string + title: Workflow Run Block Id + block_workflow_run_id: + anyOf: + - type: string + - type: 'null' + title: Block Workflow Run Id + workflow_run_id: + type: string + title: Workflow Run Id + organization_id: + anyOf: + - type: string + - type: 'null' + title: Organization Id + description: + anyOf: + - type: string + - type: 'null' + title: Description + parent_workflow_run_block_id: + anyOf: + - type: string + - type: 'null' + title: Parent Workflow Run Block Id + block_type: + $ref: '#/components/schemas/BlockType' + label: + anyOf: + - type: string + - type: 'null' + title: Label + status: + anyOf: + - type: string + - type: 'null' + title: Status + output: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Output + continue_on_failure: + type: boolean + title: Continue On Failure + default: false + failure_reason: + anyOf: + - type: string + - type: 'null' + title: Failure Reason + task_id: + anyOf: + - type: string + - type: 'null' + title: Task Id + url: + anyOf: + - type: string + - type: 'null' + title: Url + navigation_goal: + anyOf: + - type: string + - type: 'null' + title: Navigation Goal + navigation_payload: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Navigation Payload + data_extraction_goal: + anyOf: + - type: string + - type: 'null' + title: Data Extraction Goal + data_schema: + anyOf: + - type: object + - items: {} + type: array + - type: string + - type: 'null' + title: Data Schema + terminate_criterion: + anyOf: + - type: string + - type: 'null' + title: Terminate Criterion + complete_criterion: + anyOf: + - type: string + - type: 'null' + title: Complete Criterion + actions: + items: + $ref: '#/components/schemas/Action' + type: array + title: Actions + default: [] + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + loop_values: + anyOf: + - items: {} + type: array + - type: 'null' + title: Loop Values + current_value: + anyOf: + - type: string + - type: 'null' + title: Current Value + current_index: + anyOf: + - type: integer + - type: 'null' + title: Current Index + recipients: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Recipients + attachments: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Attachments + subject: + anyOf: + - type: string + - type: 'null' + title: Subject + body: + anyOf: + - type: string + - type: 'null' + title: Body + type: object + required: + - workflow_run_block_id + - workflow_run_id + - block_type + - created_at + - modified_at + title: WorkflowRunBlock + WorkflowRunStatus: + type: string + enum: + - created + - queued + - running + - failed + - terminated + - canceled + - timed_out + - completed + title: WorkflowRunStatus + WorkflowRunStatusResponse: + properties: + workflow_id: + type: string + title: Workflow Id + workflow_run_id: + type: string + title: Workflow Run Id + status: + $ref: '#/components/schemas/WorkflowRunStatus' + failure_reason: + anyOf: + - type: string + - type: 'null' + title: Failure Reason + proxy_location: + anyOf: + - $ref: '#/components/schemas/ProxyLocation' + - type: 'null' + webhook_callback_url: + anyOf: + - type: string + - type: 'null' + title: Webhook Callback Url + totp_verification_url: + anyOf: + - type: string + - type: 'null' + title: Totp Verification Url + totp_identifier: + anyOf: + - type: string + - type: 'null' + title: Totp Identifier + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + parameters: + type: object + title: Parameters + screenshot_urls: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Screenshot Urls + recording_url: + anyOf: + - type: string + - type: 'null' + title: Recording Url + downloaded_file_urls: + anyOf: + - items: + type: string + type: array + - type: 'null' + title: Downloaded File Urls + outputs: + anyOf: + - type: object + - type: 'null' + title: Outputs + total_steps: + anyOf: + - type: integer + - type: 'null' + title: Total Steps + total_cost: + anyOf: + - type: number + - type: 'null' + title: Total Cost + observer_task: + anyOf: + - $ref: '#/components/schemas/ObserverTask' + - type: 'null' + type: object + required: + - workflow_id + - workflow_run_id + - status + - created_at + - modified_at + - parameters + title: WorkflowRunStatusResponse + WorkflowRunTimeline: + properties: + type: + $ref: '#/components/schemas/WorkflowRunTimelineType' + block: + anyOf: + - $ref: '#/components/schemas/WorkflowRunBlock' + - type: 'null' + thought: + anyOf: + - $ref: '#/components/schemas/ObserverThought' + - type: 'null' + children: + items: + $ref: '#/components/schemas/WorkflowRunTimeline' + type: array + title: Children + default: [] + created_at: + type: string + format: date-time + title: Created At + modified_at: + type: string + format: date-time + title: Modified At + type: object + required: + - type + - created_at + - modified_at + title: WorkflowRunTimeline + WorkflowRunTimelineType: + type: string + enum: + - thought + - block + title: WorkflowRunTimelineType + WorkflowStatus: + type: string + enum: + - published + - draft + - auto_generated + title: WorkflowStatus