openapi: 3.1.0 info: title: Platform API version: 3.1.0 servers: - url: https://platform.unstructuredapp.io/ description: Unstructured Platform API x-speakeasy-server-id: platform-api paths: /api/v1/destinations/: get: tags: - destinations summary: List destination connectors description: Retrieve a list of available destination connectors. operationId: list_destinations parameters: - name: destination_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/DestinationConnectorType' - type: 'null' title: Destination Type - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DestinationConnectorInformation' title: Response List Destinations '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - destinations summary: Create destination connector description: Create a new destination connector using the provided configuration and name. operationId: create_destination parameters: - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDestinationConnector' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DestinationConnectorInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/destinations/{destination_id}: get: tags: - destinations summary: Get destination connector description: Retrieve detailed information for a specific destination connector by its ID. operationId: get_destination parameters: - name: destination_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Destination Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DestinationConnectorInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' put: tags: - destinations summary: Update destination connector description: Update the configuration of an existing destination connector. operationId: update_destination parameters: - name: destination_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Destination Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDestinationConnector' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DestinationConnectorInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - destinations summary: Delete destination connector description: Delete a specific destination connector by its ID. operationId: delete_destination parameters: - name: destination_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Destination Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/destinations/{destination_id}/connection-check: post: tags: - destinations summary: Create destination connection check description: Initiate a connection check for the destination connector operationId: create_connection_check_destinations parameters: - name: destination_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Destination Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DagNodeConnectionCheck' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-name-override: create_connection_check_destinations get: tags: - destinations summary: Get the latest destination connector connection check description: Retrieves the most recent connection check for the specified destination connector. operationId: get_connection_check_destinations parameters: - name: destination_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Destination Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DagNodeConnectionCheck' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-name-override: get_connection_check_destinations /api/v1/sources/: get: tags: - sources summary: List available source connectors description: Retrieve a list of available source connectors. operationId: list_sources parameters: - name: source_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/SourceConnectorType' - type: 'null' title: Source Type - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/SourceConnectorInformation' title: Response List Sources '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - sources summary: Create source connector description: Create a new source connector using the provided configuration and name. operationId: create_source parameters: - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSourceConnector' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SourceConnectorInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/sources/{source_id}: get: tags: - sources summary: Get source connector description: Retrieve detailed information for a specific source connector by its ID. operationId: get_source parameters: - name: source_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Source Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SourceConnectorInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - sources summary: Delete source connector description: Delete a specific source connector identified by its ID. operationId: delete_source parameters: - name: source_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Source Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' put: tags: - sources summary: Update source connector description: Update the configuration of an existing source connector. operationId: update_source parameters: - name: source_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Source Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSourceConnector' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SourceConnectorInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/sources/{source_id}/connection-check: post: tags: - sources summary: Create source connection check description: Initiates a connection check for the specified source connector. operationId: create_connection_check_sources parameters: - name: source_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Source Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DagNodeConnectionCheck' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-name-override: create_connection_check_sources get: tags: - sources summary: Get the latest source connector connection check description: Retrieves the most recent connection check for the specified source connector. operationId: get_connection_check_sources parameters: - name: source_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Source Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DagNodeConnectionCheck' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-name-override: get_connection_check_sources /api/v1/jobs/: get: tags: - jobs summary: List Jobs description: Retrieve a list of jobs with optional filtering by workflow ID or job status. operationId: list_jobs parameters: - name: workflow_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id - name: status in: query required: false schema: anyOf: - type: string - type: 'null' title: Status - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/JobInformation' title: Response List Jobs '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - jobs summary: Create Job description: Create a new on-demand job using either a template (with persistent job optimization) or custom DAG. operationId: create_job parameters: - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/Body_create_job' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/jobs/{job_id}: get: tags: - jobs summary: Get Job description: Retrieve detailed information for a specific job by its ID. operationId: get_job parameters: - name: job_id in: path required: true schema: type: string format: uuid title: Job Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/jobs/{job_id}/cancel: post: tags: - jobs summary: Cancel Job description: Cancel the specified job. operationId: cancel_job parameters: - name: job_id in: path required: true schema: type: string format: uuid title: Job Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/jobs/{job_id}/download: get: tags: - jobs summary: Download Job output description: Download the output of a job from a workflow where the input file was provided at runtime. operationId: download_job_output parameters: - name: job_id in: path required: true schema: type: string format: uuid title: Job Id - name: file_id in: query required: true schema: type: string description: ID of the file to download title: File Id description: ID of the file to download - name: node_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' description: Node ID to retrieve the corresponding output file.If not provided, uses the terminal processing node in the workflow. title: Node Id description: Node ID to retrieve the corresponding output file.If not provided, uses the terminal processing node in the workflow. - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/jobs/{job_id}/details: get: tags: - jobs summary: Get Job processing details description: Retrieve processing details for a specific job by its ID. operationId: get_job_details parameters: - name: job_id in: path required: true schema: type: string format: uuid title: Job Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobDetails' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/jobs/{job_id}/failed-files: get: tags: - jobs summary: Get Job Failed Files description: Retrieve failed files for a specific job by its ID. operationId: get_job_failed_files parameters: - name: job_id in: path required: true schema: type: string format: uuid title: Job Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobFailedFiles' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/notifications/channels: post: tags: - channels summary: Create Channel description: 'Create notification channel. Creates a new delivery channel for receiving platform event notifications. URL must use HTTPS for webhook type. At least one event type must be specified.' operationId: create_channel_api_v1_notifications_channels_post parameters: - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/CreateWebhookChannelRequest' - $ref: '#/components/schemas/CreateEmailChannelRequest' discriminator: propertyName: channel_type mapping: webhook: '#/components/schemas/CreateWebhookChannelRequest' email: '#/components/schemas/CreateEmailChannelRequest' title: Data responses: '201': description: Successful Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/WebhookChannelResponse' - $ref: '#/components/schemas/EmailChannelResponse' discriminator: propertyName: channel_type mapping: webhook: '#/components/schemas/WebhookChannelResponse' email: '#/components/schemas/EmailChannelResponse' title: Response Create Channel Api V1 Notifications Channels Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - channels summary: List Channels description: 'List account-level notification channels. Returns all channel configurations for the account (workflow_id=None scope). channel_type is required - no cross-type aggregation.' operationId: list_channels_api_v1_notifications_channels_get parameters: - name: channel_type in: query required: true schema: $ref: '#/components/schemas/ChannelType' - name: enabled in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Enabled - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ChannelListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/notifications/channels/{channel_id}: get: tags: - channels summary: Get Channel description: Get account-level notification channel by ID. operationId: get_channel_api_v1_notifications_channels__channel_id__get parameters: - name: channel_id in: path required: true schema: type: string title: Channel Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/WebhookChannelResponse' - $ref: '#/components/schemas/EmailChannelResponse' discriminator: propertyName: channel_type mapping: webhook: '#/components/schemas/WebhookChannelResponse' email: '#/components/schemas/EmailChannelResponse' title: Response Get Channel Api V1 Notifications Channels Channel Id Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - channels summary: Update Channel description: 'Update account-level notification channel. Updates an existing channel. Only provided fields are updated.' operationId: update_channel_api_v1_notifications_channels__channel_id__patch parameters: - name: channel_id in: path required: true schema: type: string title: Channel Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateChannelRequest' responses: '200': description: Successful Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/WebhookChannelResponse' - $ref: '#/components/schemas/EmailChannelResponse' discriminator: propertyName: channel_type mapping: webhook: '#/components/schemas/WebhookChannelResponse' email: '#/components/schemas/EmailChannelResponse' title: Response Update Channel Api V1 Notifications Channels Channel Id Patch '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - channels summary: Delete Channel description: Delete account-level notification channel. operationId: delete_channel_api_v1_notifications_channels__channel_id__delete parameters: - name: channel_id in: path required: true schema: type: string title: Channel Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/notifications/channels/{channel_id}/verify: post: tags: - channels summary: Verify Channel description: 'Verify a notification channel using a verification code. Email channels require verification by providing the 6-digit code sent to the recipient email address during channel creation.' operationId: verify_channel_api_v1_notifications_channels__channel_id__verify_post parameters: - name: channel_id in: path required: true schema: type: string title: Channel Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VerifyChannelRequest' responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/notifications: get: tags: - notifications summary: List Notifications description: "List notification events for the authenticated user.\n\nReturns\ \ persisted notification events enriched with per-user read status.\nEach\ \ notification represents a platform event (e.g., job.completed) with\nan\ \ `is_read` flag indicating whether the current user has marked it as read.\n\ \nOrdered by created_at DESC with cursor-based pagination.\n\nArgs:\n workflow_id:\ \ Filter by workflow ID\n event_types: Comma-separated event types (e.g.,\ \ \"job.completed,job.failed\")\n since: Filter events created after this\ \ ISO 8601 timestamp\n limit: Max events to return (1-100, default 50)\n\ \ cursor: Pagination cursor from previous response\n unread_only: Filter\ \ to unread events only for current user" operationId: list_notifications_api_v1_notifications_get parameters: - name: workflow_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id - name: event_types in: query required: false schema: anyOf: - type: string - type: 'null' title: Event Types - name: since in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Since - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 50 title: Limit - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor - name: unread_only in: query required: false schema: type: boolean default: false title: Unread Only - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/NotificationListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/notifications/unread-count: get: tags: - notifications summary: Get Unread Count description: "Get count of unread notification events for current user.\n\n\ Target performance: <50ms p95 (SC-014).\n\nArgs:\n workflow_id: Optional\ \ workflow filter" operationId: get_unread_count_api_v1_notifications_unread_count_get parameters: - name: workflow_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UnreadCountResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/notifications/mark-read: post: tags: - notifications summary: Mark Read description: 'Mark notification events as read for current user. Provide EITHER notification_ids (list of up to 100 UUIDs) OR before (timestamp). workflow_id filter is only valid with ''before'' mode. Target performance: batch of 100 < 100ms (SC-015).' operationId: mark_read_api_v1_notifications_mark_read_post parameters: - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MarkReadRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MarkReadResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/notifications/{notification_id}: get: tags: - notifications summary: Get Notification description: Get a single notification event by ID. operationId: get_notification_api_v1_notifications__notification_id__get parameters: - name: notification_id in: path required: true schema: type: string format: uuid title: Notification Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/NotificationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/templates/: get: tags: - templates summary: List Templates description: Retrieve a list of available templates with their metadata. operationId: list_templates parameters: - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateListItem' title: Response List Templates '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/templates/{template_id}: get: tags: - templates summary: Get Template description: Retrieve detailed information and DAG for a specific template. operationId: get_template parameters: - name: template_id in: path required: true schema: type: string title: Template Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TemplateDetail' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/workflows/: post: tags: - workflows summary: Create Workflow description: Create a new workflow, either custom or auto, and configure its settings. operationId: create_workflow parameters: - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkflow' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - workflows summary: List Workflows description: Retrieve a list of workflows, optionally filtered by source, destination, state, name, date range, and supports pagination and sorting. operationId: list_workflows parameters: - name: dag_node_configuration_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Dag Node Configuration Id - name: source_id in: query required: false schema: anyOf: - type: string format: uuid - type: string - type: 'null' title: Source Id - name: destination_id in: query required: false schema: anyOf: - type: string format: uuid - type: string - type: 'null' title: Destination Id - name: status in: query required: false schema: anyOf: - $ref: '#/components/schemas/WorkflowState' - type: 'null' title: Status - name: page in: query required: false schema: anyOf: - type: integer - type: 'null' default: 1 title: Page - name: page_size in: query required: false schema: anyOf: - type: integer - type: 'null' default: 20 title: Page Size - name: created_since in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created Since - name: created_before in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created Before - name: name in: query required: false schema: anyOf: - type: string - type: 'null' title: Name - name: sort_by in: query required: false schema: type: string default: id title: Sort By - name: sort_direction in: query required: false schema: $ref: '#/components/schemas/SortDirection' default: asc - name: show_only_soft_deleted in: query required: false schema: anyOf: - type: boolean - type: 'null' default: false title: Show Only Soft Deleted - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/WorkflowInformation' title: Response List Workflows '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/workflows/{workflow_id}: get: tags: - workflows summary: Get Workflow description: Retrieve detailed information for a specific workflow by its ID. operationId: get_workflow parameters: - name: workflow_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Workflow Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' put: tags: - workflows summary: Update Workflow description: Update an existing workflow's name, connectors, schedule, or workflow type. operationId: update_workflow parameters: - name: workflow_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Workflow Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflow' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - workflows summary: Delete Workflow description: Delete a workflow by its ID. operationId: delete_workflow parameters: - name: workflow_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Workflow Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/workflows/{workflow_id}/run: post: tags: - workflows summary: Run Workflow description: Run a workflow by triggering a new job if none is currently active. operationId: run_workflow parameters: - name: workflow_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Workflow Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_run_workflow' responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobInformation' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/workflows/{workflow_id}/notifications/channels: get: tags: - workflows - workflow-channels summary: List Workflow Channels description: 'List workflow-scoped notification channels. Returns all channel configurations for the specified workflow. channel_type is required - no cross-type aggregation.' operationId: list_workflow_channels_api_v1_workflows__workflow_id__notifications_channels_get parameters: - name: workflow_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Workflow Id - name: channel_type in: query required: true schema: $ref: '#/components/schemas/ChannelType' - name: enabled in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Enabled - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ChannelListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - workflows - workflow-channels summary: Create Workflow Channel description: 'Create workflow-scoped notification channel. Creates a new delivery channel for receiving platform event notifications scoped to the specified workflow.' operationId: create_workflow_channel_api_v1_workflows__workflow_id__notifications_channels_post parameters: - name: workflow_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Workflow Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/CreateWebhookChannelRequest' - $ref: '#/components/schemas/CreateEmailChannelRequest' discriminator: propertyName: channel_type mapping: webhook: '#/components/schemas/CreateWebhookChannelRequest' email: '#/components/schemas/CreateEmailChannelRequest' title: Data responses: '201': description: Successful Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/WebhookChannelResponse' - $ref: '#/components/schemas/EmailChannelResponse' discriminator: propertyName: channel_type mapping: webhook: '#/components/schemas/WebhookChannelResponse' email: '#/components/schemas/EmailChannelResponse' title: Response Create Workflow Channel Api V1 Workflows Workflow Id Notifications Channels Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/workflows/{workflow_id}/notifications/channels/{channel_id}: get: tags: - workflows - workflow-channels summary: Get Workflow Channel description: Get workflow-scoped notification channel by ID. operationId: get_workflow_channel_api_v1_workflows__workflow_id__notifications_channels__channel_id__get parameters: - name: workflow_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Workflow Id - name: channel_id in: path required: true schema: type: string title: Channel Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '200': description: Successful Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/WebhookChannelResponse' - $ref: '#/components/schemas/EmailChannelResponse' discriminator: propertyName: channel_type mapping: webhook: '#/components/schemas/WebhookChannelResponse' email: '#/components/schemas/EmailChannelResponse' title: Response Get Workflow Channel Api V1 Workflows Workflow Id Notifications Channels Channel Id Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - workflows - workflow-channels summary: Update Workflow Channel description: 'Update workflow-scoped notification channel. Updates an existing channel. Only provided fields are updated.' operationId: update_workflow_channel_api_v1_workflows__workflow_id__notifications_channels__channel_id__patch parameters: - name: workflow_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Workflow Id - name: channel_id in: path required: true schema: type: string title: Channel Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateChannelRequest' responses: '200': description: Successful Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/WebhookChannelResponse' - $ref: '#/components/schemas/EmailChannelResponse' discriminator: propertyName: channel_type mapping: webhook: '#/components/schemas/WebhookChannelResponse' email: '#/components/schemas/EmailChannelResponse' title: Response Update Workflow Channel Api V1 Workflows Workflow Id Notifications Channels Channel Id Patch '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - workflows - workflow-channels summary: Delete Workflow Channel description: Delete workflow-scoped notification channel. operationId: delete_workflow_channel_api_v1_workflows__workflow_id__notifications_channels__channel_id__delete parameters: - name: workflow_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Workflow Id - name: channel_id in: path required: true schema: type: string title: Channel Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /api/v1/workflows/{workflow_id}/notifications/channels/{channel_id}/verify: post: tags: - workflows - workflow-channels summary: Verify Workflow Channel description: 'Verify a workflow-scoped notification channel using a verification code. Email channels require verification by providing the 6-digit code sent to the recipient email address during channel creation.' operationId: verify_workflow_channel_api_v1_workflows__workflow_id__notifications_channels__channel_id__verify_post parameters: - name: workflow_id in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Workflow Id - name: channel_id in: path required: true schema: type: string title: Channel Id - name: unstructured-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: Unstructured-Api-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VerifyChannelRequest' responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: AstraDBConnectorConfig: properties: collection_name: type: string title: Collection Name keyspace: anyOf: - type: string - type: 'null' title: Keyspace batch_size: type: integer title: Batch Size binary_encode_vectors: type: boolean title: Binary Encode Vectors default: true api_endpoint: type: string title: Api Endpoint token: type: string title: Token additionalProperties: true type: object required: - collection_name - batch_size - api_endpoint - token title: AstraDBConnectorConfig AstraDBConnectorConfigInput: properties: collection_name: type: string pattern: ^\w+$ title: Collection Name keyspace: anyOf: - type: string - type: 'null' title: Keyspace default: default_keyspace batch_size: type: integer minimum: 1.0 title: Batch Size default: 20 binary_encode_vectors: type: boolean title: Binary Encode Vectors default: true api_endpoint: type: string title: Api Endpoint token: type: string title: Token flatten_metadata: type: boolean title: Flatten Metadata default: false additionalProperties: true type: object required: - collection_name - api_endpoint - token title: AstraDBConnectorConfigInput AzureDestinationConnectorConfig: properties: remote_url: type: string title: Remote Url account_name: anyOf: - type: string - type: 'null' title: Account Name account_key: anyOf: - type: string - type: 'null' title: Account Key connection_string: anyOf: - type: string - type: 'null' title: Connection String sas_token: anyOf: - type: string - type: 'null' title: Sas Token additionalProperties: true type: object required: - remote_url title: AzureDestinationConnectorConfig AzureDestinationConnectorConfigInput: properties: remote_url: type: string pattern: ^(az:\/\/|abfs:\/\/) title: Remote Url account_name: anyOf: - type: string - type: 'null' title: Account Name account_key: anyOf: - type: string - type: 'null' title: Account Key connection_string: anyOf: - type: string - type: 'null' title: Connection String sas_token: anyOf: - type: string - type: 'null' title: Sas Token additionalProperties: true type: object required: - remote_url title: AzureDestinationConnectorConfigInput AzureSourceConnectorConfig: properties: remote_url: type: string title: Remote Url account_name: anyOf: - type: string - type: 'null' title: Account Name account_key: anyOf: - type: string - type: 'null' title: Account Key connection_string: anyOf: - type: string - type: 'null' title: Connection String sas_token: anyOf: - type: string - type: 'null' title: Sas Token recursive: type: boolean title: Recursive additionalProperties: true type: object required: - remote_url - recursive title: AzureSourceConnectorConfig AzureSourceConnectorConfigInput: properties: remote_url: type: string pattern: ^(az:\/\/|abfs:\/\/) title: Remote Url account_name: anyOf: - type: string - type: 'null' title: Account Name account_key: anyOf: - type: string - type: 'null' title: Account Key connection_string: anyOf: - type: string - type: 'null' title: Connection String sas_token: anyOf: - type: string - type: 'null' title: Sas Token recursive: type: boolean title: Recursive default: true additionalProperties: true type: object required: - remote_url title: AzureSourceConnectorConfigInput Body_create_job: properties: input_files: anyOf: - items: type: string contentMediaType: application/octet-stream type: array - type: 'null' title: Input Files request_data: type: string title: Request Data type: object required: - request_data title: Body_create_job Body_run_workflow: properties: input_files: anyOf: - items: type: string contentMediaType: application/octet-stream type: array - type: 'null' title: Input Files type: object title: Body_run_workflow BoxSourceConnectorConfig: properties: box_app_config: anyOf: - type: string - type: 'null' title: Box App Config access_token: anyOf: - type: string - type: 'null' title: Access Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token recursive: type: boolean title: Recursive additionalProperties: true type: object required: - recursive title: BoxSourceConnectorConfig BoxSourceConnectorConfigInput: properties: box_app_config: anyOf: - type: string - type: 'null' title: Box App Config access_token: anyOf: - type: string - type: 'null' title: Access Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token remote_url: type: string pattern: ^box:\/\/ title: Remote Url recursive: type: boolean title: Recursive default: true additionalProperties: true type: object required: - remote_url title: BoxSourceConnectorConfigInput ChannelListResponse: properties: items: items: oneOf: - $ref: '#/components/schemas/WebhookChannelResponse' - $ref: '#/components/schemas/EmailChannelResponse' discriminator: propertyName: channel_type mapping: email: '#/components/schemas/EmailChannelResponse' webhook: '#/components/schemas/WebhookChannelResponse' type: array title: Items description: List of channels type: object required: - items title: ChannelListResponse description: List response for notification channels (no pagination, max 50 per scope). ChannelType: type: string enum: - webhook - email title: ChannelType description: Notification delivery channel types. ConfluenceSourceConnectorConfig: properties: url: type: string title: Url username: anyOf: - type: string - type: 'null' title: Username cloud_id: anyOf: - type: string - type: 'null' title: Cloud Id password: anyOf: - type: string - type: 'null' title: Password api_token: anyOf: - type: string - type: 'null' title: Api Token token: anyOf: - type: string - type: 'null' title: Token oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token cloud: type: boolean title: Cloud extract_images: type: boolean title: Extract Images default: false extract_files: type: boolean title: Extract Files default: false max_num_of_spaces: type: integer title: Max Num Of Spaces max_num_of_docs_from_each_space: type: integer title: Max Num Of Docs From Each Space spaces: anyOf: - items: type: string type: array - type: 'null' title: Spaces additionalProperties: true type: object required: - url - cloud - max_num_of_spaces - max_num_of_docs_from_each_space - spaces title: ConfluenceSourceConnectorConfig ConfluenceSourceConnectorConfigInput: properties: url: type: string title: Url username: anyOf: - type: string - type: 'null' title: Username cloud_id: anyOf: - type: string - type: 'null' title: Cloud Id password: anyOf: - type: string - type: 'null' title: Password api_token: anyOf: - type: string - type: 'null' title: Api Token token: anyOf: - type: string - type: 'null' title: Token oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token cloud: type: boolean title: Cloud default: false extract_images: type: boolean title: Extract Images default: false extract_files: type: boolean title: Extract Files default: false max_num_of_spaces: type: integer minimum: 1.0 title: Max Num Of Spaces default: 500 max_num_of_docs_from_each_space: type: integer minimum: 1.0 title: Max Num Of Docs From Each Space default: 150 spaces: anyOf: - items: type: string type: array - type: 'null' title: Spaces additionalProperties: true type: object required: - url title: ConfluenceSourceConnectorConfigInput ConnectionCheckStatus: type: string enum: - SCHEDULED - SUCCESS - FAILURE title: ConnectionCheckStatus CouchbaseDestinationConnectorConfig: properties: bucket: type: string title: Bucket connection_string: type: string title: Connection String scope: anyOf: - type: string - type: 'null' title: Scope collection: anyOf: - type: string - type: 'null' title: Collection batch_size: type: integer title: Batch Size username: type: string title: Username password: type: string title: Password additionalProperties: true type: object required: - bucket - connection_string - batch_size - username - password title: CouchbaseDestinationConnectorConfig CouchbaseDestinationConnectorConfigInput: properties: bucket: type: string title: Bucket connection_string: type: string title: Connection String scope: anyOf: - type: string - type: 'null' title: Scope collection: anyOf: - type: string - type: 'null' title: Collection batch_size: type: integer title: Batch Size username: type: string title: Username password: type: string title: Password additionalProperties: true type: object required: - bucket - connection_string - batch_size - username - password title: CouchbaseDestinationConnectorConfigInput CouchbaseSourceConnectorConfig: properties: bucket: type: string title: Bucket connection_string: type: string title: Connection String scope: anyOf: - type: string - type: 'null' title: Scope collection: anyOf: - type: string - type: 'null' title: Collection batch_size: type: integer title: Batch Size username: type: string title: Username password: type: string title: Password collection_id: type: string title: Collection Id additionalProperties: true type: object required: - bucket - connection_string - batch_size - username - password - collection_id title: CouchbaseSourceConnectorConfig CouchbaseSourceConnectorConfigInput: properties: bucket: type: string title: Bucket connection_string: type: string title: Connection String scope: anyOf: - type: string - type: 'null' title: Scope collection: anyOf: - type: string - type: 'null' title: Collection batch_size: type: integer title: Batch Size username: type: string title: Username password: type: string title: Password collection_id: type: string title: Collection Id additionalProperties: true type: object required: - bucket - connection_string - batch_size - username - password - collection_id title: CouchbaseSourceConnectorConfigInput CreateDestinationConnector: properties: name: type: string title: Name type: anyOf: - $ref: '#/components/schemas/DestinationConnectorType' - type: string title: Type config: anyOf: - $ref: '#/components/schemas/AstraDBConnectorConfigInput' - $ref: '#/components/schemas/CouchbaseDestinationConnectorConfigInput' - $ref: '#/components/schemas/DatabricksVolumesConnectorConfigInput' - $ref: '#/components/schemas/DatabricksVDTDestinationConnectorConfigInput' - $ref: '#/components/schemas/DeltaTableConnectorConfigInput' - $ref: '#/components/schemas/ElasticsearchConnectorConfigInput' - $ref: '#/components/schemas/GCSDestinationConnectorConfigInput' - $ref: '#/components/schemas/KafkaCloudDestinationConnectorConfigInput' - $ref: '#/components/schemas/MilvusDestinationConnectorConfigInput' - $ref: '#/components/schemas/MongoDBConnectorConfigInput' - $ref: '#/components/schemas/Neo4jDestinationConnectorConfigInput' - $ref: '#/components/schemas/OneDriveDestinationConnectorConfigInput' - $ref: '#/components/schemas/PineconeDestinationConnectorConfigInput' - $ref: '#/components/schemas/PostgresDestinationConnectorConfigInput' - $ref: '#/components/schemas/RedisDestinationConnectorConfigInput' - $ref: '#/components/schemas/QdrantCloudDestinationConnectorConfigInput' - $ref: '#/components/schemas/SnowflakeDestinationConnectorConfigInput' - $ref: '#/components/schemas/TeradataDestinationConnectorConfigInput' - $ref: '#/components/schemas/WeaviateDestinationConnectorConfigInput' - $ref: '#/components/schemas/IBMWatsonxS3DestinationConnectorConfigInput' - $ref: '#/components/schemas/S3DestinationConnectorConfigInput' - $ref: '#/components/schemas/AzureDestinationConnectorConfigInput' - additionalProperties: true type: object title: Config key: anyOf: - type: string maxLength: 63 minLength: 1 pattern: ^[a-z0-9](-?[a-z0-9])*$ - type: 'null' title: Key description: Stable identifier for the destination connector, used for cross-environment export. If omitted, derived from `name` with a 6-hex-digit suffix. Immutable once set. 1-63 characters, lowercase alphanumeric and hyphens, no consecutive/leading/trailing hyphens. examples: - s3-output-destination type: object required: - name - type - config title: CreateDestinationConnector CreateEmailChannelRequest: properties: channel_type: type: string const: email title: Channel Type default: email description: anyOf: - type: string maxLength: 255 - type: 'null' title: Description description: Channel description event_types: items: $ref: '#/components/schemas/NotificationEventType' type: array minItems: 1 title: Event Types description: Event types to subscribe to enabled: type: boolean title: Enabled description: Enable/disable channel default: true email_config: $ref: '#/components/schemas/EmailChannelConfig' description: Email channel configuration type: object required: - event_types - email_config title: CreateEmailChannelRequest description: Request to create an email notification channel. CreateSourceConnector: properties: name: type: string title: Name type: anyOf: - $ref: '#/components/schemas/SourceConnectorType' - type: string title: Type config: anyOf: - $ref: '#/components/schemas/BoxSourceConnectorConfigInput' - $ref: '#/components/schemas/ConfluenceSourceConnectorConfigInput' - $ref: '#/components/schemas/CouchbaseSourceConnectorConfigInput' - $ref: '#/components/schemas/DatabricksVolumesConnectorConfigInput' - $ref: '#/components/schemas/DropboxSourceConnectorConfigInput' - $ref: '#/components/schemas/ElasticsearchConnectorConfigInput' - $ref: '#/components/schemas/GCSSourceConnectorConfigInput' - $ref: '#/components/schemas/GoogleDriveSourceConnectorConfigInput' - $ref: '#/components/schemas/KafkaCloudSourceConnectorConfigInput' - $ref: '#/components/schemas/MongoDBConnectorConfigInput' - $ref: '#/components/schemas/OneDriveSourceConnectorConfigInput' - $ref: '#/components/schemas/OutlookSourceConnectorConfigInput' - $ref: '#/components/schemas/PostgresSourceConnectorConfigInput' - $ref: '#/components/schemas/SalesforceSourceConnectorConfigInput' - $ref: '#/components/schemas/SharePointSourceConnectorConfigInput' - $ref: '#/components/schemas/SlackSourceConnectorConfigInput' - $ref: '#/components/schemas/SnowflakeSourceConnectorConfigInput' - $ref: '#/components/schemas/TeradataSourceConnectorConfigInput' - $ref: '#/components/schemas/JiraSourceConnectorConfigInput' - $ref: '#/components/schemas/ZendeskSourceConnectorConfigInput' - $ref: '#/components/schemas/S3SourceConnectorConfigInput' - $ref: '#/components/schemas/AzureSourceConnectorConfigInput' - additionalProperties: true type: object title: Config key: anyOf: - type: string maxLength: 63 minLength: 1 pattern: ^[a-z0-9](-?[a-z0-9])*$ - type: 'null' title: Key description: Stable identifier for the source connector, used for cross-environment export. If omitted, derived from `name` with a 6-hex-digit suffix. Immutable once set. 1-63 characters, lowercase alphanumeric and hyphens, no consecutive/leading/trailing hyphens. examples: - s3-invoices-source type: object required: - name - type - config title: CreateSourceConnector CreateWebhookChannelRequest: properties: channel_type: type: string const: webhook title: Channel Type default: webhook description: anyOf: - type: string maxLength: 255 - type: 'null' title: Description description: Channel description event_types: items: $ref: '#/components/schemas/NotificationEventType' type: array minItems: 1 title: Event Types description: Event types to subscribe to enabled: type: boolean title: Enabled description: Enable/disable channel default: true url: type: string title: Url description: Webhook endpoint URL (HTTPS required) secret: anyOf: - type: string - type: 'null' title: Secret description: Consumer-supplied signing secret (24-75 bytes) type: object required: - event_types - url title: CreateWebhookChannelRequest description: Request to create a webhook notification channel. CreateWorkflow: properties: name: type: string title: Name source_id: anyOf: - type: string format: uuid - type: string - type: 'null' title: Source Id destination_id: anyOf: - type: string format: uuid - type: string - type: 'null' title: Destination Id workflow_type: $ref: '#/components/schemas/WorkflowType' workflow_nodes: anyOf: - items: $ref: '#/components/schemas/WorkflowNode' type: array - type: 'null' title: Workflow Nodes template_id: anyOf: - type: string - type: 'null' title: Template Id schedule: anyOf: - type: string enum: - every 15 minutes - every hour - every 2 hours - every 4 hours - every 6 hours - every 8 hours - every 10 hours - every 12 hours - daily - weekly - monthly - type: 'null' title: Schedule reprocess_all: anyOf: - type: boolean - type: 'null' title: Reprocess All default: false key: anyOf: - type: string maxLength: 63 minLength: 1 pattern: ^[a-z0-9](-?[a-z0-9])*$ - type: 'null' title: Key description: Stable workspace level identifier for the workflow. If omitted, derived from `name`. Immutable once set. 1-63 characters, lowercase alphanumeric and hyphens, no consecutive/leading/trailing hyphens. examples: - invoice-processing-v2 type: object required: - name - workflow_type title: CreateWorkflow CronTabEntry: properties: cron_expression: type: string title: Cron Expression type: object required: - cron_expression title: CronTabEntry DagNodeConnectionCheck: properties: id: type: string format: uuid title: Id status: $ref: '#/components/schemas/ConnectionCheckStatus' reason: anyOf: - type: string - type: 'null' title: Reason created_at: type: string format: date-time title: Created At reported_at: anyOf: - type: string format: date-time - type: 'null' title: Reported At type: object required: - id - status - created_at title: DagNodeConnectionCheck DatabricksVDTDestinationConnectorConfig: properties: server_hostname: type: string title: Server Hostname http_path: type: string title: Http Path token: anyOf: - type: string - type: 'null' title: Token client_id: anyOf: - type: string - type: 'null' title: Client Id client_secret: anyOf: - type: string - type: 'null' title: Client Secret catalog: type: string title: Catalog database: type: string title: Database default: default table_name: anyOf: - type: string - type: 'null' title: Table Name schema: type: string title: Schema default: default volume: type: string title: Volume volume_path: anyOf: - type: string - type: 'null' title: Volume Path additionalProperties: true type: object required: - server_hostname - http_path - catalog - volume title: DatabricksVDTDestinationConnectorConfig DatabricksVDTDestinationConnectorConfigInput: properties: server_hostname: type: string title: Server Hostname http_path: type: string title: Http Path token: anyOf: - type: string - type: 'null' title: Token client_id: anyOf: - type: string - type: 'null' title: Client Id client_secret: anyOf: - type: string - type: 'null' title: Client Secret catalog: type: string title: Catalog database: type: string title: Database default: default table_name: anyOf: - type: string - type: 'null' title: Table Name schema: type: string title: Schema default: default volume: type: string title: Volume volume_path: anyOf: - type: string - type: 'null' title: Volume Path additionalProperties: true type: object required: - server_hostname - http_path - catalog - volume title: DatabricksVDTDestinationConnectorConfigInput DatabricksVolumesConnectorConfig: properties: host: type: string title: Host catalog: type: string title: Catalog schema: type: string title: Schema default: default volume: type: string title: Volume volume_path: type: string title: Volume Path client_secret: type: string title: Client Secret client_id: type: string title: Client Id additionalProperties: true type: object required: - host - catalog - volume - volume_path - client_secret - client_id title: DatabricksVolumesConnectorConfig DatabricksVolumesConnectorConfigInput: properties: host: type: string title: Host catalog: type: string title: Catalog schema: type: string title: Schema default: default volume: type: string title: Volume volume_path: type: string title: Volume Path client_secret: type: string title: Client Secret client_id: type: string title: Client Id additionalProperties: true type: object required: - host - catalog - volume - volume_path - client_secret - client_id title: DatabricksVolumesConnectorConfigInput DeltaTableConnectorConfig: properties: aws_access_key_id: type: string title: Aws Access Key Id aws_secret_access_key: type: string title: Aws Secret Access Key aws_region: type: string title: Aws Region table_uri: type: string title: Table Uri additionalProperties: true type: object required: - aws_access_key_id - aws_secret_access_key - aws_region - table_uri title: DeltaTableConnectorConfig DeltaTableConnectorConfigInput: properties: aws_access_key_id: type: string title: Aws Access Key Id aws_secret_access_key: type: string title: Aws Secret Access Key aws_region: type: string title: Aws Region table_uri: type: string pattern: ^s3:\/\/ title: Table Uri additionalProperties: true type: object required: - aws_access_key_id - aws_secret_access_key - aws_region - table_uri title: DeltaTableConnectorConfigInput DestinationConnectorInformation: properties: id: type: string format: uuid title: Id name: type: string title: Name type: anyOf: - $ref: '#/components/schemas/DestinationConnectorType' - type: string title: Type config: anyOf: - $ref: '#/components/schemas/AstraDBConnectorConfig' - $ref: '#/components/schemas/CouchbaseDestinationConnectorConfig' - $ref: '#/components/schemas/DatabricksVolumesConnectorConfig' - $ref: '#/components/schemas/DatabricksVDTDestinationConnectorConfig' - $ref: '#/components/schemas/DeltaTableConnectorConfig' - $ref: '#/components/schemas/ElasticsearchConnectorConfig' - $ref: '#/components/schemas/GCSDestinationConnectorConfig' - $ref: '#/components/schemas/KafkaCloudDestinationConnectorConfig' - $ref: '#/components/schemas/MilvusDestinationConnectorConfig' - $ref: '#/components/schemas/MongoDBConnectorConfig' - $ref: '#/components/schemas/Neo4jDestinationConnectorConfig' - $ref: '#/components/schemas/OneDriveDestinationConnectorConfig' - $ref: '#/components/schemas/PineconeDestinationConnectorConfig' - $ref: '#/components/schemas/PostgresDestinationConnectorConfig' - $ref: '#/components/schemas/RedisDestinationConnectorConfig' - $ref: '#/components/schemas/QdrantCloudDestinationConnectorConfig' - $ref: '#/components/schemas/SnowflakeDestinationConnectorConfig' - $ref: '#/components/schemas/TeradataDestinationConnectorConfig' - $ref: '#/components/schemas/WeaviateDestinationConnectorConfig' - $ref: '#/components/schemas/IBMWatsonxS3DestinationConnectorConfig' - $ref: '#/components/schemas/S3DestinationConnectorConfig' - $ref: '#/components/schemas/AzureDestinationConnectorConfig' - additionalProperties: true type: object title: Config created_at: type: string format: date-time title: Created At updated_at: anyOf: - type: string format: date-time - type: 'null' title: Updated At key: anyOf: - type: string - type: 'null' title: Key type: object required: - id - name - type - config - created_at title: DestinationConnectorInformation DestinationConnectorType: type: string enum: - astradb - couchbase - databricks_volumes - databricks_volume_delta_tables - delta_table - elasticsearch - gcs - kafka-cloud - milvus - mongodb - motherduck - neo4j - onedrive - pinecone - postgres - redis - qdrant-cloud - snowflake - teradata - weaviate-cloud - ibm_watsonx_s3 - s3 - azure title: DestinationConnectorType DropboxSourceConnectorConfig: properties: token: type: string title: Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token remote_url: type: string title: Remote Url recursive: type: boolean title: Recursive additionalProperties: true type: object required: - token - remote_url - recursive title: DropboxSourceConnectorConfig DropboxSourceConnectorConfigInput: properties: token: type: string title: Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token remote_url: type: string pattern: ^dropbox:\/\/ title: Remote Url recursive: type: boolean title: Recursive default: true additionalProperties: true type: object required: - token - remote_url title: DropboxSourceConnectorConfigInput ElasticsearchConnectorConfig: properties: hosts: items: type: string type: array title: Hosts index_name: type: string title: Index Name es_api_key: type: string title: Es Api Key additionalProperties: true type: object required: - hosts - index_name - es_api_key title: ElasticsearchConnectorConfig ElasticsearchConnectorConfigInput: properties: hosts: items: type: string type: array title: Hosts index_name: type: string title: Index Name es_api_key: type: string title: Es Api Key additionalProperties: true type: object required: - hosts - index_name - es_api_key title: ElasticsearchConnectorConfigInput EmailChannelConfig: properties: cc: anyOf: - items: type: string format: email type: array - type: 'null' title: Cc description: CC email addresses (if provider supports) reply_to: anyOf: - type: string format: email - type: 'null' title: Reply To description: Reply-to email address recipient_email: type: string format: email title: Recipient Email description: Primary recipient email address type: object required: - recipient_email title: EmailChannelConfig description: User-configurable email settings. EmailChannelConfigResponse: properties: cc: anyOf: - items: type: string format: email type: array - type: 'null' title: Cc description: CC email addresses (if provider supports) reply_to: anyOf: - type: string format: email - type: 'null' title: Reply To description: Reply-to email address recipient_email: type: string format: email title: Recipient Email description: Primary recipient email address provider: type: string title: Provider description: Email provider (read-only, from platform config) type: object required: - recipient_email - provider title: EmailChannelConfigResponse description: Email config in response (no sensitive data). EmailChannelConfigUpdate: properties: cc: anyOf: - items: type: string format: email type: array - type: 'null' title: Cc description: CC email addresses (if provider supports) reply_to: anyOf: - type: string format: email - type: 'null' title: Reply To description: Reply-to email address recipient_email: anyOf: - type: string format: email - type: 'null' title: Recipient Email description: Primary recipient email address type: object title: EmailChannelConfigUpdate description: User-configurable email settings. EmailChannelResponse: properties: channel_type: type: string const: email title: Channel Type default: email id: type: string title: Id description: Channel ID description: anyOf: - type: string - type: 'null' title: Description description: Channel description event_types: items: type: string type: array title: Event Types description: Subscribed event types enabled: type: boolean title: Enabled description: Channel enabled status created_at: type: string format: date-time title: Created At description: Creation timestamp updated_at: type: string format: date-time title: Updated At description: Last update timestamp email_config: $ref: '#/components/schemas/EmailChannelConfigResponse' description: Email channel configuration type: object required: - id - event_types - enabled - created_at - updated_at - email_config title: EmailChannelResponse description: Response for email notification channel. EncryptionType: type: string enum: - rsa - rsa_aes - runtime_config title: EncryptionType FailedFile: properties: document: type: string title: Document error: type: string title: Error type: object required: - document - error title: FailedFile GCSDestinationConnectorConfig: properties: remote_url: type: string title: Remote Url service_account_key: type: string title: Service Account Key additionalProperties: true type: object required: - remote_url - service_account_key title: GCSDestinationConnectorConfig GCSDestinationConnectorConfigInput: properties: remote_url: type: string pattern: ^(gs|gcs):\/\/ title: Remote Url service_account_key: type: string title: Service Account Key additionalProperties: true type: object required: - remote_url - service_account_key title: GCSDestinationConnectorConfigInput GCSSourceConnectorConfig: properties: remote_url: type: string title: Remote Url service_account_key: anyOf: - $ref: '#/components/schemas/SecretReference' - type: string - type: 'null' title: Service Account Key recursive: type: boolean title: Recursive oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token oauth_client_id: anyOf: - type: string - type: 'null' title: Oauth Client Id oauth_client_secret: anyOf: - type: string - type: 'null' title: Oauth Client Secret additionalProperties: true type: object required: - remote_url - recursive title: GCSSourceConnectorConfig GCSSourceConnectorConfigInput: properties: remote_url: type: string pattern: ^(gs|gcs):\/\/ title: Remote Url service_account_key: anyOf: - $ref: '#/components/schemas/SecretReference' - type: string - type: 'null' title: Service Account Key recursive: type: boolean title: Recursive default: true oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token oauth_client_id: anyOf: - type: string - type: 'null' title: Oauth Client Id oauth_client_secret: anyOf: - type: string - type: 'null' title: Oauth Client Secret additionalProperties: true type: object required: - remote_url title: GCSSourceConnectorConfigInput GoogleDriveSourceConnectorConfig: properties: drive_id: type: string title: Drive Id service_account_key: anyOf: - $ref: '#/components/schemas/SecretReference' - type: string - type: 'null' title: Service Account Key oauth_token: anyOf: - $ref: '#/components/schemas/SecretReference' - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token extensions: anyOf: - items: type: string type: array - type: 'null' title: Extensions recursive: type: boolean title: Recursive additionalProperties: true type: object required: - drive_id - recursive title: GoogleDriveSourceConnectorConfig GoogleDriveSourceConnectorConfigInput: properties: drive_id: type: string title: Drive Id service_account_key: anyOf: - $ref: '#/components/schemas/SecretReference' - type: string - type: 'null' title: Service Account Key oauth_token: anyOf: - $ref: '#/components/schemas/SecretReference' - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token extensions: anyOf: - items: type: string type: array - type: 'null' title: Extensions recursive: type: boolean title: Recursive default: true additionalProperties: true type: object required: - drive_id title: GoogleDriveSourceConnectorConfigInput HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError IBMWatsonxS3DestinationConnectorConfig: properties: iam_api_key: type: string title: Iam Api Key access_key_id: type: string title: Access Key Id secret_access_key: type: string title: Secret Access Key iceberg_endpoint: type: string title: Iceberg Endpoint object_storage_endpoint: type: string title: Object Storage Endpoint object_storage_region: type: string title: Object Storage Region catalog: type: string title: Catalog max_retries_connection: type: integer title: Max Retries Connection namespace: type: string title: Namespace table: type: string title: Table max_retries: type: integer title: Max Retries record_id_key: type: string title: Record Id Key additionalProperties: true type: object required: - iam_api_key - access_key_id - secret_access_key - iceberg_endpoint - object_storage_endpoint - object_storage_region - catalog - max_retries_connection - namespace - table - max_retries - record_id_key title: IBMWatsonxS3DestinationConnectorConfig IBMWatsonxS3DestinationConnectorConfigInput: properties: iam_api_key: type: string title: Iam Api Key access_key_id: type: string title: Access Key Id secret_access_key: type: string title: Secret Access Key iceberg_endpoint: type: string title: Iceberg Endpoint object_storage_endpoint: type: string title: Object Storage Endpoint object_storage_region: type: string title: Object Storage Region catalog: type: string title: Catalog max_retries_connection: type: integer maximum: 100.0 minimum: 2.0 title: Max Retries Connection description: Maximum number of retries in case of a connection error default: 10 namespace: type: string title: Namespace table: type: string title: Table max_retries: type: integer maximum: 500.0 minimum: 2.0 title: Max Retries description: Maximum number of retries to upload data default: 50 record_id_key: type: string title: Record Id Key description: Searchable key to find entries for the same record on previous runs default: record_id additionalProperties: true type: object required: - iam_api_key - access_key_id - secret_access_key - iceberg_endpoint - object_storage_endpoint - object_storage_region - catalog - namespace - table title: IBMWatsonxS3DestinationConnectorConfigInput JiraSourceConnectorConfig: properties: url: type: string title: Url username: anyOf: - type: string - type: 'null' title: Username cloud_id: anyOf: - type: string - type: 'null' title: Cloud Id password: anyOf: - type: string - type: 'null' title: Password token: anyOf: - type: string - type: 'null' title: Token oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token cloud: anyOf: - type: boolean - type: 'null' title: Cloud default: false projects: anyOf: - items: type: string type: array - type: 'null' title: Projects boards: anyOf: - items: type: string type: array - type: 'null' title: Boards issues: anyOf: - items: type: string type: array - type: 'null' title: Issues status_filters: anyOf: - items: type: string type: array - type: 'null' title: Status Filters download_attachments: anyOf: - type: boolean - type: 'null' title: Download Attachments default: false additionalProperties: true type: object required: - url title: JiraSourceConnectorConfig JiraSourceConnectorConfigInput: properties: url: type: string title: Url username: anyOf: - type: string - type: 'null' title: Username cloud_id: anyOf: - type: string - type: 'null' title: Cloud Id password: anyOf: - type: string - type: 'null' title: Password token: anyOf: - type: string - type: 'null' title: Token oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token cloud: anyOf: - type: boolean - type: 'null' title: Cloud default: false projects: anyOf: - items: type: string type: array - type: 'null' title: Projects boards: anyOf: - items: type: string type: array - type: 'null' title: Boards issues: anyOf: - items: type: string type: array - type: 'null' title: Issues status_filters: anyOf: - items: type: string type: array - type: 'null' title: Status Filters download_attachments: anyOf: - type: boolean - type: 'null' title: Download Attachments default: false additionalProperties: true type: object required: - url title: JiraSourceConnectorConfigInput JobAggregations: properties: total_docs: type: integer title: Total Docs default: 0 total_docs_succeeded: type: integer title: Total Docs Succeeded default: 0 total_docs_failed: type: integer title: Total Docs Failed default: 0 type: object title: JobAggregations JobDetails: properties: id: type: string format: uuid title: Id processing_status: $ref: '#/components/schemas/JobProcessingStatus' node_stats: items: $ref: '#/components/schemas/JobNodeDetails' type: array title: Node Stats summary: anyOf: - $ref: '#/components/schemas/JobAggregations' - type: 'null' message: anyOf: - type: string - type: 'null' title: Message type: object required: - id - processing_status - node_stats title: JobDetails JobFailedFiles: properties: failed_files: items: $ref: '#/components/schemas/FailedFile' type: array title: Failed Files type: object required: - failed_files title: JobFailedFiles JobInformation: properties: id: type: string format: uuid title: Id workflow_id: type: string format: uuid title: Workflow Id workflow_name: type: string title: Workflow Name status: $ref: '#/components/schemas/JobStatus' created_at: type: string format: date-time title: Created At runtime: anyOf: - type: string format: duration - type: 'null' title: Runtime input_file_ids: anyOf: - items: type: string type: array - type: 'null' title: Input File Ids output_node_files: anyOf: - items: $ref: '#/components/schemas/NodeFileMetadata' type: array - type: 'null' title: Output Node Files job_type: $ref: '#/components/schemas/WorkflowJobType' default: ephemeral type: object required: - id - workflow_id - workflow_name - status - created_at title: JobInformation JobNodeDetails: properties: node_name: anyOf: - type: string - type: 'null' title: Node Name node_type: anyOf: - type: string - type: 'null' title: Node Type node_subtype: anyOf: - type: string - type: 'null' title: Node Subtype ready: type: integer title: Ready in_progress: type: integer title: In Progress success: type: integer title: Success failure: type: integer title: Failure type: object required: - ready - in_progress - success - failure title: JobNodeDetails JobProcessingStatus: type: string enum: - SCHEDULED - IN_PROGRESS - SUCCESS - COMPLETED_WITH_ERRORS - STOPPED - FAILED title: JobProcessingStatus JobStatus: type: string enum: - SCHEDULED - IN_PROGRESS - COMPLETED - STOPPED - FAILED title: JobStatus KafkaCloudDestinationConnectorConfig: properties: bootstrap_servers: type: string title: Bootstrap Servers port: type: integer title: Port group_id: anyOf: - type: string - type: 'null' title: Group Id topic: type: string title: Topic kafka_api_key: type: string title: Kafka Api Key secret: type: string title: Secret batch_size: type: integer title: Batch Size additionalProperties: true type: object required: - bootstrap_servers - port - topic - kafka_api_key - secret - batch_size title: KafkaCloudDestinationConnectorConfig KafkaCloudDestinationConnectorConfigInput: properties: bootstrap_servers: type: string title: Bootstrap Servers port: type: integer minimum: 1.0 title: Port default: 9092 group_id: anyOf: - type: string - type: 'null' title: Group Id topic: type: string title: Topic kafka_api_key: type: string title: Kafka Api Key secret: type: string title: Secret batch_size: type: integer minimum: 1.0 title: Batch Size default: 100 additionalProperties: true type: object required: - bootstrap_servers - topic - kafka_api_key - secret title: KafkaCloudDestinationConnectorConfigInput KafkaCloudSourceConnectorConfig: properties: bootstrap_servers: type: string title: Bootstrap Servers port: type: integer title: Port group_id: anyOf: - type: string - type: 'null' title: Group Id topic: type: string title: Topic kafka_api_key: type: string title: Kafka Api Key secret: type: string title: Secret num_messages_to_consume: type: integer title: Num Messages To Consume additionalProperties: true type: object required: - bootstrap_servers - port - topic - kafka_api_key - secret - num_messages_to_consume title: KafkaCloudSourceConnectorConfig KafkaCloudSourceConnectorConfigInput: properties: bootstrap_servers: type: string title: Bootstrap Servers port: type: integer minimum: 1.0 title: Port default: 9092 group_id: anyOf: - type: string - type: 'null' title: Group Id topic: type: string title: Topic kafka_api_key: type: string title: Kafka Api Key secret: type: string title: Secret num_messages_to_consume: type: integer minimum: 1.0 title: Num Messages To Consume default: 100 additionalProperties: true type: object required: - bootstrap_servers - topic - kafka_api_key - secret title: KafkaCloudSourceConnectorConfigInput MarkReadRequest: properties: notification_ids: anyOf: - items: type: string format: uuid type: array maxItems: 100 - type: 'null' title: Notification Ids description: Specific notification IDs to mark as read (max 100) before: anyOf: - type: string format: date-time - type: 'null' title: Before description: Mark all notifications created before this ISO 8601 timestamp as read mark_all: type: boolean title: Mark All description: Mark all unread notifications as read (can combine with workflow_id) default: false workflow_id: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id description: Filter by workflow (only valid with 'before' or 'mark_all') type: object title: MarkReadRequest description: 'Request to mark notifications as read. Provide ONE of: notification_ids, before, or mark_all (mutually exclusive). workflow_id is valid with ''before'' or ''mark_all''.' MarkReadResponse: properties: marked_count: type: integer title: Marked Count description: Number of events newly marked as read type: object required: - marked_count title: MarkReadResponse description: Response for mark-as-read operation. MilvusDestinationConnectorConfig: properties: uri: type: string title: Uri user: anyOf: - type: string - type: 'null' title: User token: anyOf: - type: string - type: 'null' title: Token password: anyOf: - type: string - type: 'null' title: Password db_name: anyOf: - type: string - type: 'null' title: Db Name collection_name: type: string title: Collection Name record_id_key: type: string title: Record Id Key additionalProperties: true type: object required: - uri - collection_name - record_id_key title: MilvusDestinationConnectorConfig MilvusDestinationConnectorConfigInput: properties: uri: type: string pattern: ^https?:\/\/ title: Uri user: anyOf: - type: string - type: 'null' title: User token: anyOf: - type: string - type: 'null' title: Token password: anyOf: - type: string - type: 'null' title: Password db_name: anyOf: - type: string - type: 'null' title: Db Name collection_name: type: string title: Collection Name record_id_key: type: string title: Record Id Key flatten_metadata: type: boolean title: Flatten Metadata default: true fields_to_include: anyOf: - items: type: string type: array - type: 'null' title: Fields To Include additionalProperties: true type: object required: - uri - collection_name - record_id_key title: MilvusDestinationConnectorConfigInput MongoDBConnectorConfig: properties: database: type: string title: Database collection: type: string title: Collection uri: type: string title: Uri additionalProperties: true type: object required: - database - collection - uri title: MongoDBConnectorConfig MongoDBConnectorConfigInput: properties: database: type: string title: Database collection: type: string title: Collection uri: type: string pattern: ^mongodb(?:\+srv)?:\/\/(?:([^:@/\s]+)(?::([^@/\s]*))?@)?([^/\s:,]+)(?::(\d+))?(?:,([^/\s:,]+)(?::(\d+))?)*(?:\/([^/\s?]*))?(?:\?([^/\s]*))?$ title: Uri additionalProperties: true type: object required: - database - collection - uri title: MongoDBConnectorConfigInput Neo4jDestinationConnectorConfig: properties: uri: type: string title: Uri database: type: string title: Database username: type: string title: Username password: type: string title: Password batch_size: type: integer title: Batch Size additionalProperties: true type: object required: - uri - database - username - password - batch_size title: Neo4jDestinationConnectorConfig Neo4jDestinationConnectorConfigInput: properties: uri: type: string title: Uri database: type: string title: Database username: type: string title: Username password: type: string title: Password batch_size: type: integer minimum: 1.0 title: Batch Size default: 100 additionalProperties: true type: object required: - uri - database - username - password title: Neo4jDestinationConnectorConfigInput NodeFileMetadata: properties: node_id: type: string format: uuid title: Node Id file_id: type: string title: File Id node_type: type: string title: Node Type node_subtype: type: string title: Node Subtype type: object required: - node_id - file_id - node_type - node_subtype title: NodeFileMetadata NotificationEventType: type: string enum: - job.scheduled - job.in_progress - job.progress - job.completed - job.stopped - job.failed title: NotificationEventType description: Webhook event types derived from internal JOB_STATUSCHANGED_V1 statuses. NotificationListResponse: properties: events: items: $ref: '#/components/schemas/NotificationResponse' type: array title: Events description: List of notification events next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: Cursor for next page (null if no more) type: object required: - events title: NotificationListResponse description: Paginated notification list response. NotificationResponse: properties: id: type: string format: uuid title: Id description: Notification event UUID event_type: type: string title: Event Type description: Event type (e.g., job.completed) workflow_id: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id description: Workflow scope (null = account-level) payload: additionalProperties: true type: object title: Payload description: Event payload data created_at: type: string format: date-time title: Created At description: Event creation timestamp is_read: type: boolean title: Is Read description: Read status for current user default: false type: object required: - id - event_type - payload - created_at title: NotificationResponse description: Single notification event. OneDriveDestinationConnectorConfig: properties: client_id: anyOf: - type: string - type: 'null' title: Client Id user_pname: type: string title: User Pname tenant: type: string title: Tenant authority_url: type: string title: Authority Url default: https://login.microsoftonline.com client_cred: anyOf: - type: string - type: 'null' title: Client Cred oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token remote_url: type: string title: Remote Url additionalProperties: true type: object required: - user_pname - tenant - remote_url title: OneDriveDestinationConnectorConfig OneDriveDestinationConnectorConfigInput: properties: client_id: anyOf: - type: string - type: 'null' title: Client Id user_pname: type: string title: User Pname tenant: type: string title: Tenant authority_url: type: string title: Authority Url default: https://login.microsoftonline.com client_cred: anyOf: - type: string - type: 'null' title: Client Cred oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token remote_url: type: string pattern: ^onedrive:\/\/ title: Remote Url additionalProperties: true type: object required: - user_pname - tenant - remote_url title: OneDriveDestinationConnectorConfigInput OneDriveSourceConnectorConfig: properties: client_id: anyOf: - type: string - type: 'null' title: Client Id user_pname: type: string title: User Pname tenant: type: string title: Tenant authority_url: type: string title: Authority Url default: https://login.microsoftonline.com client_cred: anyOf: - type: string - type: 'null' title: Client Cred oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token recursive: type: boolean title: Recursive path: type: string title: Path additionalProperties: true type: object required: - user_pname - tenant - recursive - path title: OneDriveSourceConnectorConfig OneDriveSourceConnectorConfigInput: properties: client_id: anyOf: - type: string - type: 'null' title: Client Id user_pname: type: string title: User Pname tenant: type: string title: Tenant authority_url: type: string title: Authority Url default: https://login.microsoftonline.com client_cred: anyOf: - type: string - type: 'null' title: Client Cred oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token recursive: type: boolean title: Recursive default: false path: type: string title: Path additionalProperties: true type: object required: - user_pname - tenant - path title: OneDriveSourceConnectorConfigInput OutlookSourceConnectorConfig: properties: authority_url: type: string title: Authority Url default: https://login.microsoftonline.com tenant: anyOf: - type: string - type: 'null' title: Tenant client_id: anyOf: - type: string - type: 'null' title: Client Id client_cred: anyOf: - type: string - type: 'null' title: Client Cred oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token outlook_folders: anyOf: - items: type: string type: array - type: 'null' title: Outlook Folders recursive: type: boolean title: Recursive user_email: type: string title: User Email additionalProperties: true type: object required: - recursive - user_email title: OutlookSourceConnectorConfig OutlookSourceConnectorConfigInput: properties: authority_url: type: string title: Authority Url default: https://login.microsoftonline.com tenant: anyOf: - type: string - type: 'null' title: Tenant client_id: anyOf: - type: string - type: 'null' title: Client Id client_cred: anyOf: - type: string - type: 'null' title: Client Cred oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token outlook_folders: anyOf: - items: type: string type: array - type: 'null' title: Outlook Folders recursive: type: boolean title: Recursive default: false user_email: type: string title: User Email additionalProperties: true type: object required: - user_email title: OutlookSourceConnectorConfigInput PineconeDestinationConnectorConfig: properties: index_name: type: string title: Index Name api_key: type: string title: Api Key namespace: type: string title: Namespace batch_size: type: integer title: Batch Size additionalProperties: true type: object required: - index_name - api_key - namespace - batch_size title: PineconeDestinationConnectorConfig PineconeDestinationConnectorConfigInput: properties: index_name: type: string title: Index Name api_key: type: string title: Api Key namespace: type: string title: Namespace batch_size: type: integer minimum: 1.0 title: Batch Size default: 50 additionalProperties: true type: object required: - index_name - api_key - namespace title: PineconeDestinationConnectorConfigInput PostgresDestinationConnectorConfig: properties: host: type: string title: Host database: type: string title: Database port: type: integer title: Port username: type: string title: Username password: type: string title: Password table_name: type: string title: Table Name batch_size: type: integer title: Batch Size additionalProperties: true type: object required: - host - database - port - username - password - table_name - batch_size title: PostgresDestinationConnectorConfig PostgresDestinationConnectorConfigInput: properties: host: type: string title: Host database: type: string title: Database port: type: integer title: Port username: type: string title: Username password: type: string title: Password table_name: type: string title: Table Name batch_size: type: integer title: Batch Size additionalProperties: true type: object required: - host - database - port - username - password - table_name - batch_size title: PostgresDestinationConnectorConfigInput PostgresSourceConnectorConfig: properties: host: type: string title: Host database: type: string title: Database port: type: integer title: Port username: type: string title: Username password: type: string title: Password table_name: type: string title: Table Name batch_size: type: integer title: Batch Size id_column: type: string title: Id Column fields: anyOf: - items: type: string type: array - type: 'null' title: Fields additionalProperties: true type: object required: - host - database - port - username - password - table_name - batch_size - id_column title: PostgresSourceConnectorConfig PostgresSourceConnectorConfigInput: properties: host: type: string title: Host database: type: string title: Database port: type: integer title: Port username: type: string title: Username password: type: string title: Password table_name: type: string title: Table Name batch_size: type: integer title: Batch Size id_column: type: string title: Id Column default: id fields: anyOf: - items: type: string type: array - type: 'null' title: Fields additionalProperties: true type: object required: - host - database - port - username - password - table_name - batch_size title: PostgresSourceConnectorConfigInput QdrantCloudDestinationConnectorConfig: properties: url: type: string title: Url api_key: type: string title: Api Key collection_name: type: string title: Collection Name batch_size: type: integer title: Batch Size additionalProperties: true type: object required: - url - api_key - collection_name - batch_size title: QdrantCloudDestinationConnectorConfig QdrantCloudDestinationConnectorConfigInput: properties: url: type: string title: Url api_key: type: string title: Api Key collection_name: type: string title: Collection Name batch_size: type: integer minimum: 1.0 title: Batch Size default: 50 additionalProperties: true type: object required: - url - api_key - collection_name title: QdrantCloudDestinationConnectorConfigInput RedisDestinationConnectorConfig: properties: host: type: string title: Host port: type: integer title: Port username: anyOf: - type: string - type: 'null' title: Username password: anyOf: - type: string - type: 'null' title: Password uri: anyOf: - type: string - type: 'null' title: Uri database: type: integer title: Database ssl: type: boolean title: Ssl batch_size: type: integer title: Batch Size additionalProperties: true type: object required: - host - port - database - ssl - batch_size title: RedisDestinationConnectorConfig RedisDestinationConnectorConfigInput: properties: host: type: string title: Host port: type: integer minimum: 1.0 title: Port default: 6379 username: anyOf: - type: string - type: 'null' title: Username password: anyOf: - type: string - type: 'null' title: Password uri: anyOf: - type: string - type: 'null' title: Uri database: type: integer minimum: 0.0 title: Database default: 0 ssl: type: boolean title: Ssl default: true batch_size: type: integer minimum: 1.0 title: Batch Size default: 100 additionalProperties: true type: object required: - host title: RedisDestinationConnectorConfigInput S3DestinationConnectorConfig: properties: remote_url: type: string title: Remote Url anonymous: type: boolean title: Anonymous ambient_credentials: anyOf: - type: boolean - type: 'null' title: Ambient Credentials key: anyOf: - type: string - type: 'null' title: Key secret: anyOf: - type: string - type: 'null' title: Secret token: anyOf: - type: string - type: 'null' title: Token endpoint_url: anyOf: - type: string - type: 'null' title: Endpoint Url role_arn: anyOf: - type: string - type: 'null' title: Role Arn external_id: anyOf: - type: string - type: 'null' title: External Id additionalProperties: true type: object required: - remote_url - anonymous title: S3DestinationConnectorConfig S3DestinationConnectorConfigInput: properties: remote_url: type: string pattern: ^s3:\/\/ title: Remote Url anonymous: type: boolean title: Anonymous default: false ambient_credentials: type: boolean title: Ambient Credentials default: false key: anyOf: - type: string - type: 'null' title: Key secret: anyOf: - type: string - type: 'null' title: Secret token: anyOf: - type: string - type: 'null' title: Token endpoint_url: anyOf: - type: string - type: 'null' title: Endpoint Url role_arn: anyOf: - type: string - type: 'null' title: Role Arn external_id: anyOf: - type: string - type: 'null' title: External Id additionalProperties: true type: object required: - remote_url title: S3DestinationConnectorConfigInput S3SourceConnectorConfig: properties: remote_url: type: string title: Remote Url anonymous: type: boolean title: Anonymous ambient_credentials: anyOf: - type: boolean - type: 'null' title: Ambient Credentials key: anyOf: - type: string - type: 'null' title: Key secret: anyOf: - type: string - type: 'null' title: Secret token: anyOf: - type: string - type: 'null' title: Token endpoint_url: anyOf: - type: string - type: 'null' title: Endpoint Url role_arn: anyOf: - type: string - type: 'null' title: Role Arn external_id: anyOf: - type: string - type: 'null' title: External Id recursive: type: boolean title: Recursive additionalProperties: true type: object required: - remote_url - anonymous - recursive title: S3SourceConnectorConfig S3SourceConnectorConfigInput: properties: remote_url: type: string pattern: ^s3:\/\/ title: Remote Url anonymous: type: boolean title: Anonymous default: false ambient_credentials: type: boolean title: Ambient Credentials default: false key: anyOf: - type: string - type: 'null' title: Key secret: anyOf: - type: string - type: 'null' title: Secret token: anyOf: - type: string - type: 'null' title: Token endpoint_url: anyOf: - type: string - type: 'null' title: Endpoint Url role_arn: anyOf: - type: string - type: 'null' title: Role Arn external_id: anyOf: - type: string - type: 'null' title: External Id recursive: type: boolean title: Recursive default: true additionalProperties: true type: object required: - remote_url title: S3SourceConnectorConfigInput SalesforceSourceConnectorConfig: properties: username: type: string title: Username consumer_key: type: string title: Consumer Key private_key: type: string title: Private Key categories: items: type: string type: array title: Categories additionalProperties: true type: object required: - username - consumer_key - private_key - categories title: SalesforceSourceConnectorConfig SalesforceSourceConnectorConfigInput: properties: username: type: string title: Username consumer_key: type: string title: Consumer Key private_key: type: string title: Private Key categories: items: type: string type: array title: Categories additionalProperties: true type: object required: - username - consumer_key - private_key - categories title: SalesforceSourceConnectorConfigInput SecretReference: properties: id: type: string title: Id type: $ref: '#/components/schemas/EncryptionType' default: rsa type: object required: - id title: SecretReference SharePointSourceConnectorConfig: properties: site: type: string title: Site tenant: type: string title: Tenant authority_url: type: string title: Authority Url default: https://login.microsoftonline.com user_pname: anyOf: - type: string - type: 'null' title: User Pname client_id: anyOf: - type: string - type: 'null' title: Client Id client_cred: anyOf: - type: string - type: 'null' title: Client Cred oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token recursive: type: boolean title: Recursive path: anyOf: - type: string - type: 'null' title: Path additionalProperties: true type: object required: - site - tenant - recursive title: SharePointSourceConnectorConfig SharePointSourceConnectorConfigInput: properties: site: type: string pattern: ^https:\/\/[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+(\/(sites|teams)\/[a-zA-Z0-9-_]+)?$ title: Site tenant: type: string title: Tenant authority_url: type: string title: Authority Url default: https://login.microsoftonline.com user_pname: anyOf: - type: string - type: 'null' title: User Pname client_id: anyOf: - type: string - type: 'null' title: Client Id client_cred: anyOf: - type: string - type: 'null' title: Client Cred oauth_token: anyOf: - type: string - type: 'null' title: Oauth Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token recursive: type: boolean title: Recursive default: false path: anyOf: - type: string - type: 'null' title: Path additionalProperties: true type: object required: - site - tenant title: SharePointSourceConnectorConfigInput SlackSourceConnectorConfig: properties: token: type: string title: Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token channels: items: type: string type: array minItems: 1 title: Channels start_date: anyOf: - type: string - type: 'null' title: Start Date end_date: anyOf: - type: string - type: 'null' title: End Date additionalProperties: true type: object required: - token - channels title: SlackSourceConnectorConfig SlackSourceConnectorConfigInput: properties: token: type: string title: Token refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token channels: items: type: string type: array minItems: 1 title: Channels start_date: anyOf: - type: string - type: 'null' title: Start Date end_date: anyOf: - type: string - type: 'null' title: End Date additionalProperties: true type: object required: - token - channels title: SlackSourceConnectorConfigInput SnowflakeDestinationConnectorConfig: properties: account: type: string title: Account role: type: string title: Role user: type: string title: User password: type: string title: Password host: type: string title: Host port: type: integer minimum: 1.0 title: Port default: 443 database: type: string title: Database schema: type: string title: Schema table_name: type: string title: Table Name default: elements batch_size: type: integer minimum: 1.0 title: Batch Size default: 50 record_id_key: anyOf: - type: string - type: 'null' title: Record Id Key default: record_id additionalProperties: true type: object required: - account - role - user - password - host - database - schema title: SnowflakeDestinationConnectorConfig SnowflakeDestinationConnectorConfigInput: properties: account: type: string title: Account role: type: string title: Role user: type: string title: User password: type: string title: Password host: type: string title: Host port: type: integer minimum: 1.0 title: Port default: 443 database: type: string title: Database schema: type: string title: Schema table_name: type: string title: Table Name default: elements batch_size: type: integer minimum: 1.0 title: Batch Size default: 50 record_id_key: anyOf: - type: string - type: 'null' title: Record Id Key default: record_id additionalProperties: true type: object required: - account - role - user - password - host - database - schema title: SnowflakeDestinationConnectorConfigInput SnowflakeSourceConnectorConfig: properties: account: type: string title: Account role: type: string title: Role user: type: string title: User password: type: string title: Password host: type: string title: Host port: type: integer minimum: 1.0 title: Port default: 443 database: type: string title: Database schema: type: string title: Schema table_name: type: string title: Table Name batch_size: type: integer minimum: 1.0 title: Batch Size default: 100 id_column: type: string title: Id Column fields: anyOf: - items: type: string type: array - type: 'null' title: Fields additionalProperties: true type: object required: - account - role - user - password - host - database - schema - table_name - id_column title: SnowflakeSourceConnectorConfig SnowflakeSourceConnectorConfigInput: properties: account: type: string title: Account role: type: string title: Role user: type: string title: User password: type: string title: Password host: type: string title: Host port: type: integer minimum: 1.0 title: Port default: 443 database: type: string title: Database schema: type: string title: Schema table_name: type: string title: Table Name batch_size: type: integer minimum: 1.0 title: Batch Size default: 100 id_column: type: string title: Id Column fields: anyOf: - items: type: string type: array - type: 'null' title: Fields additionalProperties: true type: object required: - account - role - user - password - host - database - schema - table_name - id_column title: SnowflakeSourceConnectorConfigInput SortDirection: type: string enum: - asc - desc title: SortDirection SourceConnectorInformation: properties: id: type: string format: uuid title: Id name: type: string title: Name type: anyOf: - $ref: '#/components/schemas/SourceConnectorType' - type: string title: Type config: anyOf: - $ref: '#/components/schemas/BoxSourceConnectorConfig' - $ref: '#/components/schemas/ConfluenceSourceConnectorConfig' - $ref: '#/components/schemas/CouchbaseSourceConnectorConfig' - $ref: '#/components/schemas/DatabricksVolumesConnectorConfig' - $ref: '#/components/schemas/DropboxSourceConnectorConfig' - $ref: '#/components/schemas/ElasticsearchConnectorConfig' - $ref: '#/components/schemas/GCSSourceConnectorConfig' - $ref: '#/components/schemas/GoogleDriveSourceConnectorConfig' - $ref: '#/components/schemas/KafkaCloudSourceConnectorConfig' - $ref: '#/components/schemas/MongoDBConnectorConfig' - $ref: '#/components/schemas/OneDriveSourceConnectorConfig' - $ref: '#/components/schemas/OutlookSourceConnectorConfig' - $ref: '#/components/schemas/PostgresSourceConnectorConfig' - $ref: '#/components/schemas/SalesforceSourceConnectorConfig' - $ref: '#/components/schemas/SharePointSourceConnectorConfig' - $ref: '#/components/schemas/SlackSourceConnectorConfig' - $ref: '#/components/schemas/SnowflakeSourceConnectorConfig' - $ref: '#/components/schemas/TeradataSourceConnectorConfig' - $ref: '#/components/schemas/JiraSourceConnectorConfig' - $ref: '#/components/schemas/ZendeskSourceConnectorConfig' - $ref: '#/components/schemas/S3SourceConnectorConfig' - $ref: '#/components/schemas/AzureSourceConnectorConfig' - additionalProperties: true type: object title: Config created_at: type: string format: date-time title: Created At updated_at: anyOf: - type: string format: date-time - type: 'null' title: Updated At key: anyOf: - type: string - type: 'null' title: Key type: object required: - id - name - type - config - created_at title: SourceConnectorInformation SourceConnectorType: type: string enum: - box - confluence - couchbase - databricks_volumes - dropbox - elasticsearch - gcs - google_drive - kafka-cloud - mongodb - onedrive - outlook - postgres - salesforce - sharepoint - slack - snowflake - teradata - jira - zendesk - s3 - azure title: SourceConnectorType TemplateDetail: properties: id: type: string title: Id name: type: string title: Name version: type: string title: Version last_updated: type: string title: Last Updated description: type: string title: Description nodes: items: $ref: '#/components/schemas/TemplateNode' type: array title: Nodes type: object required: - id - name - version - last_updated - description - nodes title: TemplateDetail description: Full template details including nodes. TemplateListItem: properties: id: type: string title: Id name: type: string title: Name version: type: string title: Version last_updated: type: string title: Last Updated description: type: string title: Description type: object required: - id - name - version - last_updated - description title: TemplateListItem description: Template metadata for list responses. TemplateNode: properties: id: type: string title: Id name: type: string title: Name type: type: string title: Type subtype: type: string title: Subtype settings: anyOf: - additionalProperties: true type: object - type: 'null' title: Settings type: object required: - id - name - type - subtype title: TemplateNode description: A node in a template DAG. TeradataDestinationConnectorConfig: properties: host: type: string title: Host user: type: string title: User password: type: string title: Password database: anyOf: - type: string - type: 'null' title: Database dbs_port: type: integer minimum: 1.0 title: Dbs Port default: 1025 table_name: type: string title: Table Name default: elements batch_size: type: integer minimum: 1.0 title: Batch Size default: 50 record_id_key: anyOf: - type: string - type: 'null' title: Record Id Key default: record_id additionalProperties: true type: object required: - host - user - password title: TeradataDestinationConnectorConfig TeradataDestinationConnectorConfigInput: properties: host: type: string title: Host user: type: string title: User password: type: string title: Password database: anyOf: - type: string - type: 'null' title: Database dbs_port: type: integer minimum: 1.0 title: Dbs Port default: 1025 table_name: type: string title: Table Name default: elements batch_size: type: integer minimum: 1.0 title: Batch Size default: 50 record_id_key: anyOf: - type: string - type: 'null' title: Record Id Key default: record_id additionalProperties: true type: object required: - host - user - password title: TeradataDestinationConnectorConfigInput TeradataSourceConnectorConfig: properties: host: type: string title: Host user: type: string title: User password: type: string title: Password database: anyOf: - type: string - type: 'null' title: Database dbs_port: type: integer minimum: 1.0 title: Dbs Port default: 1025 id_column: type: string title: Id Column default: id table_name: type: string title: Table Name batch_size: type: integer minimum: 1.0 title: Batch Size default: 100 fields: anyOf: - items: type: string type: array - type: 'null' title: Fields additionalProperties: true type: object required: - host - user - password - table_name title: TeradataSourceConnectorConfig TeradataSourceConnectorConfigInput: properties: host: type: string title: Host user: type: string title: User password: type: string title: Password database: anyOf: - type: string - type: 'null' title: Database dbs_port: type: integer minimum: 1.0 title: Dbs Port default: 1025 id_column: type: string title: Id Column default: id table_name: type: string title: Table Name batch_size: type: integer minimum: 1.0 title: Batch Size default: 100 fields: anyOf: - items: type: string type: array - type: 'null' title: Fields additionalProperties: true type: object required: - host - user - password - table_name title: TeradataSourceConnectorConfigInput UnreadCountResponse: properties: unread_count: type: integer title: Unread Count description: Number of unread events type: object required: - unread_count title: UnreadCountResponse description: Response for unread count query. UpdateChannelRequest: properties: channel_type: anyOf: - $ref: '#/components/schemas/ChannelType' - type: 'null' description: Channel type (immutable) description: anyOf: - type: string maxLength: 255 - type: 'null' title: Description description: Channel description event_types: anyOf: - items: $ref: '#/components/schemas/NotificationEventType' type: array minItems: 1 - type: 'null' title: Event Types description: Event types to subscribe to enabled: anyOf: - type: boolean - type: 'null' title: Enabled description: Enable/disable channel url: anyOf: - type: string - type: 'null' title: Url description: Webhook endpoint URL (HTTPS required) secret: anyOf: - type: string - type: 'null' title: Secret description: Consumer-supplied signing secret (24-75 bytes). Pass empty string to remove custom secret. email_config: anyOf: - $ref: '#/components/schemas/EmailChannelConfigUpdate' - type: 'null' description: Email channel configuration type: object title: UpdateChannelRequest description: Common fields for all channel update requests. UpdateDestinationConnector: properties: config: anyOf: - $ref: '#/components/schemas/AstraDBConnectorConfigInput' - $ref: '#/components/schemas/CouchbaseDestinationConnectorConfigInput' - $ref: '#/components/schemas/DatabricksVolumesConnectorConfigInput' - $ref: '#/components/schemas/DatabricksVDTDestinationConnectorConfigInput' - $ref: '#/components/schemas/DeltaTableConnectorConfigInput' - $ref: '#/components/schemas/ElasticsearchConnectorConfigInput' - $ref: '#/components/schemas/GCSDestinationConnectorConfigInput' - $ref: '#/components/schemas/KafkaCloudDestinationConnectorConfigInput' - $ref: '#/components/schemas/MilvusDestinationConnectorConfigInput' - $ref: '#/components/schemas/MongoDBConnectorConfigInput' - $ref: '#/components/schemas/Neo4jDestinationConnectorConfigInput' - $ref: '#/components/schemas/OneDriveDestinationConnectorConfigInput' - $ref: '#/components/schemas/PineconeDestinationConnectorConfigInput' - $ref: '#/components/schemas/PostgresDestinationConnectorConfigInput' - $ref: '#/components/schemas/RedisDestinationConnectorConfigInput' - $ref: '#/components/schemas/QdrantCloudDestinationConnectorConfigInput' - $ref: '#/components/schemas/SnowflakeDestinationConnectorConfigInput' - $ref: '#/components/schemas/TeradataDestinationConnectorConfigInput' - $ref: '#/components/schemas/WeaviateDestinationConnectorConfigInput' - $ref: '#/components/schemas/IBMWatsonxS3DestinationConnectorConfigInput' - $ref: '#/components/schemas/S3DestinationConnectorConfigInput' - $ref: '#/components/schemas/AzureDestinationConnectorConfigInput' - additionalProperties: true type: object title: Config type: object required: - config title: UpdateDestinationConnector UpdateSourceConnector: properties: config: anyOf: - $ref: '#/components/schemas/BoxSourceConnectorConfigInput' - $ref: '#/components/schemas/ConfluenceSourceConnectorConfigInput' - $ref: '#/components/schemas/CouchbaseSourceConnectorConfigInput' - $ref: '#/components/schemas/DatabricksVolumesConnectorConfigInput' - $ref: '#/components/schemas/DropboxSourceConnectorConfigInput' - $ref: '#/components/schemas/ElasticsearchConnectorConfigInput' - $ref: '#/components/schemas/GCSSourceConnectorConfigInput' - $ref: '#/components/schemas/GoogleDriveSourceConnectorConfigInput' - $ref: '#/components/schemas/KafkaCloudSourceConnectorConfigInput' - $ref: '#/components/schemas/MongoDBConnectorConfigInput' - $ref: '#/components/schemas/OneDriveSourceConnectorConfigInput' - $ref: '#/components/schemas/OutlookSourceConnectorConfigInput' - $ref: '#/components/schemas/PostgresSourceConnectorConfigInput' - $ref: '#/components/schemas/SalesforceSourceConnectorConfigInput' - $ref: '#/components/schemas/SharePointSourceConnectorConfigInput' - $ref: '#/components/schemas/SlackSourceConnectorConfigInput' - $ref: '#/components/schemas/SnowflakeSourceConnectorConfigInput' - $ref: '#/components/schemas/TeradataSourceConnectorConfigInput' - $ref: '#/components/schemas/JiraSourceConnectorConfigInput' - $ref: '#/components/schemas/ZendeskSourceConnectorConfigInput' - $ref: '#/components/schemas/S3SourceConnectorConfigInput' - $ref: '#/components/schemas/AzureSourceConnectorConfigInput' - additionalProperties: true type: object title: Config type: object required: - config title: UpdateSourceConnector UpdateWorkflow: properties: name: anyOf: - type: string - type: 'null' title: Name source_id: anyOf: - type: string format: uuid - type: string - type: 'null' title: Source Id destination_id: anyOf: - type: string format: uuid - type: string - type: 'null' title: Destination Id workflow_type: anyOf: - $ref: '#/components/schemas/WorkflowType' - type: 'null' workflow_nodes: anyOf: - items: $ref: '#/components/schemas/WorkflowNode' type: array - type: 'null' title: Workflow Nodes template_id: anyOf: - type: string - type: 'null' title: Template Id schedule: anyOf: - type: string enum: - every 15 minutes - every hour - every 2 hours - every 4 hours - every 6 hours - every 8 hours - every 10 hours - every 12 hours - daily - weekly - monthly - type: 'null' title: Schedule reprocess_all: anyOf: - type: boolean - type: 'null' title: Reprocess All state: anyOf: - $ref: '#/components/schemas/WorkflowState' - type: 'null' type: object title: UpdateWorkflow ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError VerifyChannelRequest: properties: code: type: string maxLength: 6 minLength: 6 pattern: ^\d{6}$ title: Code description: 6-digit verification code sent to the channel's email address type: object required: - code title: VerifyChannelRequest description: Request to verify an email channel with a verification code. WeaviateDestinationConnectorConfig: properties: cluster_url: type: string title: Cluster Url api_key: type: string title: Api Key collection: anyOf: - type: string - type: 'null' title: Collection additionalProperties: true type: object required: - cluster_url - api_key title: WeaviateDestinationConnectorConfig WeaviateDestinationConnectorConfigInput: properties: cluster_url: type: string title: Cluster Url api_key: type: string title: Api Key collection: anyOf: - type: string - type: 'null' title: Collection additionalProperties: true type: object required: - cluster_url - api_key title: WeaviateDestinationConnectorConfigInput WebhookChannelResponse: properties: channel_type: type: string const: webhook title: Channel Type default: webhook id: type: string title: Id description: Channel ID description: anyOf: - type: string - type: 'null' title: Description description: Channel description event_types: items: type: string type: array title: Event Types description: Subscribed event types enabled: type: boolean title: Enabled description: Channel enabled status created_at: type: string format: date-time title: Created At description: Creation timestamp updated_at: type: string format: date-time title: Updated At description: Last update timestamp url: type: string title: Url description: Webhook endpoint URL type: object required: - id - event_types - enabled - created_at - updated_at - url title: WebhookChannelResponse description: Response for webhook notification channel. WorkflowInformation: properties: id: type: string format: uuid title: Id name: type: string title: Name key: anyOf: - type: string - type: 'null' title: Key sources: items: type: string format: uuid type: array title: Sources destinations: items: type: string format: uuid type: array title: Destinations workflow_type: anyOf: - $ref: '#/components/schemas/WorkflowType' - type: 'null' workflow_nodes: items: $ref: '#/components/schemas/WorkflowNode' type: array title: Workflow Nodes schedule: anyOf: - $ref: '#/components/schemas/WorkflowSchedule' - type: 'null' status: $ref: '#/components/schemas/WorkflowState' created_at: type: string format: date-time title: Created At updated_at: anyOf: - type: string format: date-time - type: 'null' title: Updated At reprocess_all: type: boolean title: Reprocess All default: false type: object required: - id - name - sources - destinations - workflow_nodes - status - created_at title: WorkflowInformation WorkflowJobType: type: string enum: - ephemeral - persistent - scheduled - template title: WorkflowJobType WorkflowNode: properties: id: anyOf: - type: string format: uuid - type: 'null' title: Id name: type: string title: Name type: type: string title: Type subtype: type: string title: Subtype settings: anyOf: - additionalProperties: true type: object - type: 'null' title: Settings type: object required: - name - type - subtype title: WorkflowNode WorkflowSchedule: properties: crontab_entries: items: $ref: '#/components/schemas/CronTabEntry' type: array title: Crontab Entries type: object required: - crontab_entries title: WorkflowSchedule examples: - crontab_entries: - cron_expression: 0 0 * * * WorkflowState: type: string enum: - active - inactive title: WorkflowState WorkflowType: type: string enum: - basic - advanced - platinum - custom title: WorkflowType ZendeskSourceConnectorConfig: properties: subdomain: type: string title: Subdomain email: type: string title: Email api_token: type: string title: Api Token item_type: anyOf: - type: string - type: 'null' title: Item Type default: tickets batch_size: anyOf: - type: integer - type: 'null' title: Batch Size default: 2 additionalProperties: true type: object required: - subdomain - email - api_token title: ZendeskSourceConnectorConfig ZendeskSourceConnectorConfigInput: properties: subdomain: type: string title: Subdomain email: type: string title: Email api_token: type: string title: Api Token item_type: anyOf: - type: string - type: 'null' title: Item Type default: tickets batch_size: anyOf: - type: integer - type: 'null' title: Batch Size default: 2 additionalProperties: true type: object required: - subdomain - email - api_token title: ZendeskSourceConnectorConfigInput