bar
` counts 2);\nclosing tags, comments, and doctypes don't count.\n","required":["value","editedBy","editedAt"],"properties":{"value":{"type":"integer","minimum":0},"editedBy":{"type":"string","enum":["default","llm","agent","ops","user"],"description":"Actor type that produced the last edit. API clients send `user`."},"editedByLabel":{"type":"string","description":"Optional human-readable label for the editor (e.g. email for users, agent name for agents)."},"editedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of the last edit."}}},"StringCharsetPreset":{"type":"object","description":"A named character-class restriction.","required":["kind","preset"],"properties":{"kind":{"type":"string","enum":["PRESET"]},"preset":{"type":"string","enum":["natural_language","alphanumeric","alpha"]}}},"StringFormatFreeTextRule":{"type":"object","description":"Free-text format. A character-class restriction; length rules apply only with this kind.","required":["kind","charset","editedBy","editedAt"],"properties":{"kind":{"type":"string","enum":["FREE_TEXT"]},"charset":{"$ref":"#/components/schemas/StringCharsetPreset"},"editedBy":{"type":"string","enum":["default","llm","agent","ops","user"],"description":"Actor type that produced the last edit. API clients send `user`."},"editedByLabel":{"type":"string","description":"Optional human-readable label for the editor (e.g. email for users, agent name for agents)."},"editedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of the last edit."}}},"StringPatternPreset":{"type":"object","description":"A named pattern preset.","required":["kind","preset"],"properties":{"kind":{"type":"string","enum":["PRESET"]},"preset":{"type":"string","enum":["url","email","phone","date","datetime","time","uuid","slug"]}}},"StringCustomPattern":{"type":"object","description":"A custom regular expression.","required":["kind","pattern"],"properties":{"kind":{"type":"string","enum":["CUSTOM"]},"pattern":{"type":"string","minLength":1,"description":"Must be a valid regular expression."}}},"StringPatternSource":{"oneOf":[{"$ref":"#/components/schemas/StringPatternPreset"},{"$ref":"#/components/schemas/StringCustomPattern"}],"discriminator":{"propertyName":"kind"}},"StringFormatFormatRule":{"type":"object","description":"Pattern format. Values must match a named pattern preset or a custom regular expression.","required":["kind","source","editedBy","editedAt"],"properties":{"kind":{"type":"string","enum":["FORMAT"]},"source":{"$ref":"#/components/schemas/StringPatternSource"},"editedBy":{"type":"string","enum":["default","llm","agent","ops","user"],"description":"Actor type that produced the last edit. API clients send `user`."},"editedByLabel":{"type":"string","description":"Optional human-readable label for the editor (e.g. email for users, agent name for agents)."},"editedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of the last edit."}}},"StringListPreset":{"type":"object","description":"A named list of allowed values.","required":["kind","preset"],"properties":{"kind":{"type":"string","enum":["PRESET"]},"preset":{"type":"string","enum":["language2","country2","country3","currency3","month3","usState2"]}}},"StringCustomList":{"type":"object","description":"A custom closed set of allowed values.","required":["kind","values"],"properties":{"kind":{"type":"string","enum":["CUSTOM"]},"values":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"description":"The closed set of allowed values."}}},"StringListSource":{"oneOf":[{"$ref":"#/components/schemas/StringListPreset"},{"$ref":"#/components/schemas/StringCustomList"}],"discriminator":{"propertyName":"kind"}},"StringFormatListRule":{"type":"object","description":"List format. Values must come from a named list preset or a custom list.","required":["kind","source","editedBy","editedAt"],"properties":{"kind":{"type":"string","enum":["LIST"]},"source":{"$ref":"#/components/schemas/StringListSource"},"editedBy":{"type":"string","enum":["default","llm","agent","ops","user"],"description":"Actor type that produced the last edit. API clients send `user`."},"editedByLabel":{"type":"string","description":"Optional human-readable label for the editor (e.g. email for users, agent name for agents)."},"editedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of the last edit."}}},"StringFormatRule":{"description":"Format rule for string fields. The `kind` discriminator selects one of three shapes:\n - `FREE_TEXT` (see `StringFormatFreeTextRule`): a character-class restriction. Length rules apply only with this kind.\n - `FORMAT` (see `StringFormatFormatRule`): a named pattern preset or a custom regex.\n - `LIST` (see `StringFormatListRule`): a named list preset or a custom list of allowed values.\n","oneOf":[{"$ref":"#/components/schemas/StringFormatFreeTextRule"},{"$ref":"#/components/schemas/StringFormatFormatRule"},{"$ref":"#/components/schemas/StringFormatListRule"}],"discriminator":{"propertyName":"kind"}},"NumberBoundRule":{"type":"object","description":"Inclusive bound on the numeric value.","required":["value","editedBy","editedAt"],"properties":{"value":{"type":"number"},"editedBy":{"type":"string","enum":["default","llm","agent","ops","user"],"description":"Actor type that produced the last edit. API clients send `user`."},"editedByLabel":{"type":"string","description":"Optional human-readable label for the editor (e.g. email for users, agent name for agents)."},"editedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of the last edit."}}},"NumberMaxDecimalPlacesRule":{"type":"object","description":"Maximum number of decimal places (0 for whole numbers).","required":["value","editedBy","editedAt"],"properties":{"value":{"type":"integer","minimum":0,"maximum":16},"editedBy":{"type":"string","enum":["default","llm","agent","ops","user"],"description":"Actor type that produced the last edit. API clients send `user`."},"editedByLabel":{"type":"string","description":"Optional human-readable label for the editor (e.g. email for users, agent name for agents)."},"editedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of the last edit."}}},"DateFixedBoundRule":{"type":"object","description":"A fixed calendar date bound.","required":["kind","date","editedBy","editedAt"],"properties":{"kind":{"type":"string","enum":["FIXED"]},"date":{"type":"string","format":"date","description":"A valid calendar date in `YYYY-MM-DD` format."},"editedBy":{"type":"string","enum":["default","llm","agent","ops","user"],"description":"Actor type that produced the last edit. API clients send `user`."},"editedByLabel":{"type":"string","description":"Optional human-readable label for the editor (e.g. email for users, agent name for agents)."},"editedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of the last edit."}}},"DateRelativeBoundRule":{"type":"object","description":"A bound relative to the run date (UTC). As a minimum it resolves to the first day of the\nperiod, as a maximum to the last day (e.g. `THIS_MONTH` is the 1st or the last day of the run month).\n","required":["kind","preset","editedBy","editedAt"],"properties":{"kind":{"type":"string","enum":["RELATIVE"]},"preset":{"type":"string","enum":["TODAY","YESTERDAY","THIS_WEEK","THIS_MONTH","THIS_YEAR"]},"editedBy":{"type":"string","enum":["default","llm","agent","ops","user"],"description":"Actor type that produced the last edit. API clients send `user`."},"editedByLabel":{"type":"string","description":"Optional human-readable label for the editor (e.g. email for users, agent name for agents)."},"editedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of the last edit."}}},"DateBoundRule":{"description":"Inclusive bound on a date value, either fixed or relative to the run date.","oneOf":[{"$ref":"#/components/schemas/DateFixedBoundRule"},{"$ref":"#/components/schemas/DateRelativeBoundRule"}],"discriminator":{"propertyName":"kind"}},"ObjectAdditionalPropertiesRule":{"type":"object","description":"Whether the object may contain properties that are not listed under `properties`.","required":["allowed","editedBy","editedAt"],"properties":{"allowed":{"type":"boolean"},"editedBy":{"type":"string","enum":["default","llm","agent","ops","user"],"description":"Actor type that produced the last edit. API clients send `user`."},"editedByLabel":{"type":"string","description":"Optional human-readable label for the editor (e.g. email for users, agent name for agents)."},"editedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of the last edit."}}},"ArrayItemCountRule":{"type":"object","description":"Bound on the number of items in the array.","required":["value","editedBy","editedAt"],"properties":{"value":{"type":"integer","minimum":0},"editedBy":{"type":"string","enum":["default","llm","agent","ops","user"],"description":"Actor type that produced the last edit. API clients send `user`."},"editedByLabel":{"type":"string","description":"Optional human-readable label for the editor (e.g. email for users, agent name for agents)."},"editedAt":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of the last edit."}}},"StringFieldRules":{"type":"object","required":["kind"],"description":"Validation rules for string fields.","properties":{"kind":{"type":"string","enum":["STRING"]},"presence":{"$ref":"#/components/schemas/PresenceRule"},"uniqueness":{"$ref":"#/components/schemas/UniquenessRule"},"minLength":{"$ref":"#/components/schemas/StringLengthRule"},"maxLength":{"$ref":"#/components/schemas/StringLengthRule"},"minHtmlElements":{"$ref":"#/components/schemas/StringHtmlElementCountRule"},"maxHtmlElements":{"$ref":"#/components/schemas/StringHtmlElementCountRule"},"format":{"$ref":"#/components/schemas/StringFormatRule"}}},"NumberFieldRules":{"type":"object","required":["kind"],"description":"Validation rules for number fields.","properties":{"kind":{"type":"string","enum":["NUMBER"]},"presence":{"$ref":"#/components/schemas/PresenceRule"},"uniqueness":{"$ref":"#/components/schemas/UniquenessRule"},"minimum":{"$ref":"#/components/schemas/NumberBoundRule"},"maximum":{"$ref":"#/components/schemas/NumberBoundRule"},"maxDecimalPlaces":{"$ref":"#/components/schemas/NumberMaxDecimalPlacesRule"}}},"DateFieldRules":{"type":"object","required":["kind"],"description":"Validation rules for date fields. Values are cast to a calendar date (`YYYY-MM-DD`,\nor a `YYYY-MM-DD HH:MM:SS` timestamp truncated to its day) before the bounds apply.\n","properties":{"kind":{"type":"string","enum":["DATE"]},"presence":{"$ref":"#/components/schemas/PresenceRule"},"uniqueness":{"$ref":"#/components/schemas/UniquenessRule"},"minimum":{"$ref":"#/components/schemas/DateBoundRule"},"maximum":{"$ref":"#/components/schemas/DateBoundRule"}}},"ObjectFieldRules":{"type":"object","required":["kind","properties"],"description":"Rules for an object field. `properties` maps each sub-field name to its own rules\n(recursively a `FieldValidationRules`), so nested objects can be validated to any depth.\n","properties":{"kind":{"type":"string","enum":["OBJECT"]},"presence":{"$ref":"#/components/schemas/PresenceRule"},"uniqueness":{"$ref":"#/components/schemas/UniquenessRule"},"additionalProperties":{"$ref":"#/components/schemas/ObjectAdditionalPropertiesRule"},"properties":{"type":"object","description":"Per-sub-field rules, keyed by sub-field name.","additionalProperties":{"$ref":"#/components/schemas/FieldValidationRules"}}}},"ArrayFieldRules":{"type":"object","required":["kind"],"description":"Rules for an array field. `items` are the rules applied to every element of the array\n(recursively a `FieldValidationRules`).\n","properties":{"kind":{"type":"string","enum":["ARRAY"]},"presence":{"$ref":"#/components/schemas/PresenceRule"},"uniqueness":{"$ref":"#/components/schemas/UniquenessRule"},"minItems":{"$ref":"#/components/schemas/ArrayItemCountRule"},"maxItems":{"$ref":"#/components/schemas/ArrayItemCountRule"},"items":{"$ref":"#/components/schemas/FieldValidationRules"}}},"OtherFieldRules":{"type":"object","required":["kind"],"description":"Fallback rules for fields with no richer rule shape (e.g. booleans).","properties":{"kind":{"type":"string","enum":["OTHER"]},"presence":{"$ref":"#/components/schemas/PresenceRule"},"uniqueness":{"$ref":"#/components/schemas/UniquenessRule"}}},"FieldValidationRules":{"description":"Rules for one schema field. The `kind` discriminator selects the rule shape and casts the\nfield's values to that type before evaluation. A rule tree may nest at most 4 levels deep\nand hold at most 200 evaluable rules.\n","oneOf":[{"$ref":"#/components/schemas/StringFieldRules"},{"$ref":"#/components/schemas/NumberFieldRules"},{"$ref":"#/components/schemas/DateFieldRules"},{"$ref":"#/components/schemas/ObjectFieldRules"},{"$ref":"#/components/schemas/ArrayFieldRules"},{"$ref":"#/components/schemas/OtherFieldRules"}],"discriminator":{"propertyName":"kind"}},"WorkflowSchemaValidationRules":{"type":"object","description":"Map keyed by schema field name, with the per-field data quality rules for that field.","additionalProperties":{"$ref":"#/components/schemas/FieldValidationRules"}},"ExtractionStrategySummary":{"type":"object","required":["approach","summary","dataSource"],"properties":{"approach":{"type":"string"},"summary":{"type":"string"},"dataSource":{"type":"object","required":["type","endpoints","interactionStyle","selectors"],"properties":{"type":{"type":"string"},"endpoints":{"type":"array","items":{"type":"string"}},"interactionStyle":{"type":"string"},"selectors":{"type":"array","items":{"type":"string"}}}},"intervalSeconds":{"type":"number","nullable":true,"description":"Realtime polling interval in seconds, when applicable."}}},"AgentPromptRequest":{"type":"object","required":["prompt"],"properties":{"prompt":{"type":"string","minLength":1},"sessionId":{"type":"string","format":"uuid","nullable":true},"newSessionId":{"type":"string","format":"uuid","nullable":true},"threadId":{"type":"string","format":"uuid","nullable":true},"questionsDisabled":{"type":"boolean"},"templateId":{"type":"string","format":"uuid","nullable":true},"templateVersion":{"type":"integer","minimum":1,"nullable":true},"productType":{"type":"string","enum":["workflow","realtime"]},"tags":{"type":"array","items":{"type":"string"}},"notificationChannelIds":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","format":"uuid"}}}},"AgentPromptResponse":{"type":"object","required":["data","status","message"],"properties":{"data":{"type":"object","required":["jobId","sessionId","threadId","workflowId"],"properties":{"jobId":{"type":"string","nullable":true},"inputEventId":{"type":"string"},"sessionId":{"type":"string","format":"uuid"},"threadId":{"type":"string","format":"uuid"},"workflowId":{"type":"string","format":"uuid"},"existed":{"type":"boolean"}}},"status":{"type":"string","enum":["success"]},"message":{"type":"string"}}},"AssistantQuestion":{"type":"object","additionalProperties":true,"required":["question","header","options","answerType"],"properties":{"question":{"type":"string"},"header":{"type":"string"},"options":{"type":"array","items":{"type":"object","required":["label","description"],"properties":{"label":{"type":"string"},"description":{"type":"string"}}}},"answerType":{"type":"string","enum":["single","multi","freeform"]},"metadata":{"type":"object","additionalProperties":true}}},"WorkflowAssistantMessageRequest":{"type":"object","required":["prompt"],"properties":{"prompt":{"type":"string","minLength":1,"description":"Natural-language instructions for updating the existing workflow."},"threadId":{"type":"string","format":"uuid","nullable":true,"description":"Assistant thread to continue. Omit to use the workflow's latest Assistant thread."}}},"WorkflowAssistantMessageResponse":{"type":"object","required":["data","status","message"],"properties":{"data":{"type":"object","required":["jobId","sessionId","threadId","workflowId"],"properties":{"jobId":{"type":"string","nullable":true},"inputEventId":{"type":"string"},"sessionId":{"type":"string","format":"uuid"},"threadId":{"type":"string","format":"uuid"},"workflowId":{"type":"string","format":"uuid"},"existed":{"type":"boolean"},"alreadyBootstrapped":{"type":"boolean"},"realtimePlacementPolicy":{"type":"object","description":"Present when mentioned tags were saved but the realtime placement policy publish failed or was skipped; the message itself still ran.","properties":{"status":{"type":"string","enum":["failed","skipped"]},"code":{"type":"string","description":"Stable failure code, e.g. REALTIME_PLACEMENT_POLICY_PUBLISH_FAILED."},"reason":{"type":"string"},"policyVersion":{"type":"integer"}}}}},"status":{"type":"string","enum":["success"]},"message":{"type":"string"}}},"AssistantPauseStateResponse":{"type":"object","required":["data","status"],"properties":{"data":{"type":"object","required":["paused","pause","pendingQuestion"],"properties":{"paused":{"type":"boolean"},"pause":{"type":"object","nullable":true,"required":["id","reason","status","pausedAt"],"properties":{"id":{"type":"string"},"reason":{"type":"string","enum":["question","interrupt"]},"status":{"type":"string","enum":["active","resuming"]},"threadId":{"type":"string","format":"uuid"},"pausedAt":{"type":"string","format":"date-time"},"resumeRequestedAt":{"type":"string","format":"date-time"},"resumeError":{"type":"boolean"}}},"pendingQuestion":{"type":"object","nullable":true,"required":["questionId","questions","askedAt"],"properties":{"questionId":{"type":"string"},"threadId":{"type":"string","format":"uuid"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/AssistantQuestion"}},"askedAt":{"type":"string","format":"date-time"}}}}},"status":{"type":"string","enum":["success"]}}},"AssistantAnswerRequest":{"type":"object","required":["sessionId","questionId","answers"],"properties":{"sessionId":{"type":"string","format":"uuid"},"questionId":{"type":"string"},"threadId":{"type":"string","format":"uuid"},"answers":{"type":"object","additionalProperties":{"type":"string"},"description":"Question-index-to-answer map. Freeform answers use the `_freeform` key."}}},"AssistantAnswerResponse":{"type":"object","required":["data","status","message"],"properties":{"data":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","enum":[true]}}},"status":{"type":"string","enum":["success"]},"message":{"type":"string"}}},"AssistantStrategyResponse":{"type":"object","required":["data","status"],"properties":{"data":{"type":"object","required":["strategy"],"properties":{"strategy":{"allOf":[{"$ref":"#/components/schemas/ExtractionStrategySummary"}],"nullable":true}}},"status":{"type":"string","enum":["success"]}}},"AgentBuild":{"type":"object","required":["id","version","status","createdAt"],"properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"integer"},"status":{"type":"string","enum":["queued","running","completed","failed"]},"errorMessage":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time","nullable":true}}},"AgentBuildsResponse":{"type":"object","required":["data","status"],"properties":{"data":{"type":"object","required":["builds","nextCursor"],"properties":{"builds":{"type":"array","items":{"$ref":"#/components/schemas/AgentBuild"}},"nextCursor":{"type":"string","nullable":true}}},"status":{"type":"string","enum":["success"]}}},"AgentBuildInputResponse":{"type":"object","required":["data","status"],"properties":{"data":{"type":"object","required":["scriptSource","scriptLibVersion"],"properties":{"scriptSource":{"type":"string"},"scriptLibVersion":{"type":"string","nullable":true}}},"status":{"type":"string","enum":["success"]}}},"AssistantControlResponse":{"type":"object","required":["data","status"],"properties":{"data":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"delivery":{"type":"string","enum":["durable","already_paused"]}}},"status":{"type":"string","enum":["success"]}}},"AssistantResumeResponse":{"type":"object","required":["data","status","message"],"properties":{"data":{"type":"object","required":["jobId","sessionId"],"properties":{"jobId":{"type":"string"},"sessionId":{"type":"string","format":"uuid"}}},"status":{"type":"string","enum":["success"]},"message":{"type":"string"}}},"AssistantHistoryUserMessage":{"type":"object","additionalProperties":false,"required":["id","time","kind","role","text"],"properties":{"id":{"type":"string"},"time":{"type":"string","format":"date-time"},"kind":{"type":"string","enum":["user_message"]},"role":{"type":"string","enum":["user"]},"text":{"type":"string"},"authorId":{"type":"string"}}},"AssistantHistoryMessage":{"type":"object","additionalProperties":false,"required":["id","time","kind","role","text"],"properties":{"id":{"type":"string"},"time":{"type":"string","format":"date-time"},"kind":{"type":"string","enum":["assistant_message"]},"role":{"type":"string","enum":["assistant"]},"text":{"type":"string"},"links":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["url"],"properties":{"url":{"type":"string","format":"uri"}}}}}},"AssistantHistoryQuestion":{"type":"object","additionalProperties":false,"required":["id","time","kind","questionId","questions","answers","status"],"properties":{"id":{"type":"string"},"time":{"type":"string","format":"date-time"},"kind":{"type":"string","enum":["question"]},"questionId":{"type":"string"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/AssistantQuestion"}},"answers":{"type":"object","nullable":true,"additionalProperties":true},"status":{"type":"string","enum":["answered","unanswered"]}}},"AssistantHistoryItem":{"oneOf":[{"$ref":"#/components/schemas/AssistantHistoryUserMessage"},{"$ref":"#/components/schemas/AssistantHistoryMessage"},{"$ref":"#/components/schemas/AssistantHistoryQuestion"}],"discriminator":{"propertyName":"kind"}},"AssistantHistoryResponse":{"type":"object","required":["data","status"],"properties":{"data":{"type":"object","required":["workflowId","sessionId","items","pagination"],"properties":{"workflowId":{"type":"string","format":"uuid"},"sessionId":{"type":"string","format":"uuid"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AssistantHistoryItem"}},"pagination":{"type":"object","required":["nextCursor","hasMore"],"properties":{"nextCursor":{"type":"string","nullable":true},"hasMore":{"type":"boolean"}}}}},"status":{"type":"string","enum":["success"]}}},"AgentErrorEnvelope":{"type":"object","description":"Error envelope shared by every v5 agent endpoint. `code` is always present and stable. Conflict codes SESSION_NOT_ACTIVE, SESSION_ALREADY_ACTIVE and PAUSE_ANSWER_CONFLICT are terminal successes — the desired state already holds, do not retry-loop. `outcome: \"unknown\"` (with an *_OUTCOME_UNKNOWN code) marks an indeterminate dispatch: the work may already have started; re-send only when `retrySafe` is true, or with your original idempotencyKey. `retryAfterMs` accompanies retryable 503 responses.","required":["data","status","code","message"],"properties":{"data":{"nullable":true},"status":{"type":"string","enum":["error"]},"code":{"type":"string"},"message":{"type":"string"},"outcome":{"type":"string","enum":["unknown"]},"retrySafe":{"type":"boolean"},"retryAfterMs":{"type":"number"},"residue":{"type":"object","description":"Identifiers of state left behind when compensation failed; keep them for support.","additionalProperties":{"type":"string"}}}},"EmailChannelConfig":{"type":"object","required":["recipients"],"properties":{"recipients":{"type":"array","items":{"type":"string","format":"email"},"description":"Array of recipient email addresses","example":["user@example.com","admin@company.com"]},"from":{"type":"string","format":"email","description":"Sender email address (optional, must be a @kadoa.com domain email)","example":"notifications@kadoa.com"}}},"SlackChannelConfig":{"type":"object","required":["slackChannelId","slackChannelName"],"properties":{"webhookUrl":{"type":"string","format":"uri","description":"Slack webhook URL (optional)","example":"https://example.com/slack-webhook"},"slackChannelId":{"type":"string","description":"Slack channel ID","example":"C1234567890"},"slackChannelName":{"type":"string","description":"Slack channel name","example":"general"}}},"WebhookChannelConfig":{"type":"object","required":["webhookUrl","httpMethod"],"properties":{"webhookUrl":{"type":"string","format":"uri","description":"Webhook endpoint URL","example":"https://api.example.com/webhook"},"httpMethod":{"type":"string","enum":["POST","GET","PUT","PATCH"],"description":"HTTP method for the webhook"},"auth":{"type":"object","description":"Authentication configuration (optional)","properties":{"type":{"type":"string","enum":["bearer","basic","header"],"description":"Authentication type"},"token":{"type":"string","description":"Bearer token (for bearer auth)"},"username":{"type":"string","description":"Username (for basic auth)"},"password":{"type":"string","description":"Password (for basic auth)"},"headers":{"type":"object","description":"Additional headers (for header auth)","additionalProperties":{"type":"string"}}}}}},"WebsocketChannelConfig":{"type":"object","description":"WebSocket channel configuration. Note - Only one WebSocket channel is allowed per workspace. Leave empty object {} as no configuration is needed.","properties":{}},"CreateCrawlerConfigRequest":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Single URL to start crawling (for backward compatibility)"},"startUrls":{"type":"array","items":{"type":"string","format":"uri","minLength":1},"description":"List of URLs for crawling"},"pathsFilterIn":{"type":"array","items":{"type":"string","minLength":1},"description":"Regex patterns to include specific full URLs. Accepts array or JSON-stringified array of regex source strings."},"pathsFilterOut":{"type":"array","items":{"type":"string","minLength":1},"description":"Regex patterns to exclude specific full URLs. Accepts array or JSON-stringified array of regex source strings."},"proxyType":{"type":"string","nullable":true,"description":"Type of proxy to use"},"proxyCountry":{"type":"string","nullable":true,"description":"Country for proxy selection"},"timeout":{"type":"number","minimum":1,"description":"Timeout in milliseconds"},"maxDepth":{"type":"number","minimum":1,"description":"Maximum crawling depth"},"maxPages":{"type":"number","minimum":1,"description":"Maximum number of pages to crawl"},"maxMatches":{"type":"number","minimum":1,"description":"Maximum number of matched pages to crawl before stopping"},"concurrency":{"type":"number","minimum":1,"description":"Number of concurrent crawlers"},"strictDomain":{"default":true,"type":"boolean","description":"Whether to stay within the same domain"},"loadImages":{"default":true,"type":"boolean","description":"Whether to load images during crawling"},"safeMode":{"default":false,"type":"boolean","description":"Enable safe mode for crawling"},"callbackUrl":{"type":"string","format":"uri","nullable":true,"description":"Webhook URL for completion notifications"},"processDuringCrawl":{"type":"boolean","description":"Whether to run preprocessing and extraction during the crawl phase"},"crawlMethod":{"type":"object","properties":{"mode":{"default":"auto","type":"string","enum":["auto","browser"],"description":"Worker selection mode. 'auto' (default) picks cheapest compatible worker, 'browser' forces browser."},"worker":{"type":"string","enum":["auto","kurl","curl-cffi","kadmium","patchright","camoufox","cloakbrowser","brightdata"],"description":"Crawler engine selection. Fetches use Kurl; browser mode and actions use Kadmium. curl-cffi maps to Kurl; patchright, camoufox, and cloakbrowser map to Kadmium. BrightData is blocked."},"proxy":{"type":"string","enum":["auto","direct","dc","resi","isp"],"description":"Explicit proxy routing override for crawler scraping"}},"additionalProperties":{"nullable":true},"description":"Crawl method configuration"},"matchThreshold":{"type":"number","minimum":0,"maximum":1,"description":"Match threshold override for blueprint filtering"},"blueprint":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"selector":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{"nullable":true},"description":"Blueprint field definition"},"description":"Blueprint fields applied during crawling"},"extractionOptions":{"type":"object","properties":{"extractions":{"type":"object","additionalProperties":{"type":"boolean"},"description":"Feature toggles for available extraction helpers"},"schema":{"nullable":true,"description":"Schema definition for structured extractions"},"entity":{"nullable":true,"description":"Entity metadata used for extraction mappings"},"mainContextSelector":{"type":"string","description":"CSS selector anchoring focus-driven extractors"},"xhrExtractorConfigs":{"type":"array","items":{"nullable":true},"description":"XHR extractor configuration entries"}},"additionalProperties":false,"description":"Extraction-related options derived from legacy launch summary"},"navigationOptions":{"type":"object","properties":{"browserActions":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}},"description":"Ordered list of scripted browser actions executed after navigation"},"preBrowserActions":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}},"description":"Browser actions performed before the main action chain"},"scrollHtml":{"type":"boolean","description":"Enable HTML capture while scrolling through the page"},"scrollHtmlTimeout":{"type":"number","minimum":0,"description":"Maximum scroll duration in milliseconds"},"visualHtml":{"type":"boolean","description":"Enable visual HTML capture for navigation heuristics"},"navigationStrategy":{"type":"string","description":"Primary navigation strategy identifier"},"navigationStrategies":{"type":"array","items":{"type":"string"},"description":"Fallback navigation strategy order"},"limit":{"type":"number","minimum":0,"description":"Maximum number of navigation steps"},"disableNavigation":{"type":"boolean","description":"Skip automated navigation heuristics"},"ignoreIframes":{"type":"boolean","description":"Disable iframe traversal during navigation"},"navigationExploration":{"type":"object","additionalProperties":{"nullable":true},"description":"Navigation exploration tuning payload"},"loadHtmlOnly":{"type":"boolean","description":"Skip scripted interactions and only capture HTML"},"acceptCookies":{"type":"boolean","description":"Force cookie acceptance automation"},"cachedCookieAccept":{"oneOf":[{"type":"boolean"},{"type":"string"}],"description":"Reuse cached cookie acceptance flow"}},"additionalProperties":false,"description":"Navigation-related options derived from legacy launch summary"},"artifactOptions":{"type":"object","properties":{"screenshot":{"type":"boolean","description":"Capture standard screenshot"},"screenshotFull":{"type":"boolean","description":"Capture full-page screenshot"},"screenshotCache":{"type":"boolean","description":"Re-use cached screenshot when available"},"screenshotPublic":{"type":"boolean","description":"Make captured screenshot publicly accessible"},"screenshotLink":{"type":"string","description":"Stored screenshot link for follow-up processing"},"archivePdf":{"type":"boolean","description":"Generate archival PDF for crawled pages"}},"additionalProperties":false,"description":"Artifact capture options derived from legacy launch summary"},"rawMode":{"type":"boolean","description":"Whether this is a raw data mode crawl"},"outputOptions":{"type":"object","properties":{"includeHtml":{"type":"boolean"},"includeMarkdown":{"type":"boolean"},"includeScreenshots":{"type":"boolean"},"includeJson":{"type":"boolean"}},"description":"Output options for raw mode"},"jobId":{"type":"string","description":"Internal: Job ID for workflow tracking"},"workflowId":{"type":"string","description":"Internal: Owning workflow (scraperId) for BrightData cost attribution"},"dataKey":{"type":"string","description":"Internal: Data key for Parquet storage path"},"billingSource":{"type":"string","description":"Internal: Billing source identifier"}},"title":"CreateCrawlerConfigRequest","description":"Request body for creating a new crawling configuration"},"CreateCrawlerConfigResponse":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Single URL to start crawling (for backward compatibility)"},"startUrls":{"type":"array","items":{"type":"string","format":"uri","minLength":1},"description":"List of URLs for crawling"},"pathsFilterIn":{"type":"array","items":{"type":"string","minLength":1},"description":"Regex patterns to include specific full URLs. Accepts array or JSON-stringified array of regex source strings."},"pathsFilterOut":{"type":"array","items":{"type":"string","minLength":1},"description":"Regex patterns to exclude specific full URLs. Accepts array or JSON-stringified array of regex source strings."},"proxyType":{"type":"string","nullable":true,"description":"Type of proxy to use"},"proxyCountry":{"type":"string","nullable":true,"description":"Country for proxy selection"},"timeout":{"type":"number","minimum":1,"description":"Timeout in milliseconds"},"maxDepth":{"type":"number","minimum":1,"description":"Maximum crawling depth"},"maxPages":{"type":"number","minimum":1,"description":"Maximum number of pages to crawl"},"maxMatches":{"type":"number","minimum":1,"description":"Maximum number of matched pages to crawl before stopping"},"concurrency":{"type":"number","minimum":1,"description":"Number of concurrent crawlers"},"strictDomain":{"default":true,"type":"boolean","description":"Whether to stay within the same domain"},"loadImages":{"default":true,"type":"boolean","description":"Whether to load images during crawling"},"safeMode":{"default":false,"type":"boolean","description":"Enable safe mode for crawling"},"callbackUrl":{"type":"string","format":"uri","nullable":true,"description":"Webhook URL for completion notifications"},"processDuringCrawl":{"type":"boolean","description":"Whether to run preprocessing and extraction during the crawl phase"},"crawlMethod":{"type":"object","properties":{"mode":{"default":"auto","type":"string","enum":["auto","browser"],"description":"Worker selection mode. 'auto' (default) picks cheapest compatible worker, 'browser' forces browser."},"worker":{"type":"string","enum":["auto","kurl","curl-cffi","kadmium","patchright","camoufox","cloakbrowser","brightdata"],"description":"Crawler engine selection. Fetches use Kurl; browser mode and actions use Kadmium. curl-cffi maps to Kurl; patchright, camoufox, and cloakbrowser map to Kadmium. BrightData is blocked."},"proxy":{"type":"string","enum":["auto","direct","dc","resi","isp"],"description":"Explicit proxy routing override for crawler scraping"}},"additionalProperties":{"nullable":true},"description":"Crawl method configuration"},"matchThreshold":{"type":"number","minimum":0,"maximum":1,"description":"Match threshold override for blueprint filtering"},"blueprint":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"selector":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{"nullable":true},"description":"Blueprint field definition"},"description":"Blueprint fields applied during crawling"},"extractionOptions":{"type":"object","properties":{"extractions":{"type":"object","additionalProperties":{"type":"boolean"},"description":"Feature toggles for available extraction helpers"},"schema":{"nullable":true,"description":"Schema definition for structured extractions"},"entity":{"nullable":true,"description":"Entity metadata used for extraction mappings"},"mainContextSelector":{"type":"string","description":"CSS selector anchoring focus-driven extractors"},"xhrExtractorConfigs":{"type":"array","items":{"nullable":true},"description":"XHR extractor configuration entries"}},"additionalProperties":false,"description":"Extraction-related options derived from legacy launch summary"},"navigationOptions":{"type":"object","properties":{"browserActions":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}},"description":"Ordered list of scripted browser actions executed after navigation"},"preBrowserActions":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}},"description":"Browser actions performed before the main action chain"},"scrollHtml":{"type":"boolean","description":"Enable HTML capture while scrolling through the page"},"scrollHtmlTimeout":{"type":"number","minimum":0,"description":"Maximum scroll duration in milliseconds"},"visualHtml":{"type":"boolean","description":"Enable visual HTML capture for navigation heuristics"},"navigationStrategy":{"type":"string","description":"Primary navigation strategy identifier"},"navigationStrategies":{"type":"array","items":{"type":"string"},"description":"Fallback navigation strategy order"},"limit":{"type":"number","minimum":0,"description":"Maximum number of navigation steps"},"disableNavigation":{"type":"boolean","description":"Skip automated navigation heuristics"},"ignoreIframes":{"type":"boolean","description":"Disable iframe traversal during navigation"},"navigationExploration":{"type":"object","additionalProperties":{"nullable":true},"description":"Navigation exploration tuning payload"},"loadHtmlOnly":{"type":"boolean","description":"Skip scripted interactions and only capture HTML"},"acceptCookies":{"type":"boolean","description":"Force cookie acceptance automation"},"cachedCookieAccept":{"oneOf":[{"type":"boolean"},{"type":"string"}],"description":"Reuse cached cookie acceptance flow"}},"additionalProperties":false,"description":"Navigation-related options derived from legacy launch summary"},"artifactOptions":{"type":"object","properties":{"screenshot":{"type":"boolean","description":"Capture standard screenshot"},"screenshotFull":{"type":"boolean","description":"Capture full-page screenshot"},"screenshotCache":{"type":"boolean","description":"Re-use cached screenshot when available"},"screenshotPublic":{"type":"boolean","description":"Make captured screenshot publicly accessible"},"screenshotLink":{"type":"string","description":"Stored screenshot link for follow-up processing"},"archivePdf":{"type":"boolean","description":"Generate archival PDF for crawled pages"}},"additionalProperties":false,"description":"Artifact capture options derived from legacy launch summary"},"rawMode":{"type":"boolean","description":"Whether this is a raw data mode crawl"},"outputOptions":{"type":"object","properties":{"includeHtml":{"type":"boolean"},"includeMarkdown":{"type":"boolean"},"includeScreenshots":{"type":"boolean"},"includeJson":{"type":"boolean"}},"description":"Output options for raw mode"},"jobId":{"type":"string","description":"Internal: Job ID for workflow tracking"},"workflowId":{"type":"string","description":"Internal: Owning workflow (scraperId) for BrightData cost attribution"},"dataKey":{"type":"string","description":"Internal: Data key for Parquet storage path"},"billingSource":{"type":"string","description":"Internal: Billing source identifier"},"configId":{"type":"string","description":"Config ID"},"userId":{"type":"string","description":"User ID"},"createdAt":{"type":"string","description":"Created at"}},"required":["configId","userId","createdAt"],"title":"CreateCrawlerConfigResponse","description":"Response schema for creating a new crawling configuration"},"GetCrawlerConfigResponse":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Single URL to start crawling (for backward compatibility)"},"startUrls":{"type":"array","items":{"type":"string","format":"uri","minLength":1},"description":"List of URLs for crawling"},"pathsFilterIn":{"type":"array","items":{"type":"string","minLength":1},"description":"Regex patterns to include specific full URLs. Accepts array or JSON-stringified array of regex source strings."},"pathsFilterOut":{"type":"array","items":{"type":"string","minLength":1},"description":"Regex patterns to exclude specific full URLs. Accepts array or JSON-stringified array of regex source strings."},"proxyType":{"type":"string","nullable":true,"description":"Type of proxy to use"},"proxyCountry":{"type":"string","nullable":true,"description":"Country for proxy selection"},"timeout":{"type":"number","minimum":1,"description":"Timeout in milliseconds"},"maxDepth":{"type":"number","minimum":1,"description":"Maximum crawling depth"},"maxPages":{"type":"number","minimum":1,"description":"Maximum number of pages to crawl"},"maxMatches":{"type":"number","minimum":1,"description":"Maximum number of matched pages to crawl before stopping"},"concurrency":{"type":"number","minimum":1,"description":"Number of concurrent crawlers"},"strictDomain":{"default":true,"type":"boolean","description":"Whether to stay within the same domain"},"loadImages":{"default":true,"type":"boolean","description":"Whether to load images during crawling"},"safeMode":{"default":false,"type":"boolean","description":"Enable safe mode for crawling"},"callbackUrl":{"type":"string","format":"uri","nullable":true,"description":"Webhook URL for completion notifications"},"processDuringCrawl":{"type":"boolean","description":"Whether to run preprocessing and extraction during the crawl phase"},"crawlMethod":{"type":"object","properties":{"mode":{"default":"auto","type":"string","enum":["auto","browser"],"description":"Worker selection mode. 'auto' (default) picks cheapest compatible worker, 'browser' forces browser."},"worker":{"type":"string","enum":["auto","kurl","curl-cffi","kadmium","patchright","camoufox","cloakbrowser","brightdata"],"description":"Crawler engine selection. Fetches use Kurl; browser mode and actions use Kadmium. curl-cffi maps to Kurl; patchright, camoufox, and cloakbrowser map to Kadmium. BrightData is blocked."},"proxy":{"type":"string","enum":["auto","direct","dc","resi","isp"],"description":"Explicit proxy routing override for crawler scraping"}},"additionalProperties":{"nullable":true},"description":"Crawl method configuration"},"matchThreshold":{"type":"number","minimum":0,"maximum":1,"description":"Match threshold override for blueprint filtering"},"blueprint":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"selector":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{"nullable":true},"description":"Blueprint field definition"},"description":"Blueprint fields applied during crawling"},"extractionOptions":{"type":"object","properties":{"extractions":{"type":"object","additionalProperties":{"type":"boolean"},"description":"Feature toggles for available extraction helpers"},"schema":{"nullable":true,"description":"Schema definition for structured extractions"},"entity":{"nullable":true,"description":"Entity metadata used for extraction mappings"},"mainContextSelector":{"type":"string","description":"CSS selector anchoring focus-driven extractors"},"xhrExtractorConfigs":{"type":"array","items":{"nullable":true},"description":"XHR extractor configuration entries"}},"additionalProperties":false,"description":"Extraction-related options derived from legacy launch summary"},"navigationOptions":{"type":"object","properties":{"browserActions":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}},"description":"Ordered list of scripted browser actions executed after navigation"},"preBrowserActions":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}},"description":"Browser actions performed before the main action chain"},"scrollHtml":{"type":"boolean","description":"Enable HTML capture while scrolling through the page"},"scrollHtmlTimeout":{"type":"number","minimum":0,"description":"Maximum scroll duration in milliseconds"},"visualHtml":{"type":"boolean","description":"Enable visual HTML capture for navigation heuristics"},"navigationStrategy":{"type":"string","description":"Primary navigation strategy identifier"},"navigationStrategies":{"type":"array","items":{"type":"string"},"description":"Fallback navigation strategy order"},"limit":{"type":"number","minimum":0,"description":"Maximum number of navigation steps"},"disableNavigation":{"type":"boolean","description":"Skip automated navigation heuristics"},"ignoreIframes":{"type":"boolean","description":"Disable iframe traversal during navigation"},"navigationExploration":{"type":"object","additionalProperties":{"nullable":true},"description":"Navigation exploration tuning payload"},"loadHtmlOnly":{"type":"boolean","description":"Skip scripted interactions and only capture HTML"},"acceptCookies":{"type":"boolean","description":"Force cookie acceptance automation"},"cachedCookieAccept":{"oneOf":[{"type":"boolean"},{"type":"string"}],"description":"Reuse cached cookie acceptance flow"}},"additionalProperties":false,"description":"Navigation-related options derived from legacy launch summary"},"artifactOptions":{"type":"object","properties":{"screenshot":{"type":"boolean","description":"Capture standard screenshot"},"screenshotFull":{"type":"boolean","description":"Capture full-page screenshot"},"screenshotCache":{"type":"boolean","description":"Re-use cached screenshot when available"},"screenshotPublic":{"type":"boolean","description":"Make captured screenshot publicly accessible"},"screenshotLink":{"type":"string","description":"Stored screenshot link for follow-up processing"},"archivePdf":{"type":"boolean","description":"Generate archival PDF for crawled pages"}},"additionalProperties":false,"description":"Artifact capture options derived from legacy launch summary"},"rawMode":{"type":"boolean","description":"Whether this is a raw data mode crawl"},"outputOptions":{"type":"object","properties":{"includeHtml":{"type":"boolean"},"includeMarkdown":{"type":"boolean"},"includeScreenshots":{"type":"boolean"},"includeJson":{"type":"boolean"}},"description":"Output options for raw mode"},"jobId":{"type":"string","description":"Internal: Job ID for workflow tracking"},"workflowId":{"type":"string","description":"Internal: Owning workflow (scraperId) for BrightData cost attribution"},"dataKey":{"type":"string","description":"Internal: Data key for Parquet storage path"},"billingSource":{"type":"string","description":"Internal: Billing source identifier"},"configId":{"type":"string","description":"Config ID"},"userId":{"type":"string","description":"User ID"},"createdAt":{"type":"string","description":"Created at"}},"required":["configId","userId","createdAt"],"title":"GetCrawlerConfigResponse","description":"Response schema for getting a crawling configuration"},"DeleteCrawlerConfigRequest":{"type":"object","properties":{"configId":{"type":"string","description":"Config ID"}},"required":["configId"],"title":"DeleteCrawlerConfigRequest","description":"Schema for deleting a crawling configuration"},"DeleteCrawlerConfigResponse":{"type":"object","properties":{"configId":{"type":"string","description":"Config ID"},"deleted":{"type":"boolean","description":"Whether the config was deleted"}},"required":["configId","deleted"],"title":"DeleteCrawlerConfigResponse","description":"Response schema for deleting a crawling configuration"},"StartCrawlerSessionRequest":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Single URL to start crawling (for backward compatibility)"},"startUrls":{"type":"array","items":{"type":"string","format":"uri","minLength":1},"description":"List of URLs for crawling"},"pathsFilterIn":{"type":"array","items":{"type":"string","minLength":1},"description":"Regex patterns to include specific full URLs. Accepts array or JSON-stringified array of regex source strings."},"pathsFilterOut":{"type":"array","items":{"type":"string","minLength":1},"description":"Regex patterns to exclude specific full URLs. Accepts array or JSON-stringified array of regex source strings."},"proxyType":{"type":"string","nullable":true,"description":"Type of proxy to use"},"proxyCountry":{"type":"string","nullable":true,"description":"Country for proxy selection"},"timeout":{"type":"number","minimum":1,"description":"Timeout in milliseconds"},"maxDepth":{"type":"number","minimum":1,"description":"Maximum crawling depth"},"maxPages":{"type":"number","minimum":1,"description":"Maximum number of pages to crawl"},"maxMatches":{"type":"number","minimum":1,"description":"Maximum number of matched pages to crawl before stopping"},"concurrency":{"type":"number","minimum":1,"description":"Number of concurrent crawlers"},"strictDomain":{"default":true,"type":"boolean","description":"Whether to stay within the same domain"},"loadImages":{"default":true,"type":"boolean","description":"Whether to load images during crawling"},"safeMode":{"default":false,"type":"boolean","description":"Enable safe mode for crawling"},"callbackUrl":{"type":"string","format":"uri","nullable":true,"description":"Webhook URL for completion notifications"},"processDuringCrawl":{"type":"boolean","description":"Whether to run preprocessing and extraction during the crawl phase"},"crawlMethod":{"type":"object","properties":{"mode":{"default":"auto","type":"string","enum":["auto","browser"],"description":"Worker selection mode. 'auto' (default) picks cheapest compatible worker, 'browser' forces browser."},"worker":{"type":"string","enum":["auto","kurl","curl-cffi","kadmium","patchright","camoufox","cloakbrowser","brightdata"],"description":"Crawler engine selection. Fetches use Kurl; browser mode and actions use Kadmium. curl-cffi maps to Kurl; patchright, camoufox, and cloakbrowser map to Kadmium. BrightData is blocked."},"proxy":{"type":"string","enum":["auto","direct","dc","resi","isp"],"description":"Explicit proxy routing override for crawler scraping"}},"additionalProperties":{"nullable":true},"description":"Crawl method configuration"},"matchThreshold":{"type":"number","minimum":0,"maximum":1,"description":"Match threshold override for blueprint filtering"},"blueprint":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"selector":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{"nullable":true},"description":"Blueprint field definition"},"description":"Blueprint fields applied during crawling"},"extractionOptions":{"type":"object","properties":{"extractions":{"type":"object","additionalProperties":{"type":"boolean"},"description":"Feature toggles for available extraction helpers"},"schema":{"nullable":true,"description":"Schema definition for structured extractions"},"entity":{"nullable":true,"description":"Entity metadata used for extraction mappings"},"mainContextSelector":{"type":"string","description":"CSS selector anchoring focus-driven extractors"},"xhrExtractorConfigs":{"type":"array","items":{"nullable":true},"description":"XHR extractor configuration entries"}},"additionalProperties":false,"description":"Extraction-related options derived from legacy launch summary"},"navigationOptions":{"type":"object","properties":{"browserActions":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}},"description":"Ordered list of scripted browser actions executed after navigation"},"preBrowserActions":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}},"description":"Browser actions performed before the main action chain"},"scrollHtml":{"type":"boolean","description":"Enable HTML capture while scrolling through the page"},"scrollHtmlTimeout":{"type":"number","minimum":0,"description":"Maximum scroll duration in milliseconds"},"visualHtml":{"type":"boolean","description":"Enable visual HTML capture for navigation heuristics"},"navigationStrategy":{"type":"string","description":"Primary navigation strategy identifier"},"navigationStrategies":{"type":"array","items":{"type":"string"},"description":"Fallback navigation strategy order"},"limit":{"type":"number","minimum":0,"description":"Maximum number of navigation steps"},"disableNavigation":{"type":"boolean","description":"Skip automated navigation heuristics"},"ignoreIframes":{"type":"boolean","description":"Disable iframe traversal during navigation"},"navigationExploration":{"type":"object","additionalProperties":{"nullable":true},"description":"Navigation exploration tuning payload"},"loadHtmlOnly":{"type":"boolean","description":"Skip scripted interactions and only capture HTML"},"acceptCookies":{"type":"boolean","description":"Force cookie acceptance automation"},"cachedCookieAccept":{"oneOf":[{"type":"boolean"},{"type":"string"}],"description":"Reuse cached cookie acceptance flow"}},"additionalProperties":false,"description":"Navigation-related options derived from legacy launch summary"},"artifactOptions":{"type":"object","properties":{"screenshot":{"type":"boolean","description":"Capture standard screenshot"},"screenshotFull":{"type":"boolean","description":"Capture full-page screenshot"},"screenshotCache":{"type":"boolean","description":"Re-use cached screenshot when available"},"screenshotPublic":{"type":"boolean","description":"Make captured screenshot publicly accessible"},"screenshotLink":{"type":"string","description":"Stored screenshot link for follow-up processing"},"archivePdf":{"type":"boolean","description":"Generate archival PDF for crawled pages"}},"additionalProperties":false,"description":"Artifact capture options derived from legacy launch summary"},"rawMode":{"type":"boolean","description":"Whether this is a raw data mode crawl"},"outputOptions":{"type":"object","properties":{"includeHtml":{"type":"boolean"},"includeMarkdown":{"type":"boolean"},"includeScreenshots":{"type":"boolean"},"includeJson":{"type":"boolean"}},"description":"Output options for raw mode"},"jobId":{"type":"string","description":"Internal: Job ID for workflow tracking"},"workflowId":{"type":"string","description":"Internal: Owning workflow (scraperId) for BrightData cost attribution"},"dataKey":{"type":"string","description":"Internal: Data key for Parquet storage path"},"billingSource":{"type":"string","description":"Internal: Billing source identifier"}},"title":"StartCrawlerSessionRequest","description":"Schema for starting a crawling session with support for both single URL and multiple URLs"},"StartCrawlerSessionResponse":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"sessionId":{"type":"string","description":"Session ID"},"configId":{"type":"string","description":"Config ID (included when creating config and starting session)"},"error":{"type":"string","description":"Error message if any","nullable":true}},"required":["message","sessionId","error"],"title":"StartCrawlerSessionResponse","description":"Response schema for starting a crawling session"},"StartSessionWithConfigRequest":{"type":"object","properties":{"configId":{"type":"string","description":"Configuration ID to use for this session"}},"required":["configId"],"title":"StartSessionWithConfigRequest","description":"Schema for starting a session with an existing configuration"},"PauseCrawlerSessionRequest":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID"}},"required":["sessionId"],"title":"PauseCrawlerSessionRequest","description":"Schema for pausing a crawling session"},"PauseCrawlerSessionResponse":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"sessionId":{"type":"string","description":"Session ID"},"error":{"type":"string","description":"Error message if any","nullable":true}},"required":["message","sessionId","error"],"title":"PauseCrawlerSessionResponse","description":"Response schema for pausing a crawling session"},"ResumeCrawlerSessionRequest":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID"}},"required":["sessionId"],"title":"ResumeCrawlerSessionRequest","description":"Schema for resuming a crawling session"},"ResumeCrawlerSessionResponse":{"type":"object","properties":{"message":{"type":"string","description":"Response message"},"sessionId":{"type":"string","description":"Session ID"},"error":{"type":"string","description":"Error message if any","nullable":true}},"required":["message","sessionId","error"],"title":"ResumeCrawlerSessionResponse","description":"Response schema for resuming a crawling session"},"GetCrawlerSessionStatusResponse":{"type":"object","properties":{"payload":{"description":"Details about the crawling session status","nullable":true},"sessionId":{"type":"string","description":"Session ID"},"error":{"type":"string","description":"Error message if any","nullable":true}},"required":["sessionId","error"],"title":"GetCrawlerSessionStatusResponse","description":"Response schema for getting a crawling session status"},"GetCrawlerSessionPagesResponse":{"type":"object","properties":{"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the crawled page"},"url":{"type":"string","description":"URL of the crawled page"},"status":{"type":"string","enum":["DONE","CRAWLING","PENDING"],"description":"Status of the page crawl"}},"required":["id","url","status"]},"description":"List of crawled pages with statuses"},"pagination":{"type":"object","properties":{"page":{"type":"number","description":"Current page number"},"pageSize":{"type":"number","description":"Items per page"},"totalItems":{"type":"number","description":"Total number of items"},"totalPages":{"type":"number","description":"Total number of pages"},"hasMore":{"type":"boolean","description":"Whether there are more pages"}},"required":["page","pageSize","totalItems","totalPages","hasMore"],"description":"Pagination details"},"sessionId":{"type":"string","description":"ID of the crawling session"},"error":{"type":"string","description":"Error message if any","nullable":true}},"required":["payload","pagination","sessionId","error"],"title":"GetCrawlerSessionPagesResponse","description":"Response schema for getting paginated session pages"},"GetCrawlerSessionPageResponse":{"type":"object","properties":{"payload":{"description":"Data associated with the specific page","nullable":true},"pageId":{"type":"string","description":"Unique ID of the page"},"pageFormat":{"type":"string","description":"Format of the retrieved page data"},"sessionId":{"type":"string","description":"Session ID"},"error":{"type":"string","description":"Error message if any","nullable":true}},"required":["pageId","pageFormat","sessionId","error"],"title":"GetCrawlerSessionPageResponse","description":"Response schema for getting a specific session page content"},"GetCrawlerBucketDataResponse":{"title":"GetCrawlerBucketDataResponse","description":"Response schema for getting a crawling bucket data - returns file stream for HTML/images"},"GetCrawlerSessionDataListResponse":{"type":"object","properties":{"totalPages":{"type":"number","description":"Total number of pages in the session"},"data":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"URL of the page"},"status":{"type":"string","description":"Status of the page"},"created_at":{"type":"string","description":"Timestamp when the entry was created"},"html_filename":{"type":"string","description":"Base64 encoded filename for the HTML content (null when HTML not stored)","nullable":true},"screenshot_filename":{"type":"string","description":"Base64 encoded filename for the screenshot (null when screenshot not available)","nullable":true},"processed_html_filename":{"type":"string","description":"Base64 encoded filename for the processed Kadoa HTML","nullable":true},"json_filename":{"type":"string","description":"Base64 encoded filename for the crawler result JSON","nullable":true},"match_score":{"type":"number","description":"Match score between 0 and 1 (null when blueprint not provided)","nullable":true},"matched_fields":{"type":"number","description":"Number of blueprint fields populated for the page","nullable":true},"total_fields":{"type":"number","description":"Total blueprint fields evaluated for matching","nullable":true},"is_match":{"type":"boolean","description":"Whether the page met the blueprint match threshold"}},"required":["url","status","created_at","html_filename","screenshot_filename","processed_html_filename","json_filename","match_score","matched_fields","total_fields","is_match"]},"description":"List of pages in the session"}},"required":["totalPages","data"],"title":"GetCrawlerSessionDataListResponse","description":"Response schema for getting a crawling session data list"},"CrawlerSessionItem":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID"},"configId":{"type":"string","description":"Config ID"},"domain":{"type":"string","description":"Domain being crawled"},"startUrls":{"type":"array","items":{"type":"string"},"description":"URLs used to start the crawl"},"userId":{"type":"string","description":"User ID who created the session"},"createdAt":{"type":"string","description":"Session creation timestamp"},"activeJobs":{"type":"number","description":"Number of active jobs (live stat)"},"waitingJobs":{"type":"number","description":"Number of waiting jobs (live stat)"},"crawledPages":{"type":"number","description":"Number of crawled pages (live stat)"},"finished":{"type":"boolean","description":"Whether session has finished"}},"required":["sessionId","configId","domain","startUrls","userId","createdAt"],"title":"CrawlerSessionItem","description":"Crawling session item"},"ListCrawlerSessionsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CrawlerSessionItem"},"description":"List of sessions"},"pagination":{"type":"object","properties":{"page":{"type":"number","description":"Current page number"},"pageSize":{"type":"number","description":"Items per page"},"totalItems":{"type":"number","description":"Total number of items"},"totalPages":{"type":"number","description":"Total number of pages"},"hasMore":{"type":"boolean","description":"Whether there are more pages"}},"required":["page","pageSize","totalItems","totalPages","hasMore"],"description":"Pagination metadata"}},"required":["data","pagination"],"title":"ListCrawlerSessionsResponse","description":"Response for listing crawling sessions"},"DataField":{"type":"object","properties":{"mapper":{"type":"string","enum":["jobDescription","categoryClassifier","taxonomyMapping","stableUniqueId","linkExtraction","additionalData","categorize"],"description":"Function that produces this field's value."},"mapperConfig":{"type":"object","additionalProperties":{"nullable":true},"description":"Configuration for the selected mapper."},"name":{"description":"Field name (e.g., productName, 3dListings, listing-count)","type":"string","pattern":"^[^.]*$"},"description":{"type":"string","minLength":1,"description":"Human-readable field description shown in Kadoa."},"instruction":{"type":"string","minLength":1,"description":"Optional field-specific AI instruction. Use this for extraction guidance that is more specific than the description."},"fieldType":{"default":"SCHEMA","type":"string","enum":["SCHEMA"],"description":"Field role. Use SCHEMA for extracted data fields."},"example":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Example value for the field"},"shape":{"nullable":true,"description":"Authoritative nested shape for OBJECT/ARRAY fields. Use this for required field structure; without it, a JSON object/array example is promoted to the enforced shape at workflow creation."},"dataType":{"type":"string","description":"Output data type for SCHEMA fields. Use uppercase public values: STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, ARRAY. Classification fields use fieldType=CLASSIFICATION instead of dataType=CLASSIFICATION. Kadoa-managed functions are not data types; they keep a normal output dataType and carry their function identity in mapper, with configuration in mapperConfig.","enum":["STRING","NUMBER","BOOLEAN","DATE","DATETIME","MONEY","IMAGE","LINK","OBJECT","ARRAY"]},"isKey":{"type":"boolean","description":"Marks this field as part of the record's primary key. Key fields define row identity across runs and enable data linking (records with the same key values are treated as the same record over time, used for dedupe and change detection). Set true ONLY when the complete key tuple uniquely identifies a logical output record and every component is stable across runs and reliably present (not nullable/missing). Key fields should be scalar STRING, NUMBER, or LINK fields; avoid structured, semantic, boolean, image, and timestamp/date fields as keys. Good candidates: external IDs, SKUs, canonical URLs, posting IDs. Bad candidates: prices, counts, timestamps, free-text titles/descriptions, or anything that can change between runs. Multiple fields may form a composite key; uniqueness applies to their combination, not each component. For derived rows, source-backed grouping dimensions and a deterministic output discriminator may identify the result; measured values and explanations do not. If no supported key tuple satisfies these guarantees, leave isKey unset on every field — data linking will simply be disabled, which is preferable to a wrong key. Choosing a non-stable or non-unique key causes duplicate rows and missed updates."}},"required":["name","description","dataType"],"additionalProperties":{"nullable":true},"title":"DataField","description":"Extract and structure specific data from web pages with typed values (e.g., product prices, article titles, dates). `description` explains what the field is; optional `instruction` gives the AI field-specific extraction guidance. Use this for actual data you want to capture. Kadoa-managed functions such as job description, job type classification, taxonomy mapping, and stable unique ID are normal `fieldType: SCHEMA` fields with their output `dataType`; their function identity lives in `mapper`. To expose source values such as the page URL, full HTML, or full Markdown, use a normal `fieldType: SCHEMA` field with `params.sourceKey` (for example `link`, `allExtracts.fullHtml`, or `allExtracts.fullMarkdown`)."},"ClassificationField":{"type":"object","properties":{"name":{"description":"Field name (e.g., category, product-type)","type":"string","pattern":"^[^.]*$"},"description":{"type":"string","minLength":1,"description":"Optional human-readable field description"},"fieldType":{"type":"string","enum":["CLASSIFICATION"],"description":"Field role. Use CLASSIFICATION for predefined category labels."},"categories":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Short title/label of the category"},"definition":{"type":"string","description":"Full definition/description of the category"}},"required":["title","definition"]},"description":"List of predefined categories for classification"}},"required":["name","fieldType","categories"],"additionalProperties":true,"title":"ClassificationField","description":"Categorize extracted data into predefined labels. Classification is a field role (`fieldType: CLASSIFICATION`), not a schema data type. Use this when you want the system to classify content into specific categories you define."},"SchemaResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the schema"},"name":{"type":"string","description":"Name of the schema"},"isPublic":{"type":"boolean","description":"Whether the schema is public"},"schema":{"type":"array","items":{"description":"Extraction field schema","discriminator":{"propertyName":"fieldType"},"oneOf":[{"$ref":"#/components/schemas/DataField"},{"$ref":"#/components/schemas/ClassificationField"}]},"description":"Array of field definitions"},"entity":{"type":"string","description":"Entity type for the schema","nullable":true},"description":{"type":"object","properties":{"hintText":{"type":"string","description":"Hint text for the schema"}},"required":["hintText"],"description":"Schema description metadata"}},"required":["id","name","isPublic","schema","entity","description"],"title":"SchemaResponse","description":"Schema object response"},"SchemasListResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SchemaResponse"},"description":"Array of schemas"}},"required":["error","data"],"title":"SchemasListResponse","description":"Response wrapper for list of schemas"},"SchemaDataResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the schema"},"name":{"type":"string","description":"Name of the schema"},"isPublic":{"type":"boolean","description":"Whether the schema is public"},"schema":{"type":"array","items":{"description":"Extraction field schema","discriminator":{"propertyName":"fieldType"},"oneOf":[{"$ref":"#/components/schemas/DataField"},{"$ref":"#/components/schemas/ClassificationField"}]},"description":"Array of field definitions"},"entity":{"type":"string","description":"Entity type for the schema","nullable":true},"description":{"type":"object","properties":{"hintText":{"type":"string","description":"Hint text for the schema"}},"required":["hintText"],"description":"Schema description metadata"}},"required":["id","name","isPublic","schema","entity","description"],"description":"Schema data"}},"required":["error","data"],"title":"SchemaDataResponse","description":"Response wrapper for a single schema"},"CreateSchemaBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of the schema"},"entity":{"type":"string","minLength":1,"description":"Entity type for the schema"},"fields":{"type":"array","items":{"description":"Extraction field schema","discriminator":{"propertyName":"fieldType"},"oneOf":[{"$ref":"#/components/schemas/DataField"},{"$ref":"#/components/schemas/ClassificationField"}]},"minItems":1,"description":"Schema fields for extraction - choose from Data Field (typed data) or Classification Field"}},"required":["name","fields"],"title":"CreateSchemaBody","description":"Request body for creating a new schema"},"CreateSchemaResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","description":"Success flag"},"schemaId":{"type":"string","description":"ID of the created schema"},"message":{"type":"string","description":"Success message"},"createdAt":{"type":"string","description":"Creation timestamp"},"updatedAt":{"type":"string","description":"Last update timestamp"}},"required":["error","success","schemaId","message"],"title":"CreateSchemaResponse","description":"Response for schema creation"},"UpdateSchemaBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of the schema"},"entity":{"type":"string","minLength":1,"description":"Entity type for the schema","nullable":true},"fields":{"type":"array","items":{"description":"Extraction field schema","discriminator":{"propertyName":"fieldType"},"oneOf":[{"$ref":"#/components/schemas/DataField"},{"$ref":"#/components/schemas/ClassificationField"}]},"description":"Array of field definitions"}},"title":"UpdateSchemaBody","description":"Request body for updating a schema"},"UpdateSchemaResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","description":"Success flag"},"message":{"type":"string","description":"Success message"},"updatedSchema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the schema"},"name":{"type":"string","description":"Name of the schema"},"isPublic":{"type":"boolean","description":"Whether the schema is public"},"schema":{"type":"array","items":{"description":"Extraction field schema","discriminator":{"propertyName":"fieldType"},"oneOf":[{"$ref":"#/components/schemas/DataField"},{"$ref":"#/components/schemas/ClassificationField"}]},"description":"Array of field definitions"},"entity":{"type":"string","description":"Entity type for the schema","nullable":true},"description":{"type":"object","properties":{"hintText":{"type":"string","description":"Hint text for the schema"}},"required":["hintText"],"description":"Schema description metadata"}},"required":["id","name","isPublic","schema","entity","description"],"description":"The updated schema data (returned to avoid read-replica lag)"}},"required":["error","success","message"],"title":"UpdateSchemaResponse","description":"Response for schema update"},"DeleteSchemaResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","description":"Success flag"},"message":{"type":"string","description":"Success message"}},"required":["error","success","message"],"title":"DeleteSchemaResponse","description":"Response for schema deletion"},"LatestVersionSummary":{"type":"object","properties":{"promptPreview":{"type":"string","description":"Truncated prompt prefix (capped at ~280 chars with ellipsis) for list display. null when the latest version has no prompt.","nullable":true},"schemaFieldNames":{"type":"array","items":{"type":"string"},"description":"Field names of the latest version's schema, in declared order. Empty when the version has no schema."},"dqRuleCount":{"type":"integer","description":"Count of data-quality rule fields on the latest version (top-level keys of schemaValidationRules, which are field names)."},"notificationChannelCount":{"type":"integer","description":"Count of distinct notification channels across all events on the latest version."},"frequencyInterval":{"type":"string","enum":["ONLY_ONCE","EVERY_10_MINUTES","EVERY_20_MINUTES","HALF_HOURLY","HOURLY","TWO_HOURLY","THREE_HOURLY","FOUR_HOURLY","SIX_HOURLY","TWELVE_HOURLY","EIGHTEEN_HOURLY","DAILY","TWO_DAY","THREE_DAY","WEEKLY","BIWEEKLY","TRIWEEKLY","FOUR_WEEKS","MONTHLY","CUSTOM"],"description":"Frequency interval enum of the latest version. null when the version does not control frequency.","nullable":true},"frequencyWeekdaysOnly":{"type":"boolean","description":"Whether the latest version skips Saturday and Sunday runs."}},"required":["promptPreview","schemaFieldNames","dqRuleCount","notificationChannelCount","frequencyInterval","frequencyWeekdaysOnly"],"title":"LatestVersionSummary","description":"Content preview of the latest version for list rendering. null when the template has no published versions; omitted by create/update/duplicate responses."},"TemplateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Template ID"},"name":{"type":"string","description":"Template name"},"description":{"type":"string","description":"Template description","nullable":true},"teamId":{"type":"string","format":"uuid","description":"Owning team ID"},"latestVersion":{"type":"number","description":"Latest published version number","nullable":true},"workflowCount":{"type":"number","description":"Number of workflows linked to this template"},"latestVersionSummary":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LatestVersionSummary"}]},"archivedAt":{"type":"string","description":"Archive timestamp (null if active)","nullable":true},"createdAt":{"type":"string","description":"Creation timestamp"},"updatedAt":{"type":"string","description":"Last update timestamp"}},"required":["id","name","description","teamId","latestVersion","archivedAt","createdAt","updatedAt"],"title":"TemplateResponse","description":"Template object response"},"TemplateListResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponse"},"description":"List of templates"}},"required":["error","data"],"title":"TemplateListResponse","description":"Response wrapper for list of templates"},"TemplateDetailResponseBody":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Template ID"},"name":{"type":"string","description":"Template name"},"description":{"type":"string","description":"Template description","nullable":true},"teamId":{"type":"string","format":"uuid","description":"Owning team ID"},"latestVersion":{"type":"number","description":"Latest published version number","nullable":true},"workflowCount":{"type":"number","description":"Number of workflows linked to this template"},"latestVersionSummary":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LatestVersionSummary"}]},"archivedAt":{"type":"string","description":"Archive timestamp (null if active)","nullable":true},"createdAt":{"type":"string","description":"Creation timestamp"},"updatedAt":{"type":"string","description":"Last update timestamp"},"versions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Version row ID"},"templateId":{"type":"string","format":"uuid","description":"Parent template ID"},"version":{"type":"number","description":"Version number"},"name":{"type":"string","description":"Custom display name (null = default 'v.N')","nullable":true},"publisher":{"type":"object","properties":{"kind":{"type":"string","enum":["HUMAN","SERVICE_ACCOUNT","AGENT","SYSTEM"],"description":"Publisher kind; null for legacy/unproven versions","nullable":true},"label":{"type":"string","description":"Current human name/email, non-human publisher label, or Unknown for legacy/unproven versions"}},"required":["kind","label"],"description":"Publisher attribution"},"prompt":{"type":"string","description":"User prompt","nullable":true},"schemaId":{"type":"string","format":"uuid","description":"Referenced data_schemas ID","nullable":true},"schemaFields":{"type":"array","items":{"type":"object","properties":{"mapper":{"type":"string","enum":["jobDescription","categoryClassifier","taxonomyMapping","stableUniqueId","linkExtraction","additionalData","categorize"],"description":"Function that produces this field's value."},"mapperConfig":{"type":"object","additionalProperties":{"nullable":true},"description":"Configuration for the selected mapper."},"name":{"type":"string","description":"Field name"},"description":{"type":"string","description":"Human-readable field description shown in Kadoa"},"instruction":{"type":"string","description":"Optional field-specific AI instruction for extraction guidance"},"fieldType":{"type":"string","description":"Field role (SCHEMA or CLASSIFICATION)"},"example":{"nullable":true,"description":"Example value (string, array, or object for OBJECT/ARRAY dataTypes)"},"shape":{"nullable":true,"description":"Authoritative nested shape for OBJECT/ARRAY fields; without it, a JSON object/array example is promoted to the enforced shape at workflow creation."},"dataType":{"type":"string","description":"Output data type for SCHEMA fields. Use public values such as STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, or ARRAY."},"isKey":{"type":"boolean","description":"Marks this field as part of the record's primary key. Key fields define row identity across runs and enable data linking (records with the same key values are treated as the same record over time, used for dedupe and change detection). Set true ONLY when the complete key tuple uniquely identifies a logical output record and every component is stable across runs and reliably present (not nullable/missing). Key fields should be scalar STRING, NUMBER, or LINK fields; avoid structured, semantic, boolean, image, and timestamp/date fields as keys. Good candidates: external IDs, SKUs, canonical URLs, posting IDs. Bad candidates: prices, counts, timestamps, free-text titles/descriptions, or anything that can change between runs. Multiple fields may form a composite key; uniqueness applies to their combination, not each component. For derived rows, source-backed grouping dimensions and a deterministic output discriminator may identify the result; measured values and explanations do not. If no supported key tuple satisfies these guarantees, leave isKey unset on every field — data linking will simply be disabled, which is preferable to a wrong key. Choosing a non-stable or non-unique key causes duplicate rows and missed updates."},"categories":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Short title/label of the category"},"definition":{"type":"string","description":"Full definition/description of the category"}},"required":["title","definition"]},"description":"Predefined categories for CLASSIFICATION fields"}},"required":["name"],"additionalProperties":{"nullable":true}},"nullable":true,"description":"Resolved schema fields from data_schemas"},"schemaValidationRules":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"nullable":true}},"description":"Schema validation rules for this version","nullable":true},"notifications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Notification configuration ID"},"eventType":{"type":"string","description":"Event type (e.g., workflow_finished, error)"},"eventConfiguration":{"type":"object","additionalProperties":{"nullable":true},"description":"Event-specific config"},"enabled":{"type":"boolean","description":"Whether this notification is enabled"},"channels":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string","format":"uuid"},"channelName":{"type":"string"},"channelType":{"type":"string"}},"required":["channelId","channelName","channelType"]},"description":"Linked notification channels"}},"required":["id","eventType","eventConfiguration","enabled","channels"]}},"frequency":{"type":"object","properties":{"interval":{"type":"string","enum":["ONLY_ONCE","EVERY_10_MINUTES","EVERY_20_MINUTES","HALF_HOURLY","HOURLY","TWO_HOURLY","THREE_HOURLY","FOUR_HOURLY","SIX_HOURLY","TWELVE_HOURLY","EIGHTEEN_HOURLY","DAILY","TWO_DAY","THREE_DAY","WEEKLY","BIWEEKLY","TRIWEEKLY","FOUR_WEEKS","MONTHLY","CUSTOM"],"description":"Update interval enum (HOURLY/DAILY/CUSTOM/...). When CUSTOM, schedules must be provided."},"schedules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["repeat","cron"],"description":"Schedule type"},"interval":{"type":"string","description":"Repeat token (e.g., '1h', '1d') when type=repeat"},"expressions":{"type":"array","items":{"type":"string"},"description":"Cron expressions when type=cron"},"timezone":{"type":"string","description":"IANA timezone for cron expressions (e.g. 'America/New_York'). Defaults to UTC."}},"required":["type"]},"description":"Cron/repeat schedule specs. Required when interval=CUSTOM."},"weekdaysOnly":{"type":"boolean","description":"Skip runs that fall on Saturday or Sunday. Applies only to repeat intervals; for cron, set the weekdays in the expression."}},"description":"Frequency configuration for this version","nullable":true},"recordLimit":{"type":"integer","minimum":1,"maximum":2147483647,"nullable":true,"description":"Immutable output record limit; null when managed unlimited or unmanaged"},"recordLimitManaged":{"type":"boolean","description":"Whether this version owns the workflow output record limit"},"createdAt":{"type":"string","description":"Creation timestamp"},"schemaName":{"type":"string","nullable":true,"description":"Name of the linked schema"},"schemaEntity":{"type":"string","nullable":true,"description":"Entity name from the linked schema"}},"required":["id","templateId","version","name","publisher","prompt","schemaId","frequency","createdAt"]},"description":"All published versions"}},"required":["id","name","description","teamId","latestVersion","archivedAt","createdAt","updatedAt","versions"],"description":"Template with versions"}},"required":["error","data"],"title":"TemplateDetailResponseBody","description":"Response wrapper for template detail"},"CreateTemplateBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of the template"},"description":{"type":"string","maxLength":2000,"description":"Description of the template"}},"required":["name"],"title":"CreateTemplateBody","description":"Request body for creating a new template"},"TemplateCreatedResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","enum":[true],"description":"Success flag"},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Template ID"},"name":{"type":"string","description":"Template name"},"description":{"type":"string","description":"Template description","nullable":true},"teamId":{"type":"string","format":"uuid","description":"Owning team ID"},"latestVersion":{"type":"number","description":"Latest published version number","nullable":true},"workflowCount":{"type":"number","description":"Number of workflows linked to this template"},"latestVersionSummary":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LatestVersionSummary"}]},"archivedAt":{"type":"string","description":"Archive timestamp (null if active)","nullable":true},"createdAt":{"type":"string","description":"Creation timestamp"},"updatedAt":{"type":"string","description":"Last update timestamp"}},"required":["id","name","description","teamId","latestVersion","archivedAt","createdAt","updatedAt"],"description":"Created template"}},"required":["error","success","data"],"title":"TemplateCreatedResponse","description":"Response for template creation"},"UpdateTemplateBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Updated name"},"description":{"type":"string","maxLength":2000,"nullable":true,"description":"Updated description"}},"title":"UpdateTemplateBody","description":"Request body for updating a template"},"TemplateUpdatedResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","enum":[true],"description":"Success flag"},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Template ID"},"name":{"type":"string","description":"Template name"},"description":{"type":"string","description":"Template description","nullable":true},"teamId":{"type":"string","format":"uuid","description":"Owning team ID"},"latestVersion":{"type":"number","description":"Latest published version number","nullable":true},"workflowCount":{"type":"number","description":"Number of workflows linked to this template"},"latestVersionSummary":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LatestVersionSummary"}]},"archivedAt":{"type":"string","description":"Archive timestamp (null if active)","nullable":true},"createdAt":{"type":"string","description":"Creation timestamp"},"updatedAt":{"type":"string","description":"Last update timestamp"}},"required":["id","name","description","teamId","latestVersion","archivedAt","createdAt","updatedAt"],"description":"Updated template"}},"required":["error","success","data"],"title":"TemplateUpdatedResponse","description":"Response for template update"},"TemplateArchivedResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","enum":[true],"description":"Success flag"},"message":{"type":"string","description":"Archive confirmation message"},"unlinkedWorkflowCount":{"type":"integer","minimum":0,"description":"Number of workflows unlinked by this archive"}},"required":["error","success","message","unlinkedWorkflowCount"],"title":"TemplateArchivedResponse","description":"Response for template archival"},"DuplicateTemplateBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name for the duplicate. Defaults to the source name with a collision-safe \"(Copy)\" suffix."}},"title":"DuplicateTemplateBody","description":"Request body for duplicating a template (all versions and configs, no linked workflows)"},"CreateTemplateVersionBody":{"type":"object","properties":{"prompt":{"type":"string","nullable":true,"description":"Prompt; omit to inherit, null to clear"},"schemaId":{"type":"string","format":"uuid","nullable":true,"description":"Schema ID; omit to inherit, null to clear (mutually exclusive with schemaFields)"},"schemaFields":{"type":"array","items":{"type":"object","properties":{"mapper":{"type":"string","enum":["jobDescription","categoryClassifier","taxonomyMapping","stableUniqueId","linkExtraction","additionalData","categorize"],"description":"Function that produces this field's value."},"mapperConfig":{"type":"object","additionalProperties":{"nullable":true},"description":"Configuration for the selected mapper."},"name":{"type":"string","description":"Field name"},"description":{"type":"string","description":"Human-readable field description shown in Kadoa"},"instruction":{"type":"string","description":"Optional field-specific AI instruction for extraction guidance"},"fieldType":{"type":"string","description":"Field role (SCHEMA or CLASSIFICATION)"},"example":{"nullable":true,"description":"Example value (string, array, or object for OBJECT/ARRAY dataTypes)"},"shape":{"nullable":true,"description":"Authoritative nested shape for OBJECT/ARRAY fields; without it, a JSON object/array example is promoted to the enforced shape at workflow creation."},"dataType":{"type":"string","description":"Output data type for SCHEMA fields. Use public values such as STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, or ARRAY."},"isKey":{"type":"boolean","description":"Marks this field as part of the record's primary key. Key fields define row identity across runs and enable data linking (records with the same key values are treated as the same record over time, used for dedupe and change detection). Set true ONLY when the complete key tuple uniquely identifies a logical output record and every component is stable across runs and reliably present (not nullable/missing). Key fields should be scalar STRING, NUMBER, or LINK fields; avoid structured, semantic, boolean, image, and timestamp/date fields as keys. Good candidates: external IDs, SKUs, canonical URLs, posting IDs. Bad candidates: prices, counts, timestamps, free-text titles/descriptions, or anything that can change between runs. Multiple fields may form a composite key; uniqueness applies to their combination, not each component. For derived rows, source-backed grouping dimensions and a deterministic output discriminator may identify the result; measured values and explanations do not. If no supported key tuple satisfies these guarantees, leave isKey unset on every field — data linking will simply be disabled, which is preferable to a wrong key. Choosing a non-stable or non-unique key causes duplicate rows and missed updates."},"categories":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Short title/label of the category"},"definition":{"type":"string","description":"Full definition/description of the category"}},"required":["title","definition"]},"description":"Predefined categories for CLASSIFICATION fields"}},"required":["name"],"additionalProperties":{"nullable":true}},"nullable":true,"description":"Inline schema fields; omit to inherit, null to clear"},"schemaEntity":{"type":"string","description":"Entity name for supplied inline schema fields"},"schemaValidationRules":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"nullable":true}},"description":"Rules; omit to inherit rules for fields retained by a replacement schema, null to clear, {} to manage an empty ruleset","nullable":true},"notifications":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string"},"eventConfiguration":{"type":"object","additionalProperties":{"nullable":true}},"enabled":{"type":"boolean"},"channelIds":{"type":"array","items":{"type":"string","format":"uuid"}},"channels":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string","format":"uuid"}},"required":["channelId"]}}},"required":["eventType"]},"nullable":true,"description":"Notifications; omit to inherit, null or [] to clear"},"frequency":{"type":"object","properties":{"interval":{"type":"string","enum":["ONLY_ONCE","EVERY_10_MINUTES","EVERY_20_MINUTES","HALF_HOURLY","HOURLY","TWO_HOURLY","THREE_HOURLY","FOUR_HOURLY","SIX_HOURLY","TWELVE_HOURLY","EIGHTEEN_HOURLY","DAILY","TWO_DAY","THREE_DAY","WEEKLY","BIWEEKLY","TRIWEEKLY","FOUR_WEEKS","MONTHLY","CUSTOM"],"description":"Update interval enum (HOURLY/DAILY/CUSTOM/...). When CUSTOM, schedules must be provided."},"schedules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["repeat","cron"],"description":"Schedule type"},"interval":{"type":"string","description":"Repeat token (e.g., '1h', '1d') when type=repeat"},"expressions":{"type":"array","items":{"type":"string"},"description":"Cron expressions when type=cron"},"timezone":{"type":"string","description":"IANA timezone for cron expressions (e.g. 'America/New_York'). Defaults to UTC."}},"required":["type"]},"description":"Cron/repeat schedule specs. Required when interval=CUSTOM."},"weekdaysOnly":{"type":"boolean","description":"Skip runs that fall on Saturday or Sunday. Applies only to repeat intervals; for cron, set the weekdays in the expression."}},"nullable":true,"description":"Frequency; omit to inherit, null to clear"},"recordLimit":{"type":"integer","minimum":1,"maximum":2147483647,"nullable":true,"description":"Output record limit; omit to inherit, null for template-managed unlimited"},"recordLimitManaged":{"type":"boolean","enum":[false],"description":"False clears template ownership of the output record limit"}},"title":"CreateTemplateVersionBody","description":"Publish a complete immutable template snapshot. Omitted components inherit from the preceding version; null explicitly clears a component."},"TemplateVersionMutationResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","enum":[true],"description":"Success flag"},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Version row ID"},"templateId":{"type":"string","format":"uuid","description":"Parent template ID"},"version":{"type":"number","description":"Version number"},"name":{"type":"string","description":"Custom display name (null = default 'v.N')","nullable":true},"publisher":{"type":"object","properties":{"kind":{"type":"string","enum":["HUMAN","SERVICE_ACCOUNT","AGENT","SYSTEM"],"description":"Publisher kind; null for legacy/unproven versions","nullable":true},"label":{"type":"string","description":"Current human name/email, non-human publisher label, or Unknown for legacy/unproven versions"}},"required":["kind","label"],"description":"Publisher attribution"},"prompt":{"type":"string","description":"User prompt","nullable":true},"schemaId":{"type":"string","format":"uuid","description":"Referenced data_schemas ID","nullable":true},"schemaFields":{"type":"array","items":{"type":"object","properties":{"mapper":{"type":"string","enum":["jobDescription","categoryClassifier","taxonomyMapping","stableUniqueId","linkExtraction","additionalData","categorize"],"description":"Function that produces this field's value."},"mapperConfig":{"type":"object","additionalProperties":{"nullable":true},"description":"Configuration for the selected mapper."},"name":{"type":"string","description":"Field name"},"description":{"type":"string","description":"Human-readable field description shown in Kadoa"},"instruction":{"type":"string","description":"Optional field-specific AI instruction for extraction guidance"},"fieldType":{"type":"string","description":"Field role (SCHEMA or CLASSIFICATION)"},"example":{"nullable":true,"description":"Example value (string, array, or object for OBJECT/ARRAY dataTypes)"},"shape":{"nullable":true,"description":"Authoritative nested shape for OBJECT/ARRAY fields; without it, a JSON object/array example is promoted to the enforced shape at workflow creation."},"dataType":{"type":"string","description":"Output data type for SCHEMA fields. Use public values such as STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, or ARRAY."},"isKey":{"type":"boolean","description":"Marks this field as part of the record's primary key. Key fields define row identity across runs and enable data linking (records with the same key values are treated as the same record over time, used for dedupe and change detection). Set true ONLY when the complete key tuple uniquely identifies a logical output record and every component is stable across runs and reliably present (not nullable/missing). Key fields should be scalar STRING, NUMBER, or LINK fields; avoid structured, semantic, boolean, image, and timestamp/date fields as keys. Good candidates: external IDs, SKUs, canonical URLs, posting IDs. Bad candidates: prices, counts, timestamps, free-text titles/descriptions, or anything that can change between runs. Multiple fields may form a composite key; uniqueness applies to their combination, not each component. For derived rows, source-backed grouping dimensions and a deterministic output discriminator may identify the result; measured values and explanations do not. If no supported key tuple satisfies these guarantees, leave isKey unset on every field — data linking will simply be disabled, which is preferable to a wrong key. Choosing a non-stable or non-unique key causes duplicate rows and missed updates."},"categories":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Short title/label of the category"},"definition":{"type":"string","description":"Full definition/description of the category"}},"required":["title","definition"]},"description":"Predefined categories for CLASSIFICATION fields"}},"required":["name"],"additionalProperties":{"nullable":true}},"nullable":true,"description":"Resolved schema fields from data_schemas"},"schemaValidationRules":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"nullable":true}},"description":"Schema validation rules for this version","nullable":true},"notifications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Notification configuration ID"},"eventType":{"type":"string","description":"Event type (e.g., workflow_finished, error)"},"eventConfiguration":{"type":"object","additionalProperties":{"nullable":true},"description":"Event-specific config"},"enabled":{"type":"boolean","description":"Whether this notification is enabled"},"channels":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string","format":"uuid"},"channelName":{"type":"string"},"channelType":{"type":"string"}},"required":["channelId","channelName","channelType"]},"description":"Linked notification channels"}},"required":["id","eventType","eventConfiguration","enabled","channels"]}},"frequency":{"type":"object","properties":{"interval":{"type":"string","enum":["ONLY_ONCE","EVERY_10_MINUTES","EVERY_20_MINUTES","HALF_HOURLY","HOURLY","TWO_HOURLY","THREE_HOURLY","FOUR_HOURLY","SIX_HOURLY","TWELVE_HOURLY","EIGHTEEN_HOURLY","DAILY","TWO_DAY","THREE_DAY","WEEKLY","BIWEEKLY","TRIWEEKLY","FOUR_WEEKS","MONTHLY","CUSTOM"],"description":"Update interval enum (HOURLY/DAILY/CUSTOM/...). When CUSTOM, schedules must be provided."},"schedules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["repeat","cron"],"description":"Schedule type"},"interval":{"type":"string","description":"Repeat token (e.g., '1h', '1d') when type=repeat"},"expressions":{"type":"array","items":{"type":"string"},"description":"Cron expressions when type=cron"},"timezone":{"type":"string","description":"IANA timezone for cron expressions (e.g. 'America/New_York'). Defaults to UTC."}},"required":["type"]},"description":"Cron/repeat schedule specs. Required when interval=CUSTOM."},"weekdaysOnly":{"type":"boolean","description":"Skip runs that fall on Saturday or Sunday. Applies only to repeat intervals; for cron, set the weekdays in the expression."}},"description":"Frequency configuration for this version","nullable":true},"recordLimit":{"type":"integer","minimum":1,"maximum":2147483647,"nullable":true,"description":"Immutable output record limit; null when managed unlimited or unmanaged"},"recordLimitManaged":{"type":"boolean","description":"Whether this version owns the workflow output record limit"},"createdAt":{"type":"string","description":"Creation timestamp"}},"required":["id","templateId","version","name","publisher","prompt","schemaId","frequency","createdAt"],"description":"Template version"}},"required":["error","success","data"],"title":"TemplateVersionMutationResponse","description":"Response for template version create/update"},"UpdateTemplateVersionBody":{"type":"object","properties":{"name":{"description":"Custom display name. null, 'null', empty, or whitespace clears the name and restores the default 'v.N' label.","type":"string","maxLength":100,"nullable":true}},"required":["name"],"title":"UpdateTemplateVersionBody","description":"Request body for renaming a template version"},"TemplateSchemasResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"data":{"type":"array","items":{"type":"object","properties":{"schemaId":{"type":"string","format":"uuid","description":"Schema ID"},"schemaName":{"type":"string","description":"Schema name"},"entity":{"type":"string","description":"Entity name","nullable":true},"fieldCount":{"type":"number","description":"Number of fields in the schema"}},"required":["schemaId","schemaName","entity","fieldCount"]},"description":"Schemas linked to this template"}},"required":["error","data"],"title":"TemplateSchemasResponse","description":"Response for listing schemas linked to a template"},"TemplateWorkflowsResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"data":{"type":"array","items":{"type":"object","properties":{"workflowId":{"type":"string","format":"uuid","description":"Workflow ID"},"workflowName":{"type":"string","description":"Workflow name"},"templateVersion":{"type":"number","description":"Template version the workflow was created from"},"isOutdated":{"type":"boolean","description":"Whether a newer template version exists"},"state":{"type":"string","description":"Current workflow state"}},"required":["workflowId","workflowName","templateVersion","isOutdated","state"]},"description":"Workflows linked to this template"}},"required":["error","data"],"title":"TemplateWorkflowsResponse","description":"Response for listing workflows created from a template"},"ApplyTemplateUpdateBody":{"type":"object","properties":{"targetVersion":{"type":"integer","minimum":1,"description":"Template version to apply"},"workflowIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":2000,"description":"Workflow IDs to update (max 2000)"}},"required":["targetVersion","workflowIds"],"title":"ApplyTemplateUpdateBody","description":"Request body for applying a template version update to existing workflows"},"ApplyTemplateUpdateResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","enum":[true],"description":"Success flag"},"updatedCount":{"type":"number","description":"Number of workflows updated"},"workflowIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of updated workflows"},"controlledParts":{"type":"object","properties":{"prompt":{"type":"boolean","description":"Whether the template controlled the prompt"},"schema":{"type":"boolean","description":"Whether the template controlled the schema"},"schemaValidationRules":{"type":"boolean","description":"Whether the template controlled the schema validation rules"},"notifications":{"type":"boolean","description":"Whether the template controlled notifications"},"frequency":{"type":"boolean","description":"Whether the template controlled the frequency"}},"required":["prompt","schema","schemaValidationRules","notifications","frequency"],"description":"Which workflow parts were updated by this template version"}},"required":["error","success","updatedCount","workflowIds","controlledParts"],"title":"ApplyTemplateUpdateResponse","description":"Response for template update application"},"SchemaChangePreviewBody":{"type":"object","properties":{"workflowId":{"type":"string","format":"uuid","description":"Linked workflow to preview"},"targetVersion":{"type":"integer","minimum":1,"description":"Template version to preview"}},"required":["workflowId","targetVersion"],"title":"SchemaChangePreviewBody","description":"Request body for previewing a schema change without applying it"},"SchemaChangePreviewResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"data":{"type":"object","properties":{"workflowId":{"type":"string","format":"uuid"},"workflowName":{"type":"string"},"currentVersion":{"type":"integer","minimum":1},"targetVersion":{"type":"integer","minimum":1},"basis":{"type":"string","enum":["existing_data","configuration_only"]},"columns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"label":{"type":"string","minLength":1},"dataType":{"type":"string","minLength":1,"description":"Target datatype, or the previous datatype for a removed field"},"previousDataType":{"type":"string","minLength":1,"description":"Effective datatype before the schema change, if any","nullable":true},"beforeValueSource":{"type":"string","enum":["observed","none"],"description":"Where the before value came from: observed in stored output, or none"},"afterValueSource":{"type":"string","enum":["observed","simulated","none"],"description":"Where the after value came from: observed, simulated by the model, or none"},"truncated":{"type":"boolean","description":"Whether a value for this field was truncated to fit the preview budget; absent means not truncated"},"status":{"type":"string","enum":["unchanged","removed","added","updated"]}},"required":["name","label","dataType","previousDataType","beforeValueSource","afterValueSource","status"]}},"beforeRows":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}},"maxItems":10},"rows":{"type":"array","items":{"type":"object","additionalProperties":{"nullable":true}},"maxItems":10},"truncated":{"type":"boolean","description":"Whether any preview value was truncated to fit the data budget"}},"required":["workflowId","workflowName","currentVersion","targetVersion","basis","columns","beforeRows","rows","truncated"]}},"required":["error","data"],"title":"SchemaChangePreviewResponse","description":"Read-only AI-generated preview of how a schema change affects one linked workflow's data"},"LinkWorkflowsBody":{"type":"object","properties":{"workflowIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":2000,"description":"Workflow IDs to link to this template"},"force":{"type":"boolean","description":"If true, relink workflows that are already linked to another template"}},"required":["workflowIds"],"title":"LinkWorkflowsBody","description":"Request body for linking workflows to a template"},"LinkWorkflowsResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","enum":[true],"description":"Success flag"},"linkedCount":{"type":"number","description":"Number of workflows linked"},"workflowIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of linked workflows"}},"required":["error","success","linkedCount","workflowIds"],"title":"LinkWorkflowsResponse","description":"Response for linking workflows to a template"},"LinkWorkflowsConflictResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[true],"description":"Error flag"},"code":{"type":"string","enum":["CONFLICT"],"description":"Error code"},"conflicts":{"type":"array","items":{"type":"object","properties":{"workflowId":{"type":"string","format":"uuid"},"workflowName":{"type":"string"},"templateId":{"type":"string","format":"uuid"},"templateName":{"type":"string"}},"required":["workflowId","workflowName","templateId","templateName"]},"description":"Workflows already linked to another template"}},"required":["error","code","conflicts"],"title":"LinkWorkflowsConflictResponse","description":"Response when workflows are already linked to another template"},"SaveFromWorkflowBody":{"type":"object","properties":{"workflowId":{"type":"string","format":"uuid","description":"Source workflow ID to extract config from"},"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name for the new template (required if templateId is not set)"},"description":{"type":"string","maxLength":2000,"description":"Description for the new template"},"templateId":{"type":"string","format":"uuid","description":"Existing template ID to add a new version to (mutually exclusive with name)"},"includeParts":{"type":"array","items":{"type":"string","enum":["prompt","schema","schemaValidationRules","notifications","frequency","recordLimit"]},"minItems":1,"description":"Which workflow parts to include in the template. If omitted, all parts are included."}},"required":["workflowId"],"title":"SaveFromWorkflowBody","description":"Request body for saving a workflow's config as a template (new or existing)"},"SaveFromWorkflowResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","enum":[true],"description":"Success flag"},"data":{"type":"object","properties":{"templateId":{"type":"string","format":"uuid","description":"Template ID (new or existing)"},"version":{"type":"number","description":"Published version number"},"isNew":{"type":"boolean","description":"Whether a new template was created"}},"required":["templateId","version","isNew"]}},"required":["error","success","data"],"title":"SaveFromWorkflowResponse","description":"Response for saving a workflow as a template"},"UnlinkWorkflowsBody":{"type":"object","properties":{"workflowIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":2000,"description":"Workflow IDs to unlink from this template"}},"required":["workflowIds"],"title":"UnlinkWorkflowsBody","description":"Request body for unlinking workflows from a template"},"UnlinkWorkflowsResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","enum":[true],"description":"Success flag"},"unlinkedCount":{"type":"number","description":"Number of workflows unlinked"},"workflowIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of unlinked workflows"}},"required":["error","success","unlinkedCount","workflowIds"],"title":"UnlinkWorkflowsResponse","description":"Response for unlinking workflows from a template"},"Location":{"type":"object","properties":{"type":{"type":"string","enum":["auto","manual"],"description":"Location type"},"isoCode":{"type":"string","description":"Country ISO code for manual location"}},"required":["type"],"title":"Location","description":"Geographic location for scraping. Use 'auto' for automatic detection or 'manual' to specify a country"},"BrowserInteraction":{"type":"object","properties":{"type":{"type":"string","enum":["CLICK","TYPE","HOVER","SCROLL","WAIT","KEYPRESS","LOAD","SELECT","BACKSPACE","ENTER","TAB","DELETE","GOTO","REFRESH","NAVIGATE_BACK"],"description":"Type of interaction"},"selector":{"type":"string","description":"CSS selector for the target element (required for CLICK, HOVER)"},"text":{"type":"string","description":"Text to type (required for TYPE)"},"timeMs":{"type":"number","description":"Time in milliseconds (required for WAIT)"},"url":{"type":"string","description":"URL to navigate to (required for GOTO)"},"tagName":{"type":"string","description":"HTML tag name of the element"},"innerText":{"type":"string","description":"Inner text content of the element"}},"required":["type"],"additionalProperties":true,"title":"BrowserInteraction","description":"Browser interaction definition. Examples:\n- CLICK: {type: 'CLICK', selector: '#submit-btn'}\n- TYPE: {type: 'TYPE', text: 'hello world'}\n- WAIT: {type: 'WAIT', timeMs: 2000}\n- GOTO: {type: 'GOTO', url: 'https://example.com'}\n- ENTER/TAB/BACKSPACE/DELETE/REFRESH/NAVIGATE_BACK/SCROLL/HOVER/SELECT/LOAD/KEYPRESS: {type: 'ENTER'} (no additional parameters needed)"},"WebExtensionInteraction":{"type":"object","properties":{"type":{"type":"string","description":"Type of interaction"},"id":{"type":"string","description":"Unique interaction ID"},"x":{"type":"number","description":"X coordinate"},"y":{"type":"number","description":"Y coordinate"},"link":{"type":"string","description":"Page URL"},"time":{"type":"string","description":"Timestamp"},"bodyHTMLUrl":{"type":"string","description":"URL to captured HTML body"},"screenshotUrl":{"type":"string","description":"URL to captured screenshot"},"target":{"type":"object","properties":{"id":{"type":"string"},"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"tagName":{"type":"string"},"html":{"type":"string"},"innerText":{"type":"string"}},"description":"Target element information"},"key":{"type":"string","description":"Key value"},"code":{"type":"string","description":"Key code"},"metaKeys":{"type":"object","properties":{"alt":{"type":"boolean"},"ctrl":{"type":"boolean"},"meta":{"type":"boolean"},"shift":{"type":"boolean"}},"description":"Modifier keys state"}},"required":["type"],"additionalProperties":true,"title":"WebExtensionInteraction","description":"Web extension interaction in complex format"},"Interaction":{"oneOf":[{"$ref":"#/components/schemas/BrowserInteraction"},{"$ref":"#/components/schemas/WebExtensionInteraction"}],"title":"Interaction","description":"Browser interaction definition. Accepts both simple format (with selector, text, url) and complex format from browser extensions"},"WorkflowFromTemplate":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"description":"Source URLs. Multiple URLs must belong to one website: subdomains and country domains of the same name (acme.com, careers.acme.co.uk) count as one website. Requests that span several websites are rejected with 422 SOURCES_MULTIPLE_SITES; create one workflow per website instead, optionally from a shared template."},"name":{"type":"string","minLength":1,"description":"Human-readable name for this workflow (e.g., 'Product Catalog Scraper')"},"description":{"type":"string","maxLength":500,"description":"Detailed description of what this workflow does and why it was created (maximum 500 characters)"},"tags":{"type":"array","items":{"type":"string","minLength":2},"description":"Tags for organizing and categorizing workflows (minimum 2 characters per tag)"},"interval":{"type":"string","enum":["ONLY_ONCE","EVERY_10_MINUTES","EVERY_20_MINUTES","HALF_HOURLY","HOURLY","TWO_HOURLY","THREE_HOURLY","FOUR_HOURLY","SIX_HOURLY","TWELVE_HOURLY","EIGHTEEN_HOURLY","DAILY","TWO_DAY","THREE_DAY","WEEKLY","BIWEEKLY","TRIWEEKLY","FOUR_WEEKS","MONTHLY","CUSTOM"],"description":"How frequently this workflow should run (ONLY_ONCE, HOURLY, DAILY, WEEKLY, etc.)"},"schedules":{"type":"array","items":{"type":"string"},"description":"Cron expressions for custom schedules. Overrides the interval setting for fine-grained control"},"timezone":{"type":"string","description":"IANA timezone for cron `schedules` (e.g. 'America/New_York'). Defaults to UTC. Cron schedules only."},"location":{"$ref":"#/components/schemas/Location"},"bypassPreview":{"default":false,"type":"boolean","description":"Skip preview and validation, deploy scraper immediately. Use with caution - set to true only when you're confident the configuration is correct"},"additionalData":{"nullable":true,"description":"Additional data for the workflow (e.g. IDs from your system to link data)"},"interactions":{"type":"array","items":{"$ref":"#/components/schemas/Interaction"},"description":"Browser interactions to perform before scraping (e.g., clicking buttons, filling forms, scrolling). See Interaction schema for available action types"},"limit":{"type":"integer","minimum":1,"maximum":2147483647,"nullable":true,"description":"Maximum number of items to scrape. Useful for limiting scope during development or cost control. Pass null to clear an existing limit (unlimited)."},"templateId":{"type":"string","format":"uuid","description":"ID of the template to instantiate."},"templateVersion":{"type":"integer","minimum":1,"description":"Optional version (integer) of the template to instantiate. Omit to use the latest published version (resolved once at request time). Provide it to pin a specific version."},"userPrompt":{"type":"string","minLength":10,"maxLength":5000,"description":"Workflow-specific instructions added to the selected template prompt. The template prompt remains template-owned and this text survives template updates."}},"required":["urls","templateId"],"additionalProperties":true,"title":"WorkflowFromTemplate","description":"Create a workflow by instantiating a published template. Only `urls` and `templateId` are required; prompt, schema, frequency, and notifications are inherited from the template version. `templateVersion` is optional — omit it to use the latest published version.\n\nExample: `{\"urls\": [\"https://example.com\"], \"templateId\": \"...\"}`"},"MonitoredField":{"type":"object","properties":{"fieldName":{"type":"string","minLength":1,"description":"Name of the field to monitor"},"operator":{"type":"string","enum":["changed","added","removed"],"description":"Change operator"},"isKeyField":{"type":"boolean","description":"Optional explicit schema-key metadata update for this field. Omit to leave workflow schema key flags unchanged."}},"required":["fieldName","operator"],"title":"MonitoredField","description":"Field monitoring configuration"},"MonitoringConfig":{"description":"Monitoring configuration","type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/MonitoredField"},"minItems":1,"description":"Fields to monitor (at least one required)"},"channels":{"type":"array","items":{"nullable":true},"description":"Notification channels"},"conditions":{"description":"Condition group with logical operator and conditions"}},"required":["fields"],"title":"MonitoringConfig"},"PromptWorkflow":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"description":"Source URLs. Multiple URLs must belong to one website: subdomains and country domains of the same name (acme.com, careers.acme.co.uk) count as one website. Requests that span several websites are rejected with 422 SOURCES_MULTIPLE_SITES; create one workflow per website instead, optionally from a shared template."},"name":{"type":"string","minLength":1,"description":"Human-readable name for this workflow (e.g., 'Product Catalog Scraper')"},"description":{"type":"string","maxLength":500,"description":"Detailed description of what this workflow does and why it was created (maximum 500 characters)"},"tags":{"type":"array","items":{"type":"string","minLength":2},"description":"Tags for organizing and categorizing workflows (minimum 2 characters per tag)"},"limit":{"type":"integer","minimum":1,"maximum":2147483647,"nullable":true,"description":"Maximum number of items to scrape. Useful for limiting scope during development or cost control. Pass null to clear an existing limit (unlimited)."},"location":{"$ref":"#/components/schemas/Location"},"monitoring":{"$ref":"#/components/schemas/MonitoringConfig"},"interval":{"type":"string","enum":["ONLY_ONCE","EVERY_10_MINUTES","EVERY_20_MINUTES","HALF_HOURLY","HOURLY","TWO_HOURLY","THREE_HOURLY","FOUR_HOURLY","SIX_HOURLY","TWELVE_HOURLY","EIGHTEEN_HOURLY","DAILY","TWO_DAY","THREE_DAY","WEEKLY","BIWEEKLY","TRIWEEKLY","FOUR_WEEKS","MONTHLY","CUSTOM"],"description":"How frequently this workflow should run (ONLY_ONCE, HOURLY, DAILY, WEEKLY, etc.)"},"schedules":{"type":"array","items":{"type":"string"},"description":"Cron expressions for custom schedules. Overrides the interval setting for fine-grained control"},"timezone":{"type":"string","description":"IANA timezone for cron `schedules` (e.g. 'America/New_York'). Defaults to UTC. Cron schedules only."},"bypassPreview":{"default":false,"type":"boolean","description":"Skip preview and validation, deploy scraper immediately. Use with caution - set to true only when you're confident the configuration is correct"},"interactions":{"type":"array","items":{"$ref":"#/components/schemas/Interaction"},"description":"Browser interactions to perform before scraping (e.g., clicking buttons, filling forms, scrolling). See Interaction schema for available action types"},"additionalData":{"nullable":true,"description":"Additional data for the workflow (e.g. IDs from your system to link data)"},"templateId":{"type":"string","format":"uuid","description":"Optional: ID of the template this workflow was created from. Records provenance only — the template's config is cloned at creation, not synced."},"templateVersion":{"readOnly":true,"description":"Reserved: only valid in the WorkflowFromTemplate variant. Pairs with templateId to instantiate a specific template version."},"userPrompt":{"type":"string","minLength":10,"maxLength":5000,"description":"Natural language instructions for the workflow (10-5000 characters). Describe what data to extract and how to navigate the site"},"schemaId":{"type":"string","description":"Optional: Schema ID to use with prompt-driven extraction"},"entity":{"type":"string","minLength":1,"description":"Optional: Entity name for prompt-driven extraction"},"fields":{"type":"array","items":{"description":"Extraction field schema","discriminator":{"propertyName":"fieldType"},"oneOf":[{"$ref":"#/components/schemas/DataField"},{"$ref":"#/components/schemas/ClassificationField"}]},"description":"Optional: Additional extraction fields to guide the workflow"}},"required":["urls","userPrompt"],"title":"PromptWorkflow","description":"Create a workflow using natural language instructions to extract data and navigate the site automatically.\n\nExample: `{\"urls\": [\"https://example.com\"], \"userPrompt\": \"Extract all job listings with title, company, salary, and location. Click on each listing to get full details.\"}`"},"WorkflowWithExistingSchema":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"description":"Source URLs. Multiple URLs must belong to one website: subdomains and country domains of the same name (acme.com, careers.acme.co.uk) count as one website. Requests that span several websites are rejected with 422 SOURCES_MULTIPLE_SITES; create one workflow per website instead, optionally from a shared template."},"name":{"type":"string","minLength":1,"description":"Human-readable name for this workflow (e.g., 'Product Catalog Scraper')"},"description":{"type":"string","maxLength":500,"description":"Detailed description of what this workflow does and why it was created (maximum 500 characters)"},"tags":{"type":"array","items":{"type":"string","minLength":2},"description":"Tags for organizing and categorizing workflows (minimum 2 characters per tag)"},"limit":{"type":"integer","minimum":1,"maximum":2147483647,"nullable":true,"description":"Maximum number of items to scrape. Useful for limiting scope during development or cost control. Pass null to clear an existing limit (unlimited)."},"location":{"$ref":"#/components/schemas/Location"},"monitoring":{"$ref":"#/components/schemas/MonitoringConfig"},"interval":{"type":"string","enum":["ONLY_ONCE","EVERY_10_MINUTES","EVERY_20_MINUTES","HALF_HOURLY","HOURLY","TWO_HOURLY","THREE_HOURLY","FOUR_HOURLY","SIX_HOURLY","TWELVE_HOURLY","EIGHTEEN_HOURLY","DAILY","TWO_DAY","THREE_DAY","WEEKLY","BIWEEKLY","TRIWEEKLY","FOUR_WEEKS","MONTHLY","CUSTOM"],"description":"How frequently this workflow should run (ONLY_ONCE, HOURLY, DAILY, WEEKLY, etc.)"},"schedules":{"type":"array","items":{"type":"string"},"description":"Cron expressions for custom schedules. Overrides the interval setting for fine-grained control"},"timezone":{"type":"string","description":"IANA timezone for cron `schedules` (e.g. 'America/New_York'). Defaults to UTC. Cron schedules only."},"bypassPreview":{"default":false,"type":"boolean","description":"Skip preview and validation, deploy scraper immediately. Use with caution - set to true only when you're confident the configuration is correct"},"interactions":{"type":"array","items":{"$ref":"#/components/schemas/Interaction"},"description":"Browser interactions to perform before scraping (e.g., clicking buttons, filling forms, scrolling). See Interaction schema for available action types"},"additionalData":{"nullable":true,"description":"Additional data for the workflow (e.g. IDs from your system to link data)"},"templateId":{"type":"string","format":"uuid","description":"Optional: ID of the template this workflow was created from. Records provenance only — the template's config is cloned at creation, not synced."},"templateVersion":{"readOnly":true,"description":"Reserved: only valid in the WorkflowFromTemplate variant. Pairs with templateId to instantiate a specific template version."},"schemaId":{"type":"string","description":"ID of an existing schema configuration. Use this to reference a previously defined schema without re-defining extraction fields"}},"required":["urls","schemaId"],"title":"WorkflowWithExistingSchema","description":"Create a workflow using a pre-defined schema configuration. Reference an existing schema by ID to extract data without re-defining fields. Perfect when you have multiple workflows using the same data structure.\n\nExample: `{\"urls\": [\"https://example.com\"], \"schemaId\": \"schema-abc123\", \"interval\": \"DAILY\"}`"},"WorkflowWithEntityAndFields":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"description":"Source URLs. Multiple URLs must belong to one website: subdomains and country domains of the same name (acme.com, careers.acme.co.uk) count as one website. Requests that span several websites are rejected with 422 SOURCES_MULTIPLE_SITES; create one workflow per website instead, optionally from a shared template."},"name":{"type":"string","minLength":1,"description":"Human-readable name for this workflow (e.g., 'Product Catalog Scraper')"},"description":{"type":"string","maxLength":500,"description":"Detailed description of what this workflow does and why it was created (maximum 500 characters)"},"tags":{"type":"array","items":{"type":"string","minLength":2},"description":"Tags for organizing and categorizing workflows (minimum 2 characters per tag)"},"limit":{"type":"integer","minimum":1,"maximum":2147483647,"nullable":true,"description":"Maximum number of items to scrape. Useful for limiting scope during development or cost control. Pass null to clear an existing limit (unlimited)."},"location":{"$ref":"#/components/schemas/Location"},"monitoring":{"$ref":"#/components/schemas/MonitoringConfig"},"interval":{"type":"string","enum":["ONLY_ONCE","EVERY_10_MINUTES","EVERY_20_MINUTES","HALF_HOURLY","HOURLY","TWO_HOURLY","THREE_HOURLY","FOUR_HOURLY","SIX_HOURLY","TWELVE_HOURLY","EIGHTEEN_HOURLY","DAILY","TWO_DAY","THREE_DAY","WEEKLY","BIWEEKLY","TRIWEEKLY","FOUR_WEEKS","MONTHLY","CUSTOM"],"description":"How frequently this workflow should run (ONLY_ONCE, HOURLY, DAILY, WEEKLY, etc.)"},"schedules":{"type":"array","items":{"type":"string"},"description":"Cron expressions for custom schedules. Overrides the interval setting for fine-grained control"},"timezone":{"type":"string","description":"IANA timezone for cron `schedules` (e.g. 'America/New_York'). Defaults to UTC. Cron schedules only."},"bypassPreview":{"default":false,"type":"boolean","description":"Skip preview and validation, deploy scraper immediately. Use with caution - set to true only when you're confident the configuration is correct"},"interactions":{"type":"array","items":{"$ref":"#/components/schemas/Interaction"},"description":"Browser interactions to perform before scraping (e.g., clicking buttons, filling forms, scrolling). See Interaction schema for available action types"},"additionalData":{"nullable":true,"description":"Additional data for the workflow (e.g. IDs from your system to link data)"},"templateId":{"type":"string","format":"uuid","description":"Optional: ID of the template this workflow was created from. Records provenance only — the template's config is cloned at creation, not synced."},"templateVersion":{"readOnly":true,"description":"Reserved: only valid in the WorkflowFromTemplate variant. Pairs with templateId to instantiate a specific template version."},"entity":{"type":"string","minLength":1,"description":"Entity name for extraction (e.g., 'Product', 'JobListing')"},"fields":{"type":"array","items":{"description":"Extraction field schema","discriminator":{"propertyName":"fieldType"},"oneOf":[{"$ref":"#/components/schemas/DataField"},{"$ref":"#/components/schemas/ClassificationField"}]},"minItems":1,"description":"Array of fields to extract from each item. Each field defines a property to capture (e.g., title, price, description)"}},"required":["urls","entity","fields"],"title":"WorkflowWithEntityAndFields","description":"Create a workflow by defining extraction entity and fields directly in the request. Inline your schema definition to quickly set up custom data extraction without creating a schema separately.\n\nExample: `{\"urls\": [\"https://example.com\"], \"entity\": \"Product\", \"fields\": [{\"name\": \"title\", \"description\": \"Product title\", \"fieldType\": \"SCHEMA\", \"dataType\": \"STRING\"}, {\"name\": \"price\", \"description\": \"Product price\", \"fieldType\": \"SCHEMA\", \"dataType\": \"NUMBER\"}]}`"},"CreateWorkflowBody":{"title":"CreateWorkflowBody","description":"Request body for creating a new workflow","anyOf":[{"$ref":"#/components/schemas/WorkflowFromTemplate"},{"$ref":"#/components/schemas/PromptWorkflow"},{"$ref":"#/components/schemas/WorkflowWithExistingSchema"},{"$ref":"#/components/schemas/WorkflowWithEntityAndFields"}]},"CreateWorkflowResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false],"description":"Error flag (always false on success)"},"success":{"type":"boolean","description":"Success flag"},"workflowId":{"type":"string","description":"ID of the created workflow"},"message":{"type":"string","description":"Success message"}},"required":["error","success","workflowId","message"],"title":"CreateWorkflowResponse","description":"Response for workflow creation"},"TemplateControlledFieldError":{"type":"object","properties":{"error":{"type":"boolean","enum":[true],"description":"Error flag"},"code":{"type":"string","enum":["TEMPLATE_CONTROLLED_FIELD"],"description":"Stable error code"},"message":{"type":"string","description":"Human-readable error message"},"templateId":{"type":"string","format":"uuid","description":"Template that controls the offending fields"},"fields":{"type":"array","items":{"type":"string"},"description":"Controlled field names the caller tried to override"}},"required":["error","code","message","templateId","fields"],"title":"TemplateControlledFieldError"},"SourcesMultipleSitesError":{"type":"object","properties":{"error":{"type":"boolean","enum":[true],"description":"Error flag"},"code":{"type":"string","enum":["SOURCES_MULTIPLE_SITES"],"description":"Stable error code"},"message":{"type":"string","description":"What to do instead: one workflow per website, optionally from a template"},"details":{"type":"object","properties":{"sites":{"type":"array","items":{"type":"object","properties":{"site":{"type":"string","description":"Website the URLs belong to, e.g. acme.com"},"urls":{"type":"array","items":{"type":"string"},"description":"Requested URLs on this website"}},"required":["site","urls"]},"description":"Requested URLs grouped by website"},"newSites":{"type":"array","items":{"type":"string"},"description":"Websites the request adds to the workflow (all of them on create)"},"currentSites":{"type":"array","items":{"type":"string"},"description":"Websites the workflow already covers (empty on create)"}},"required":["sites","newSites","currentSites"]}},"required":["error","code","message","details"],"title":"SourcesMultipleSitesError","description":"The source URLs span several websites. A workflow covers one website."},"JobError":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the type of error"},"message":{"type":"string","description":"Human-readable error message"},"occurredAt":{"type":"string","format":"date-time","description":"Timestamp when the error occurred"},"screenshot":{"type":"string","description":"URL to error screenshot if available"},"context":{"type":"object","additionalProperties":{"nullable":true},"description":"Additional error context"}},"required":["errorCode","message","occurredAt"],"title":"JobError","description":"Error information for a job"},"JobStatusSnapshotBlock":{"type":"object","properties":{"configHash":{"type":"string","description":"sha256 of the canonical config the run was executed against"},"snapshotCreatedAt":{"type":"string","format":"date-time","description":"When the snapshot draft was inserted (run entry)"},"snapshotConfirmedAt":{"type":"string","format":"date-time","description":"When the snapshot was confirmed (terminal success); null while draft","nullable":true},"isConfigStaleVsCurrent":{"type":"boolean","description":"True when the snapshot hash differs from the workflow's current canonical hash"},"driftKeys":{"type":"array","items":{"type":"string"},"description":"Top-level config keys that differ from the current config"},"runBuildId":{"type":"string","description":"Shelly build that produced this run; null for legacy rows and non-SHELLY_SCRIPT workflows","nullable":true},"currentBuildId":{"type":"string","description":"The workflow's live Shelly build, or null when none has gone live","nullable":true},"isBuildStaleVsCurrent":{"type":"boolean","description":"True when runBuildId is set and differs from currentBuildId — the script that produced this run's data is no longer the one the workflow runs"},"workspaceClean":{"type":"boolean","description":"True when the live Shelly workspace matches the latest completed build input; null when unknown","nullable":true},"freshnessReason":{"type":"string","enum":["config_drift","build_drift","workspace_dirty","no_build_yet"],"description":"Priority freshness reason for the snapshot block; null when config, build, and workspace are fresh","nullable":true}},"required":["configHash","snapshotCreatedAt","snapshotConfirmedAt","isConfigStaleVsCurrent","driftKeys","runBuildId","currentBuildId","isBuildStaleVsCurrent","workspaceClean","freshnessReason"],"title":"JobStatusSnapshotBlock","description":"ADR-009 snapshot drift block; null for runs predating the snapshot migration"},"JobStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"The job ID"},"state":{"type":"string","enum":["IN_PROGRESS","FINISHED","FAILED","NOT_SUPPORTED","FAILED_INSUFFICIENT_FUNDS"],"description":"Current state of the job"},"startedAt":{"type":"string","format":"date-time","description":"Start date and time of the job"},"finishedAt":{"type":"string","format":"date-time","description":"Finish date and time of the job (if completed)"},"estimatedFinishedAtUtc":{"type":"string","format":"date-time","nullable":true,"description":"Estimated UTC finish time for an active workflow run"},"limit":{"type":"integer","nullable":true,"description":"Record limit for the job"},"workflowId":{"type":"string","description":"ID of the workflow/scraper"},"variables":{"type":"object","additionalProperties":{"nullable":true},"description":"Job variables"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/JobError"},"description":"List of errors if the job failed"},"snapshot":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/JobStatusSnapshotBlock"}]}},"required":["id","state"],"title":"JobStatusResponse","description":"Job status and telemetry response"},"JobStatusErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}},"required":["error"],"title":"JobStatusErrorResponse","description":"Error response for job status endpoint"},"ActivityEventSource":{"type":"object","properties":{"requestSource":{"type":"string","description":"Request source that triggered the event (SYSTEM, UI, SDK, API)"},"userId":{"type":"string","description":"User ID who triggered the event"},"userEmail":{"type":"string","description":"User email who triggered the event"}},"title":"ActivityEventSource","description":"Source information for an activity event"},"ActivityEventResource":{"type":"object","properties":{"type":{"type":"string","description":"Resource type (RUN, WORKFLOW, NOTIFICATION, etc.)"},"workflowId":{"type":"string","description":"Associated workflow ID"},"resourceId":{"type":"string","description":"Resource identifier"},"name":{"type":"string","description":"Resource name"}},"required":["type"],"title":"ActivityEventResource","description":"Resource information for an activity event"},"ActivityEventDetails":{"type":"object","additionalProperties":{"nullable":true},"title":"ActivityEventDetails","description":"Additional details about the activity event (varies by event type)"},"ActivityEvent":{"type":"object","properties":{"title":{"type":"string","description":"Event title/type"},"dateTime":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of the event"},"source":{"$ref":"#/components/schemas/ActivityEventSource"},"resource":{"$ref":"#/components/schemas/ActivityEventResource"},"details":{"$ref":"#/components/schemas/ActivityEventDetails"}},"required":["title","dateTime"],"title":"ActivityEvent","description":"A single activity event"},"ActivityPaginationMeta":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"description":"Total number of events"},"limit":{"type":"integer","minimum":1,"description":"Number of events per page"},"offset":{"type":"integer","minimum":0,"description":"Offset for pagination"},"hasMore":{"type":"boolean","description":"Whether there are more events available"}},"required":["total","limit","offset","hasMore"],"title":"ActivityPaginationMeta","description":"Pagination metadata for activity events"},"ActivityListResponse":{"type":"object","properties":{"error":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/ActivityEvent"}},"pagination":{"$ref":"#/components/schemas/ActivityPaginationMeta"}},"required":["events","pagination"]}},"required":["error","data"],"title":"ActivityListResponse","description":"Successful response containing activity events and pagination"},"CreateVariableBody":{"oneOf":[{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Variable key (must be unique within scope)"},"value":{"type":"string","description":"Variable value"},"dataType":{"type":"string","enum":["STRING","OBJECT","ARRAY","NUMBER"]}},"required":["key","value"]},{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Secret key (must be unique within team scope)"},"value":{"type":"string","minLength":1,"description":"Write-only secret value"},"dataType":{"type":"string","enum":["SECRET"]},"managementMode":{"type":"string","enum":["KADOA_MANAGED"]}},"required":["key","value","dataType"]},{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Secret key (must be unique within team scope)"},"dataType":{"type":"string","enum":["SECRET"]},"managementMode":{"type":"string","enum":["CUSTOMER_MANAGED"]},"providerConnectionId":{"type":"string","format":"uuid"},"resourceReference":{"type":"string","minLength":1}},"required":["key","dataType","managementMode","providerConnectionId","resourceReference"]}],"title":"CreateVariableBody","description":"Request body for creating a variable or write-only secret"},"Variable":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Unique variable identifier"},"key":{"type":"string","description":"Variable key (unique per team/user scope)"},"value":{"type":"string","description":"Variable value"},"dataType":{"type":"string","enum":["STRING","OBJECT","ARRAY","NUMBER"]},"createdAt":{"type":"string","description":"ISO 8601 creation timestamp"},"updatedAt":{"type":"string","description":"ISO 8601 last update timestamp"}},"required":["id","key","value","createdAt"]},{"type":"object","properties":{"id":{"type":"string","description":"Unique variable identifier"},"key":{"type":"string","description":"Variable key (unique per team scope)"},"dataType":{"type":"string","enum":["SECRET"]},"provider":{"type":"string","enum":["GOOGLE_SECRET_MANAGER"]},"managementMode":{"type":"string","enum":["KADOA_MANAGED","CUSTOMER_MANAGED"]},"status":{"type":"string","enum":["ACTIVE","NEEDS_ATTENTION","DELETING"]},"currentVersion":{"type":"string"},"lastResolvedVersion":{"type":"string"},"createdAt":{"type":"string","description":"ISO 8601 creation timestamp"},"updatedAt":{"type":"string","description":"ISO 8601 last update timestamp"},"lastRotatedAt":{"type":"string"},"lastResolvedAt":{"type":"string"}},"required":["id","key","dataType","provider","managementMode","status","createdAt"]}],"title":"Variable","description":"A variable. Secret responses contain metadata only and never expose the value."},"VariableResponse":{"type":"object","properties":{"variable":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Variable"}]},"error":{"type":"string","nullable":true}},"required":["variable","error"],"title":"VariableResponse","description":"Response containing a single variable"},"VariablesListResponse":{"type":"object","properties":{"variables":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}},"error":{"type":"string","nullable":true}},"required":["variables","error"],"title":"VariablesListResponse","description":"Response containing a list of variables"},"VariableDataType":{"default":"STRING","type":"string","enum":["STRING","SECRET","OBJECT","ARRAY","NUMBER"],"title":"VariableDataType","description":"The data type of the variable value"},"UpdateVariableBody":{"type":"object","properties":{"key":{"type":"string","minLength":1,"description":"Variable key (must be unique within scope)"},"value":{"type":"string","description":"New variable value or write-only secret value"},"dataType":{"$ref":"#/components/schemas/VariableDataType"}},"title":"UpdateVariableBody","description":"Request body for updating a variable. Variable type cannot be changed."}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for authentication"}}}}