{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/unstructured/refs/heads/main/json-schema/unstructured-schemas.json", "title": "Unstructured API Schemas", "description": "JSON Schema definitions extracted from the Unstructured Platform API and Partition API OpenAPI specifications.", "$defs": { "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.\n\nProvide ONE of: notification_ids, before, or mark_all (mutually exclusive).\nworkflow_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" }, "partition_parameters": { "properties": { "files": { "type": "string", "format": "binary", "description": "The file to extract", "examples": [ { "summary": "File to be partitioned", "externalValue": "https://github.com/Unstructured-IO/unstructured/blob/98d3541909f64290b5efb65a226fc3ee8a7cc5ee/example-docs/layout-parser-paper.pdf" } ] }, "coordinates": { "type": "boolean", "title": "Coordinates", "description": "If `True`, return coordinates for each element extracted via OCR. Default: `False`", "default": false }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content type", "description": "A hint about the content type to use (such as text/markdown), when there are problems processing a specific file. This value is a MIME type in the format type/subtype." }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Encoding", "description": "The encoding method used to decode the text input. Default: utf-8" }, "extract_image_block_types": { "items": { "type": "string" }, "type": "array", "title": "Image block types to extract", "description": "The types of elements to extract, for use in extracting image blocks as base64 encoded data stored in metadata fields.", "default": [] }, "gz_uncompressed_content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uncompressed Content Type", "description": "If file is gzipped, use this content type after unzipping." }, "hi_res_model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hi Res Model Name", "description": "The name of the inference model used when strategy is hi_res" }, "include_page_breaks": { "type": "boolean", "title": "Include Page Breaks", "description": "If true, the output will include page breaks if the filetype supports it. Default: false", "default": false }, "languages": { "items": { "type": "string" }, "type": "array", "title": "OCR Languages", "description": "The languages present in the document, for use in partitioning and/or OCR. See the Tesseract documentation for a full list of languages.", "default": [] }, "ocr_languages": { "items": { "type": "string" }, "type": "array", "title": "OCR Languages", "description": "Deprecated! The languages present in the document, for use in partitioning and/or OCR", "default": [] }, "output_format": { "type": "string", "enum": [ "application/json", "text/csv" ], "title": "Output Format", "description": "The format of the response. Supported formats are application/json and text/csv. Default: application/json.", "default": "application/json", "x-speakeasy-unknown-values": "allow" }, "pdf_infer_table_structure": { "type": "boolean", "title": "Pdf Infer Table Structure", "description": "Deprecated! Use skip_infer_table_types to opt out of table extraction for any file type. If False and strategy=hi_res, no Table Elements will be extracted from pdf files regardless of skip_infer_table_types contents.", "default": true }, "skip_infer_table_types": { "items": { "type": "string" }, "type": "array", "title": "Skip Infer Table Types", "description": "The document types that you want to skip table extraction with. Default: []", "default": [] }, "starting_page_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "PDF Starting Page Number", "description": "When PDF is split into pages before sending it into the API, providing this information will allow the page number to be assigned correctly. Introduced in 1.0.27." }, "strategy": { "type": "string", "enum": [ "fast", "hi_res", "auto", "ocr_only", "od_only", "vlm" ], "title": "Strategy", "description": "The strategy to use for partitioning PDF/image. Options are fast, hi_res, auto. Default: hi_res", "default": "hi_res", "examples": [ "auto", "hi_res", "vlm" ], "x-speakeasy-unknown-values": "allow" }, "vlm_model_provider": { "type": "string", "enum": [ "openai", "anthropic", "bedrock", "anthropic_bedrock", "vertexai", "google", "azure_openai" ], "title": "VLM Model Provider", "description": "The VLM Model provider to use.", "examples": [ "openai", "anthropic", "bedrock" ], "x-speakeasy-unknown-values": "allow" }, "vlm_model": { "type": "string", "title": "VLM Model", "description": "The VLM Model to use.", "examples": [ "gpt-4o" ], "x-speakeasy-unknown-values": "allow" }, "table_ocr_agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table OCR Agent", "description": "The OCR agent to use for table ocr inference.", "default": "unstructured.partition.utils.ocr_models.tesseract_ocr.OCRAgentTesseract" }, "unique_element_ids": { "type": "boolean", "title": "Unique Element IDs", "description": "When `True`, assign UUIDs to element IDs, which guarantees their uniqueness (useful when using them as primary keys in database). Otherwise a SHA-256 of element text is used. Default: `False`", "default": false }, "xml_keep_tags": { "type": "boolean", "title": "Xml Keep Tags", "description": "If `True`, will retain the XML tags in the output. Otherwise it will simply extract the text from within the tags. Only applies to XML documents.", "default": false }, "chunking_strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Chunking Strategy", "description": "Use one of the supported strategies to chunk the returned elements after partitioning. When 'chunking_strategy' is not specified, no chunking is performed and any other chunking parameters provided are ignored. Supported strategies: 'basic', 'by_page', 'by_similarity', or 'by_title'", "examples": [ "by_title", "basic" ], "x-speakeasy-unknown-values": "allow" }, "combine_under_n_chars": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Combine Under N Chars", "description": "If chunking strategy is set, combine elements until a section reaches a length of n chars. Default: 500" }, "include_orig_elements": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include original elements in chunks", "description": "When a chunking strategy is specified, each returned chunk will include the elements consolidated to form that chunk as `.metadata.orig_elements`. Default: true." }, "tracking_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tracking enabled", "description": "Tracking enabled" }, "max_characters": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Characters", "description": "If chunking strategy is set, cut off new sections after reaching a length of n chars (hard max). Default: 500" }, "multipage_sections": { "type": "boolean", "title": "Multipage Sections", "description": "If chunking strategy is set, determines if sections can span multiple sections. Default: true", "default": true }, "new_after_n_chars": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "New after n chars", "description": "If chunking strategy is set, cut off new sections after reaching a length of n chars (soft max). Default: 1500" }, "overlap": { "type": "integer", "title": "Overlap", "description": "Specifies the length of a string ('tail') to be drawn from each chunk and prefixed to the next chunk as a context-preserving mechanism. By default, this only applies to split-chunks where an oversized element is divided into multiple chunks by text-splitting. Default: 0", "default": 0 }, "overlap_all": { "type": "boolean", "title": "Overlap all", "description": "When `True`, apply overlap between 'normal' chunks formed from whole elements and not subject to text-splitting. Use this with caution as it entails a certain level of 'pollution' of otherwise clean semantic chunk boundaries. Default: False", "default": false }, "skip_table_chunking": { "type": "boolean", "title": "Skip table chunking", "description": "When `True`, tables are not chunked and always kept unchanged. Default: False", "default": false }, "isolate_table": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Isolate table", "description": "When `True`, tables are never chunked together with other elements. Default: True", "default": true }, "similarity_threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "similarity-threshold", "description": "A value between 0.0 and 1.0 describing the minimum similarity two elements must have to be included in the same chunk. Note that similar elements may be separated to meet chunk-size criteria; this value can only guarantees that two elements with similarity below the threshold will appear in separate chunks." }, "do_not_break_similarity_on_footer_header": { "type": "boolean", "title": "do-not-break-similarity-on-footer-header", "description": "When `True`, footer, header, and page number are always considered similar to the text before them for chunk by similarity method. This allows chunk by similarity to connect contents across page better.", "default": false }, "contextual_chunking_service_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contextual Chunking Service Name", "description": "Pre-resolved prompt service name for contextual chunking (e.g. 'BedrockContextualChunking'). When set, uses this service with the provided auth instead of the default env-var-based model selection." }, "contextual_chunking_auth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contextual Chunking Auth", "description": "JSON-encoded auth credentials for the contextual chunking provider. Structure depends on the provider." }, "include_slide_notes": { "type": "boolean", "title": "include_slide_notes", "description": "When `True`, slide notes from .ppt and .pptx files will be included in the response. Default: `True`", "default": true }, "pdfminer_line_overlap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "PDFMiner Line Overlap", "description": "If two characters have more overlap than this they are considered to be on the same line. The overlap is specified relative to the minimum height of both characters." }, "pdfminer_char_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "PDFMiner Char Margin", "description": "If two characters are closer together than this margin they are considered part of the same line. The margin is specified relative to the width of the character." }, "pdfminer_line_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "PDFMiner Line Margin", "description": "If two lines are close together they are considered to be part of the same paragraph. The margin is specified relative to the height of a line." }, "pdfminer_word_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "PDFMiner Word Margin", "description": "If two characters on the same line are further apart than this margin then they are considered to be two separate words, and an intermediate space will be added for readability. The margin is specified relative to the width of the character.", "default": 0.185 } }, "type": "object", "required": [ "files" ], "title": "Partition Parameters" }, "Element": { "title": "Element", "type": "object", "additionalProperties": true, "example": { "type": "Title", "element_id": "6aa0ff22f91bbe7e26e8e25ca8052acd", "text": "LayoutParser: A Unified Toolkit for Deep Learning Based Document Image Analysis", "metadata": { "languages": [ "eng" ], "page_number": 1, "filename": "layout-parser-paper.pdf", "filetype": "application/pdf" } } }, "CSV-Element": { "title": "CSV-Element", "type": "string", "example": "type,element_id,text,languages,page_number,filename,filetype,parent_id,links\n Title,b7f58c2fd9c15949a55a62eb84e39575,LayoutParser: A Unified Toolkit for Deep Learning Based Document Image Analysis,['eng'],1,layout-parser-paper.pdf,application/pdf,," }, "ServerError": { "type": "object", "properties": { "detail": { "type": "string" } }, "example": { "detail": "An error occurred" } } } }