{"components":{"responses":{"BadRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request is invalid.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"Conflict":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request conflicts with current state or reuses an idempotency key with a different payload.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"Forbidden":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The key does not grant the required scope.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"NotFound":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The organization-scoped resource was not found.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"RateLimited":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The caller exceeded an API rate limit.","headers":{"Retry-After":{"description":"Minimum delay in seconds before retrying.","schema":{"minimum":1,"type":"integer"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"Unauthorized":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API key is missing, malformed, expired, revoked, or for another environment.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}}},"schemas":{"Agent":{"additionalProperties":false,"examples":[{"availability":"available","deprecated_at":"2026-01-15T12:00:00Z","description":"Example organization-scoped resource.","error_schema":{},"id":"id_example","input_schema":{},"metric_dashboards":["example"],"name":"Example workflow","output_schema":{},"permissions":{"can_execute":false,"can_install":false},"required_connections":["example"],"setup_schema":{},"supported_metrics":["example"],"supported_triggers":["example"],"version":"1.0.0"}],"properties":{"availability":{"enum":["available","configuration_required"],"title":"Availability","type":"string"},"category":{"title":"Category","type":"string"},"deprecated_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Deprecated At"},"description":{"title":"Description","type":"string"},"error_schema":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Error Schema","type":"object"},"id":{"minLength":1,"title":"Id","type":"string"},"input_schema":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Input Schema","type":"object"},"metric_dashboards":{"items":{"type":"string"},"title":"Metric Dashboards","type":"array"},"name":{"title":"Name","type":"string"},"output_schema":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Output Schema","type":"object"},"permissions":{"$ref":"#/components/schemas/AgentPermissions"},"required_connections":{"items":{"type":"string"},"title":"Required Connections","type":"array"},"setup_schema":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Setup Schema","type":"object"},"source_schemas":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Source Schemas","type":"object"},"supported_destinations":{"items":{"type":"string"},"title":"Supported Destinations","type":"array"},"supported_metrics":{"items":{"type":"string"},"title":"Supported Metrics","type":"array"},"supported_sources":{"items":{"type":"string"},"title":"Supported Sources","type":"array"},"supported_triggers":{"items":{"type":"string"},"title":"Supported Triggers","type":"array"},"tags":{"items":{"type":"string"},"title":"Tags","type":"array"},"version":{"title":"Version","type":"string"}},"required":["id","name","description","version","availability","required_connections","supported_triggers","setup_schema","input_schema","output_schema","error_schema","permissions","supported_metrics","metric_dashboards","deprecated_at"],"title":"Agent","type":"object"},"AgentExecution":{"additionalProperties":false,"examples":[{"accepted_at":"2026-01-15T12:00:00Z","agent_id":"agent_example","agent_version":"1.0.0","data_expires_at":"2026-01-15T12:00:00Z","error":{"code":"INVALID_REQUEST","message":"Request accepted."},"id":"id_example","installation_id":"installation_example","result":{},"status":"queued","status_url":"https://portal.example.com/resource"}],"properties":{"accepted_at":{"format":"date-time","title":"Accepted At","type":"string"},"agent_id":{"minLength":1,"title":"Agent Id","type":"string"},"agent_version":{"title":"Agent Version","type":"string"},"completed_at":{"format":"date-time","title":"Completed At","type":"string"},"data_expires_at":{"format":"date-time","title":"Data Expires At","type":"string"},"data_purged_at":{"format":"date-time","title":"Data Purged At","type":"string"},"duration_seconds":{"minimum":0.0,"title":"Duration Seconds","type":"number"},"error":{"anyOf":[{"$ref":"#/components/schemas/PublicResourceError"},{"type":"null"}]},"error_code":{"title":"Error Code","type":"string"},"human_review_count":{"minimum":0,"title":"Human Review Count","type":"integer"},"id":{"minLength":1,"title":"Id","type":"string"},"installation_id":{"minLength":1,"title":"Installation Id","type":"string"},"items_processed":{"minimum":0,"title":"Items Processed","type":"integer"},"partner_reference":{"title":"Partner Reference","type":"string"},"result":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Result"},"started_at":{"format":"date-time","title":"Started At","type":"string"},"status":{"enum":["queued","running","succeeded","failed","cancelled"],"title":"Status","type":"string"},"status_url":{"title":"Status Url","type":"string"}},"required":["id","agent_id","agent_version","installation_id","status","accepted_at","status_url","data_expires_at","result","error"],"title":"AgentExecution","type":"object"},"AgentExecutionCreate":{"additionalProperties":false,"examples":[{"input":{"document_id":"document_example"},"metadata":{"partner_reference":"request_example"}}],"properties":{"input":{"$ref":"#/components/schemas/DynamicRuntimeInput","title":"Input"},"metadata":{"$ref":"#/components/schemas/AgentExecutionCreateMetadata","title":"Metadata"}},"title":"AgentExecutionCreate","type":"object"},"AgentExecutionCreateMetadata":{"additionalProperties":false,"examples":[{"partner_reference":"request_example"}],"properties":{"partner_reference":{"maxLength":200,"title":"Partner Reference","type":"string"}},"title":"AgentExecutionCreateMetadata","type":"object"},"AgentExecutionList":{"additionalProperties":false,"examples":[{"data":[{"accepted_at":"2026-01-15T12:00:00Z","agent_id":"agent_example","agent_version":"1.0.0","id":"id_example","installation_id":"installation_example","status":"queued","status_url":"https://portal.example.com/resource"}],"pagination":{"has_more":false,"limit":1,"offset":1,"total":1}}],"properties":{"data":{"items":{"$ref":"#/components/schemas/AgentExecutionSummary"},"title":"Data","type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"],"title":"AgentExecutionList","type":"object"},"AgentExecutionSummary":{"additionalProperties":false,"examples":[{"accepted_at":"2026-01-15T12:00:00Z","agent_id":"agent_example","agent_version":"1.0.0","id":"id_example","installation_id":"installation_example","status":"queued","status_url":"https://portal.example.com/resource"}],"properties":{"accepted_at":{"format":"date-time","title":"Accepted At","type":"string"},"agent_id":{"minLength":1,"title":"Agent Id","type":"string"},"agent_version":{"title":"Agent Version","type":"string"},"completed_at":{"format":"date-time","title":"Completed At","type":"string"},"duration_seconds":{"minimum":0.0,"title":"Duration Seconds","type":"number"},"error_code":{"title":"Error Code","type":"string"},"human_review_count":{"minimum":0,"title":"Human Review Count","type":"integer"},"id":{"minLength":1,"title":"Id","type":"string"},"installation_id":{"minLength":1,"title":"Installation Id","type":"string"},"items_processed":{"minimum":0,"title":"Items Processed","type":"integer"},"partner_reference":{"title":"Partner Reference","type":"string"},"started_at":{"format":"date-time","title":"Started At","type":"string"},"status":{"enum":["queued","running","succeeded","failed","cancelled"],"title":"Status","type":"string"},"status_url":{"title":"Status Url","type":"string"}},"required":["id","agent_id","agent_version","installation_id","status","accepted_at","status_url"],"title":"AgentExecutionSummary","type":"object"},"AgentList":{"additionalProperties":false,"examples":[{"data":[{"availability":"available","description":"Example organization-scoped resource.","id":"id_example","name":"Example workflow","required_connections":["example"],"supported_triggers":["example"],"version":"1.0.0"}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/AgentSummary"},"title":"Data","type":"array"}},"required":["data"],"title":"AgentList","type":"object"},"AgentPermissions":{"additionalProperties":false,"examples":[{"can_execute":false,"can_install":false}],"properties":{"can_execute":{"title":"Can Execute","type":"boolean"},"can_install":{"title":"Can Install","type":"boolean"}},"required":["can_install","can_execute"],"title":"AgentPermissions","type":"object"},"AgentRequest":{"additionalProperties":false,"examples":[{"created_at":"2026-01-15T12:00:00Z","expected_output":{},"id":"id_example","messages":[{"author":"partner","created_at":"2026-01-15T12:00:00Z","id":"id_example","message":"Request accepted."}],"name":"Example workflow","sample_inputs":["example"],"specification":"example","state":"submitted","systems":["example"],"updated_at":"2026-01-15T12:00:00Z"}],"properties":{"agent":{"$ref":"#/components/schemas/AgentRequestAgent","description":"Present only when the request is available and the resulting version is published and entitled to the organization.","title":"Agent"},"completion_criteria":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completion Criteria"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"decision":{"title":"Decision","type":"string"},"expected_output":{"additionalProperties":true,"title":"Expected Output","type":"object"},"form_url":{"description":"Hosted form the partner completes and submits. Present for API-created request drafts.","format":"uri","minLength":1,"title":"Form Url","type":"string"},"id":{"title":"Id","type":"string"},"messages":{"items":{"$ref":"#/components/schemas/AgentRequestMessage"},"title":"Messages","type":"array"},"name":{"title":"Name","type":"string"},"sample_inputs":{"items":{},"title":"Sample Inputs","type":"array"},"specification":{"title":"Specification","type":"string"},"state":{"enum":["submitted","draft","in_progress","needs_information","ready_for_review","available","rejected","failed"],"title":"State","type":"string"},"systems":{"items":{"type":"string"},"title":"Systems","type":"array"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trigger"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","state","name","specification","systems","expected_output","sample_inputs","messages","created_at","updated_at"],"title":"AgentRequest","type":"object"},"AgentRequestAgent":{"additionalProperties":false,"examples":[{"id":"id_example","version":"1.0.0"}],"properties":{"id":{"title":"Id","type":"string"},"version":{"title":"Version","type":"string"}},"required":["id","version"],"title":"AgentRequestAgent","type":"object"},"AgentRequestCreate":{"additionalProperties":false,"examples":[{"name":"Example workflow"}],"properties":{"completion_criteria":{"maxLength":5000,"title":"Completion Criteria","type":"string"},"expected_output":{"additionalProperties":true,"maxProperties":100,"title":"Expected Output","type":"object"},"name":{"description":"Short name for the requested capability.","maxLength":200,"minLength":1,"pattern":"\\S","title":"Name","type":"string"},"sample_inputs":{"items":{},"maxItems":10,"title":"Sample Inputs","type":"array"},"specification":{"description":"Optional prefill for the hosted specification form. Do not include credentials or sensitive production data.","maxLength":20000,"minLength":1,"pattern":"\\S","title":"Specification","type":"string"},"systems":{"items":{"maxLength":100,"minLength":1,"pattern":"\\S","type":"string"},"maxItems":50,"title":"Systems","type":"array","uniqueItems":true},"trigger":{"maxLength":2000,"title":"Trigger","type":"string"}},"required":["name"],"title":"AgentRequestCreate","type":"object"},"AgentRequestMessage":{"additionalProperties":false,"examples":[{"author":"partner","created_at":"2026-01-15T12:00:00Z","id":"id_example","message":"Request accepted."}],"properties":{"author":{"enum":["partner","xy"],"title":"Author","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"id":{"title":"Id","type":"string"},"message":{"title":"Message","type":"string"}},"required":["id","author","message","created_at"],"title":"AgentRequestMessage","type":"object"},"AgentRequestMessageCreate":{"additionalProperties":false,"examples":[{"message":"Request accepted."}],"properties":{"message":{"maxLength":10000,"minLength":1,"pattern":"\\S","title":"Message","type":"string"}},"required":["message"],"title":"AgentRequestMessageCreate","type":"object"},"AgentReviewRevision":{"additionalProperties":false,"examples":[{"execution_id":"execution_example","revision_token":"example"}],"properties":{"execution_id":{"description":"The execution that produced this item. Required so a revision is resolved within one run instead of the organization's whole decided history.","title":"Execution Id","type":"string"},"revision_token":{"description":"The revision_token returned when the state being reversed was written. If the item has moved on since - including moving away and back - the result is conflict and nothing is written.","title":"Revision Token","type":"string"},"workflow_instance_id":{"description":"The Planner workflow run that produced this item. Use this instead of execution_id for planner_workflow items.","title":"Workflow Instance Id","type":"string"}},"required":["execution_id","revision_token"],"title":"AgentReviewRevision","type":"object"},"AgentSummary":{"additionalProperties":false,"examples":[{"availability":"available","description":"Example organization-scoped resource.","id":"id_example","name":"Example workflow","required_connections":["example"],"supported_triggers":["example"],"version":"1.0.0"}],"properties":{"availability":{"enum":["available","configuration_required"],"title":"Availability","type":"string"},"category":{"title":"Category","type":"string"},"description":{"title":"Description","type":"string"},"id":{"minLength":1,"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"required_connections":{"items":{"type":"string"},"title":"Required Connections","type":"array"},"supported_destinations":{"items":{"type":"string"},"title":"Supported Destinations","type":"array"},"supported_sources":{"items":{"type":"string"},"title":"Supported Sources","type":"array"},"supported_triggers":{"items":{"type":"string"},"title":"Supported Triggers","type":"array"},"tags":{"items":{"type":"string"},"title":"Tags","type":"array"},"version":{"title":"Version","type":"string"}},"required":["id","name","description","version","availability","required_connections","supported_triggers"],"title":"AgentSummary","type":"object"},"AuthCheck":{"additionalProperties":false,"examples":[{"credential_id":"credential_example","environment":"example","scopes":["example"]}],"properties":{"actor_user_id":{"title":"Actor User Id","type":"string"},"credential_id":{"minLength":1,"title":"Credential Id","type":"string"},"credential_type":{"default":"service","enum":["service","user"],"title":"Credential Type","type":"string"},"environment":{"title":"Environment","type":"string"},"oauth_issuer":{"title":"Oauth Issuer","type":"string"},"oauth_resource":{"title":"Oauth Resource","type":"string"},"scopes":{"items":{"type":"string"},"title":"Scopes","type":"array"}},"required":["credential_id","environment","scopes"],"title":"AuthCheck","type":"object"},"AuthorizationAction":{"additionalProperties":false,"examples":[{"connection":"example","id":"id_example","installation_id":"installation_example","renewable_at":"2026-01-15T12:00:00Z","status":"example","type":"example"}],"properties":{"authorization_url":{"format":"uri","minLength":1,"title":"Authorization Url","type":"string"},"connection":{"title":"Connection","type":"string"},"error":{"$ref":"#/components/schemas/PublicResourceError","title":"Error"},"expires_at":{"format":"date-time","title":"Expires At","type":"string"},"id":{"minLength":1,"title":"Id","type":"string"},"installation_id":{"minLength":1,"title":"Installation Id","type":"string"},"renewable_at":{"format":"date-time","title":"Renewable At","type":"string"},"status":{"title":"Status","type":"string"},"type":{"title":"Type","type":"string"}},"required":["id","installation_id","type","connection","status","renewable_at"],"title":"AuthorizationAction","type":"object"},"AuthorizationActionCreate":{"additionalProperties":false,"examples":[{"connection":"gmail"}],"properties":{"connection":{"minLength":1,"title":"Connection","type":"string"}},"title":"AuthorizationActionCreate","type":"object"},"AuthorizationActionList":{"additionalProperties":false,"examples":[{"authorization_actions":[{"connection":"example","id":"id_example","installation_id":"installation_example","renewable_at":"2026-01-15T12:00:00Z","status":"example","type":"example"}]}],"properties":{"authorization_actions":{"items":{"$ref":"#/components/schemas/AuthorizationAction"},"title":"Authorization Actions","type":"array"}},"required":["authorization_actions"],"title":"AuthorizationActionList","type":"object"},"BrowserCdpCreate":{"additionalProperties":false,"examples":[{"method":"example"}],"properties":{"method":{"minLength":1,"title":"Method","type":"string"},"params":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Params","type":"object"},"tab_id":{"minimum":1,"title":"Tab Id","type":"integer"}},"required":["method"],"title":"BrowserCdpCreate","type":"object"},"BrowserCdpResult":{"additionalProperties":false,"examples":[{"session_id":"session_example","success":false,"warning":"example"}],"properties":{"result":{"title":"Result"},"session_id":{"minLength":1,"title":"Session Id","type":"string"},"success":{"title":"Success","type":"boolean"},"warning":{"title":"Warning","type":"string"}},"required":["success","session_id","warning"],"title":"BrowserCdpResult","type":"object"},"BrowserCommandCreate":{"additionalProperties":false,"examples":[{"tool":"example"}],"properties":{"input":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Input","type":"object"},"tab_id":{"minimum":1,"title":"Tab Id","type":"integer"},"tool":{"minLength":1,"title":"Tool","type":"string"},"url":{"format":"uri","minLength":1,"title":"Url","type":"string"}},"required":["tool"],"title":"BrowserCommandCreate","type":"object"},"BrowserCommandResult":{"additionalProperties":false,"examples":[{"session_id":"session_example","success":false}],"properties":{"result":{"title":"Result"},"session_id":{"minLength":1,"title":"Session Id","type":"string"},"success":{"title":"Success","type":"boolean"}},"required":["success","session_id"],"title":"BrowserCommandResult","type":"object"},"BrowserControlCreate":{"additionalProperties":false,"examples":[{"mode":"human"}],"properties":{"mode":{"enum":["human","shared"],"title":"Mode","type":"string"}},"required":["mode"],"title":"BrowserControlCreate","type":"object"},"BrowserControlResult":{"additionalProperties":false,"examples":[{"control_mode":"human","session_id":"session_example"}],"properties":{"agent_actions_allowed":{"title":"Agent Actions Allowed","type":"boolean"},"control_mode":{"enum":["human","shared"],"title":"Control Mode","type":"string"},"session_id":{"minLength":1,"title":"Session Id","type":"string"},"success":{"title":"Success","type":"boolean"}},"required":["session_id","control_mode"],"title":"BrowserControlResult","type":"object"},"BrowserDraft":{"additionalProperties":false,"examples":[{"activity_code":"example","build_id":"build_example","has_activity_code":false,"session_id":"session_example","step_number":1}],"properties":{"activity_code":{"title":"Activity Code","type":"string"},"build_id":{"minLength":1,"title":"Build Id","type":"string"},"has_activity_code":{"title":"Has Activity Code","type":"boolean"},"session_id":{"minLength":1,"title":"Session Id","type":"string"},"step_number":{"minimum":1,"title":"Step Number","type":"integer"}},"required":["session_id","build_id","step_number","activity_code","has_activity_code"],"title":"BrowserDraft","type":"object"},"BrowserDraftApply":{"additionalProperties":false,"examples":[{"edited_code":"navigate(url='https://portal.example.com/records')"}],"properties":{"edited_code":{"minLength":1,"title":"Edited Code","type":"string"}},"title":"BrowserDraftApply","type":"object"},"BrowserPromptCancelResult":{"additionalProperties":false,"examples":[{"cancelled":false,"session_id":"session_example","success":false}],"properties":{"cancelled":{"title":"Cancelled","type":"boolean"},"session_id":{"minLength":1,"title":"Session Id","type":"string"},"success":{"title":"Success","type":"boolean"}},"required":["success","session_id","cancelled"],"title":"BrowserPromptCancelResult","type":"object"},"BrowserPromptCreate":{"additionalProperties":false,"examples":[{"prompt":"example"}],"properties":{"prompt":{"minLength":1,"title":"Prompt","type":"string"}},"required":["prompt"],"title":"BrowserPromptCreate","type":"object"},"BrowserSession":{"additionalProperties":false,"examples":[{"build_id":"build_example","capabilities":{},"control_mode":"human","session_id":"session_example","status":"example","step_number":1,"tabs":[{}]}],"properties":{"active_tab_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"title":"Active Tab Id"},"build_id":{"minLength":1,"title":"Build Id","type":"string"},"capabilities":{"$ref":"#/components/schemas/BrowserSessionCapabilities"},"cdp_ready":{"title":"Cdp Ready","type":"boolean"},"control_mode":{"enum":["human","shared"],"title":"Control Mode","type":"string"},"controller_ready":{"title":"Controller Ready","type":"boolean"},"created_at":{"title":"Created At","type":"number"},"last_active_at":{"title":"Last Active At","type":"number"},"session_id":{"minLength":1,"title":"Session Id","type":"string"},"status":{"title":"Status","type":"string"},"step_number":{"minimum":1,"title":"Step Number","type":"integer"},"tabs":{"items":{"additionalProperties":true,"type":"object"},"title":"Tabs","type":"array"},"viewer_ready":{"title":"Viewer Ready","type":"boolean"}},"required":["session_id","build_id","step_number","status","control_mode","tabs","capabilities"],"title":"BrowserSession","type":"object"},"BrowserSessionCapabilities":{"additionalProperties":false,"examples":[{"viewer":{"expires_at":1768478400.0,"mode":"view","url":"https://browser.example.com/session/view"}}],"properties":{"cdp":{"$ref":"#/components/schemas/BrowserSessionCapabilitiesCdp","title":"Cdp"},"controller":{"$ref":"#/components/schemas/BrowserSessionCapabilitiesController","title":"Controller"},"viewer":{"$ref":"#/components/schemas/BrowserSessionCapabilitiesViewer","title":"Viewer"}},"title":"BrowserSessionCapabilities","type":"object"},"BrowserSessionCapabilitiesCdp":{"additionalProperties":false,"examples":[{"base_url":"https://portal.example.com/resource","discovery_url":"https://portal.example.com/resource","expires_at":1.0,"warning":"example"}],"properties":{"base_url":{"format":"uri","minLength":1,"title":"Base Url","type":"string"},"discovery_url":{"format":"uri","minLength":1,"title":"Discovery Url","type":"string"},"expires_at":{"title":"Expires At","type":"number"},"warning":{"title":"Warning","type":"string"}},"required":["discovery_url","base_url","expires_at","warning"],"title":"BrowserSessionCapabilitiesCdp","type":"object"},"BrowserSessionCapabilitiesController":{"additionalProperties":false,"examples":[{"expires_at":1.0,"mode":"view","url":"https://portal.example.com/resource"}],"properties":{"expires_at":{"title":"Expires At","type":"number"},"mode":{"enum":["view","control"],"title":"Mode","type":"string"},"url":{"format":"uri","minLength":1,"title":"Url","type":"string"}},"required":["mode","url","expires_at"],"title":"BrowserSessionCapabilitiesController","type":"object"},"BrowserSessionCapabilitiesViewer":{"additionalProperties":false,"examples":[{"expires_at":1.0,"mode":"view","url":"https://portal.example.com/resource"}],"properties":{"expires_at":{"title":"Expires At","type":"number"},"mode":{"enum":["view","control"],"title":"Mode","type":"string"},"url":{"format":"uri","minLength":1,"title":"Url","type":"string"}},"required":["mode","url","expires_at"],"title":"BrowserSessionCapabilitiesViewer","type":"object"},"BrowserSessionCreate":{"additionalProperties":false,"examples":[{"build_id":"build_example","step_number":1}],"properties":{"build_id":{"minLength":1,"title":"Build Id","type":"string"},"credential_id":{"title":"Credential Id","type":"string"},"existing_code":{"title":"Existing Code","type":"string"},"recorded_task_id":{"title":"Recorded Task Id","type":"string"},"step_number":{"minimum":1,"title":"Step Number","type":"integer"},"url":{"format":"uri","minLength":1,"title":"Url","type":"string"}},"required":["build_id","step_number"],"title":"BrowserSessionCreate","type":"object"},"BrowserToolList":{"additionalProperties":false,"examples":[{"tools":[{"input_schema":{},"name":"Example workflow"}]}],"properties":{"tools":{"items":{"$ref":"#/components/schemas/BrowserToolListTool"},"title":"Tools","type":"array"}},"required":["tools"],"title":"BrowserToolList","type":"object"},"BrowserToolListTool":{"additionalProperties":false,"examples":[{"input_schema":{},"name":"Example workflow"}],"properties":{"description":{"title":"Description","type":"string"},"input_schema":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Input Schema","type":"object"},"name":{"title":"Name","type":"string"}},"required":["name","input_schema"],"title":"BrowserToolListTool","type":"object"},"CatalogAgentReviewItem":{"additionalProperties":false,"examples":[{"agent_id":"agent_example","agent_version":"1.0.0","available_decisions":["approve"],"execution_id":"execution_example","execution_status_url":"https://portal.example.com/resource","id":"id_example","installation_id":"installation_example","item_type":"example","source":"agent","state":"waiting_for_review","waiting_since":"2026-01-15T12:00:00Z"}],"properties":{"agent_id":{"title":"Agent Id","type":"string"},"agent_version":{"title":"Agent Version","type":"string"},"available_decisions":{"items":{"enum":["approve","reject","defer"],"type":"string"},"title":"Available Decisions","type":"array"},"execution_id":{"title":"Execution Id","type":"string"},"execution_status_url":{"title":"Execution Status Url","type":"string"},"id":{"title":"Id","type":"string"},"installation_id":{"title":"Installation Id","type":"string"},"item_type":{"title":"Item Type","type":"string"},"revision_token":{"title":"Revision Token","type":"string"},"source":{"const":"agent","title":"Source","type":"string"},"state":{"enum":["waiting_for_review","resolved"],"title":"State","type":"string"},"summary":{"additionalProperties":{"type":"string"},"title":"Summary","type":"object"},"waiting_since":{"format":"date-time","title":"Waiting Since","type":"string"},"workflow_definition_id":{"title":"Workflow Definition Id","type":"string"},"workflow_instance_id":{"title":"Workflow Instance Id","type":"string"}},"required":["id","source","agent_id","agent_version","installation_id","execution_id","item_type","state","available_decisions","waiting_since","execution_status_url"],"title":"CatalogAgentReviewItem","type":"object"},"ChildWorkflowSummary":{"additionalProperties":false,"examples":[{"failed":1,"succeeded":1}],"properties":{"failed":{"minimum":0,"title":"Failed","type":"integer"},"succeeded":{"minimum":0,"title":"Succeeded","type":"integer"}},"required":["succeeded","failed"],"title":"ChildWorkflowSummary","type":"object"},"CoordinationSession":{"additionalProperties":false,"examples":[{"capabilities":{"human_control":false,"idempotent_send":false,"replay_events":false,"send":false,"stream_on_send":false,"wait":false},"control_mode":"human","current_step_number":1,"event_cursor":1,"events_path":"example","native_status":"example","parent_session_id":"parent_session_example","resource_path":"example","session_id":"pbld_example","session_kind":"planner","state_version":1,"status":"queued"}],"properties":{"capabilities":{"$ref":"#/components/schemas/CoordinationSessionCapabilities"},"control_mode":{"anyOf":[{"enum":["human","shared"],"type":"string"},{"type":"null"}],"title":"Control Mode"},"current_step_number":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"title":"Current Step Number"},"event_cursor":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"title":"Event Cursor"},"events_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Events Path"},"native_status":{"title":"Native Status","type":"string"},"parent_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Session Id"},"resource_path":{"minLength":1,"title":"Resource Path","type":"string"},"session_id":{"maxLength":200,"minLength":5,"pattern":"^(?:pbld_|bas_|qds_)[A-Za-z0-9_-]+$","title":"Session Id","type":"string"},"session_kind":{"enum":["planner","browser","queue_ui"],"title":"Session Kind","type":"string"},"state_version":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"title":"State Version"},"status":{"enum":["queued","working","blocked","idle","done","failed","cancelled","unknown"],"title":"Status","type":"string"}},"required":["session_id","session_kind","status","native_status","parent_session_id","current_step_number","state_version","event_cursor","control_mode","capabilities","resource_path","events_path"],"title":"CoordinationSession","type":"object"},"CoordinationSessionCapabilities":{"additionalProperties":false,"examples":[{"human_control":false,"idempotent_send":false,"replay_events":false,"send":false,"stream_on_send":false,"wait":false}],"properties":{"human_control":{"title":"Human Control","type":"boolean"},"idempotent_send":{"title":"Idempotent Send","type":"boolean"},"replay_events":{"title":"Replay Events","type":"boolean"},"send":{"title":"Send","type":"boolean"},"stream_on_send":{"title":"Stream On Send","type":"boolean"},"wait":{"title":"Wait","type":"boolean"}},"required":["send","wait","replay_events","stream_on_send","idempotent_send","human_control"],"title":"CoordinationSessionCapabilities","type":"object"},"CoordinationSessionEventList":{"additionalProperties":false,"examples":[{"data":[{"created_at":"2026-01-15T12:00:00Z","cursor":1,"data":{},"event":"example","schema_version":1}],"has_more":false,"next_cursor":1,"session_id":"pbld_example","session_kind":"planner"}],"properties":{"data":{"items":{"$ref":"#/components/schemas/PlannerEvent"},"title":"Data","type":"array"},"has_more":{"title":"Has More","type":"boolean"},"next_cursor":{"minimum":0,"title":"Next Cursor","type":"integer"},"session_id":{"maxLength":200,"minLength":5,"pattern":"^(?:pbld_|bas_|qds_)[A-Za-z0-9_-]+$","title":"Session Id","type":"string"},"session_kind":{"const":"planner","title":"Session Kind","type":"string"}},"required":["session_id","session_kind","data","next_cursor","has_more"],"title":"CoordinationSessionEventList","type":"object"},"CoordinationSessionMessageCreate":{"additionalProperties":false,"examples":[{"message":"Request accepted."}],"properties":{"expected_state_version":{"minimum":1,"title":"Expected State Version","type":"integer"},"message":{"maxLength":200000,"minLength":1,"title":"Message","type":"string"},"source_session_id":{"maxLength":200,"minLength":5,"pattern":"^(?:pbld_|bas_|qds_)[A-Za-z0-9_-]+$","title":"Source Session Id","type":"string"},"step_number":{"minimum":1,"title":"Step Number","type":"integer"}},"required":["message"],"title":"CoordinationSessionMessageCreate","type":"object"},"Credential":{"additionalProperties":false,"examples":[{"created_at":"2026-01-15T12:00:00Z","credential_id":"credential_example","domain":"example","is_active":false,"login_url":"https://portal.example.com/resource","revoked_at":"2026-01-15T12:00:00Z","site_name":"example","sms_phone_type":"voip","updated_at":"2026-01-15T12:00:00Z","username":"example","version":1}],"properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"credential_id":{"minLength":1,"title":"Credential Id","type":"string"},"domain":{"title":"Domain","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"login_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Login Url"},"revoked_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Revoked At"},"session_revocation_failed":{"title":"Session Revocation Failed","type":"boolean"},"site_name":{"title":"Site Name","type":"string"},"sms_phone_type":{"enum":["voip","real_sim"],"title":"Sms Phone Type","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"username":{"title":"Username","type":"string"},"vault_cleanup_complete":{"title":"Vault Cleanup Complete","type":"boolean"},"version":{"minimum":1,"title":"Version","type":"integer"}},"required":["credential_id","domain","site_name","username","login_url","sms_phone_type","is_active","version","created_at","updated_at","revoked_at"],"title":"Credential","type":"object"},"CredentialCreate":{"additionalProperties":false,"examples":[{"domain":"example","password":"example","site_name":"example","username":"example"}],"properties":{"domain":{"minLength":1,"title":"Domain","type":"string"},"login_url":{"title":"Login Url","type":"string"},"notes":{"title":"Notes","type":"string"},"password":{"title":"Password","type":"string"},"phone_number":{"title":"Phone Number","type":"string"},"pin":{"title":"Pin","type":"string"},"site_name":{"title":"Site Name","type":"string"},"sms_phone_type":{"enum":["voip","real_sim"],"title":"Sms Phone Type","type":"string"},"totp":{"title":"Totp","type":"string"},"username":{"title":"Username","type":"string"}},"required":["domain","site_name","username","password"],"title":"CredentialCreate","type":"object"},"CredentialList":{"additionalProperties":false,"examples":[{"data":[{"created_at":"2026-01-15T12:00:00Z","credential_id":"credential_example","domain":"example","is_active":false,"login_url":"https://portal.example.com/resource","revoked_at":"2026-01-15T12:00:00Z","site_name":"example","sms_phone_type":"voip","updated_at":"2026-01-15T12:00:00Z","username":"example","version":1}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/Credential"},"title":"Data","type":"array"}},"required":["data"],"title":"CredentialList","type":"object"},"CredentialRotate":{"additionalProperties":false,"examples":[{"password":"example-password-not-a-real-secret"}],"properties":{"login_url":{"title":"Login Url","type":"string"},"notes":{"title":"Notes","type":"string"},"password":{"title":"Password","type":"string"},"phone_number":{"title":"Phone Number","type":"string"},"pin":{"title":"Pin","type":"string"},"site_name":{"title":"Site Name","type":"string"},"sms_phone_type":{"enum":["voip","real_sim"],"title":"Sms Phone Type","type":"string"},"totp":{"title":"Totp","type":"string"},"username":{"title":"Username","type":"string"}},"title":"CredentialRotate","type":"object"},"DashboardQueryCreate":{"additionalProperties":false,"examples":[{"prompt":"example"}],"properties":{"prompt":{"minLength":1,"title":"Prompt","type":"string"},"session_id":{"title":"Session Id","type":"string"},"workflow_definition_id":{"title":"Workflow Definition Id","type":"string"},"workflow_name":{"title":"Workflow Name","type":"string"}},"required":["prompt"],"title":"DashboardQueryCreate","type":"object"},"DashboardQueryResult":{"additionalProperties":true,"examples":[{"answer":"Three runs completed successfully.","evidence":[]}],"properties":{},"title":"DashboardQueryResult","type":"object"},"DynamicRuntimeInput":{"additionalProperties":true,"examples":[{"record_id":"record_example"}],"properties":{},"title":"DynamicRuntimeInput","type":"object"},"Error":{"additionalProperties":false,"examples":[{"error":{"code":"INVALID_REQUEST","message":"Request accepted."}}],"properties":{"error":{"$ref":"#/components/schemas/ErrorDetails"}},"required":["error"],"title":"Error","type":"object"},"ErrorAction":{"additionalProperties":false,"examples":[{"type":"example"}],"properties":{"type":{"title":"Type","type":"string"}},"required":["type"],"title":"ErrorAction","type":"object"},"ErrorDetails":{"additionalProperties":false,"examples":[{"code":"INVALID_REQUEST","message":"Request accepted."}],"properties":{"action":{"$ref":"#/components/schemas/ErrorAction","title":"Action"},"code":{"examples":["INVALID_REQUEST"],"title":"Code","type":"string"},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"string"}],"title":"Details"},"limit":{"minimum":0,"title":"Limit","type":"integer"},"message":{"examples":["The request could not be validated."],"title":"Message","type":"string"},"metric":{"title":"Metric","type":"string"},"renewable_at":{"format":"date-time","title":"Renewable At","type":"string"},"retryable":{"title":"Retryable","type":"boolean"},"scope":{"title":"Scope","type":"string"}},"required":["code","message"],"title":"ErrorDetails","type":"object"},"FactoryEvent":{"additionalProperties":false,"examples":[{"created_at":"2026-01-15T12:00:00Z","data":{},"id":1,"type":"example"}],"properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Data","type":"object"},"id":{"title":"Id","type":"integer"},"type":{"title":"Type","type":"string"}},"required":["id","type","data","created_at"],"title":"FactoryEvent","type":"object"},"FactoryEventList":{"additionalProperties":false,"examples":[{"data":[{"created_at":"2026-01-15T12:00:00Z","data":{},"id":1,"type":"example"}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/FactoryEvent"},"title":"Data","type":"array"}},"required":["data"],"title":"FactoryEventList","type":"object"},"HealthResponse":{"additionalProperties":false,"examples":[{"service":"example","status":"example"}],"properties":{"service":{"examples":["developer-api"],"title":"Service","type":"string"},"status":{"examples":["healthy"],"title":"Status","type":"string"}},"required":["status","service"],"title":"HealthResponse","type":"object"},"Installation":{"additionalProperties":false,"examples":[{"agent_id":"agent_example","agent_version":"1.0.0","configuration":{},"created_at":"2026-01-15T12:00:00Z","id":"id_example","status":"example","updated_at":"2026-01-15T12:00:00Z"}],"properties":{"agent_id":{"minLength":1,"title":"Agent Id","type":"string"},"agent_version":{"title":"Agent Version","type":"string"},"configuration":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Configuration","type":"object"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"error":{"$ref":"#/components/schemas/PublicResourceError","title":"Error"},"id":{"minLength":1,"title":"Id","type":"string"},"next_action":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Next Action","type":"object"},"source_summary":{"$ref":"#/components/schemas/InstallationSourceSummary","title":"Source Summary"},"sources":{"items":{"$ref":"#/components/schemas/KnowledgeSource"},"title":"Sources","type":"array"},"status":{"title":"Status","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","agent_id","agent_version","status","configuration","created_at","updated_at"],"title":"Installation","type":"object"},"InstallationCreate":{"additionalProperties":true,"examples":[{"mailbox":"invoices@example.com"}],"properties":{},"title":"InstallationCreate","type":"object"},"InstallationSourceSummary":{"additionalProperties":false,"examples":[{"awaiting_upload":1,"failed":1,"indexed":1,"indexing":1,"total":1}],"properties":{"awaiting_upload":{"minimum":0,"title":"Awaiting Upload","type":"integer"},"failed":{"minimum":0,"title":"Failed","type":"integer"},"indexed":{"minimum":0,"title":"Indexed","type":"integer"},"indexing":{"minimum":0,"title":"Indexing","type":"integer"},"total":{"minimum":0,"title":"Total","type":"integer"}},"required":["total","awaiting_upload","indexing","indexed","failed"],"title":"InstallationSourceSummary","type":"object"},"Integration":{"additionalProperties":false,"examples":[{"auth_type":"OAUTH2","capabilities":[{"description":"Example organization-scoped resource.","input_schema":{},"key":"example","name":"Example workflow","output_schema":{},"requires_auth":false,"type":"READ"}],"category":"example","description":"Example organization-scoped resource.","documentation_url":"https://portal.example.com/resource","id":"id_example","is_beta":false,"key":"example","name":"Example workflow","version":1}],"properties":{"auth_type":{"enum":["OAUTH2","OAUTH1","API_KEY","BASIC_AUTH","BEARER_TOKEN","JWT","CUSTOM_AUTH","NONE","CLIENT_CREDENTIALS","OAUTH2_CC"],"title":"Auth Type","type":"string"},"capabilities":{"items":{"$ref":"#/components/schemas/IntegrationCapability"},"title":"Capabilities","type":"array"},"category":{"title":"Category","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"documentation_url":{"anyOf":[{"format":"uri","minLength":1,"type":"string"},{"type":"null"}],"title":"Documentation Url"},"id":{"title":"Id","type":"string"},"is_beta":{"title":"Is Beta","type":"boolean"},"key":{"title":"Key","type":"string"},"name":{"title":"Name","type":"string"},"version":{"minimum":1,"title":"Version","type":"integer"}},"required":["id","key","name","description","category","auth_type","version","is_beta","documentation_url","capabilities"],"title":"Integration","type":"object"},"IntegrationCapability":{"additionalProperties":false,"examples":[{"description":"Example organization-scoped resource.","input_schema":{},"key":"example","name":"Example workflow","output_schema":{},"requires_auth":false,"type":"READ"}],"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"input_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Input Schema"},"key":{"title":"Key","type":"string"},"name":{"title":"Name","type":"string"},"output_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output Schema"},"requires_auth":{"title":"Requires Auth","type":"boolean"},"type":{"enum":["READ","WRITE","DELETE","SYNC","WEBHOOK","ACTION","SEARCH","EXPORT","IMPORT","BATCH"],"title":"Type","type":"string"}},"required":["key","name","description","type","requires_auth","input_schema","output_schema"],"title":"IntegrationCapability","type":"object"},"IntegrationCategory":{"additionalProperties":false,"examples":[{"count":1,"key":"example"}],"properties":{"count":{"minimum":1,"title":"Count","type":"integer"},"key":{"title":"Key","type":"string"}},"required":["key","count"],"title":"IntegrationCategory","type":"object"},"IntegrationCategoryList":{"additionalProperties":false,"examples":[{"data":[{"count":1,"key":"example"}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/IntegrationCategory"},"title":"Data","type":"array"}},"required":["data"],"title":"IntegrationCategoryList","type":"object"},"IntegrationConnection":{"additionalProperties":false,"examples":[{"active":false,"connected_at":"2026-01-15T12:00:00Z","credential_id":"credential_example","credential_source":"none","id":"id_example","integration_key":"example","label":"example","last_error":"example","status":"example"}],"properties":{"active":{"title":"Active","type":"boolean"},"connected_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Connected At"},"credential_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credential Id"},"credential_source":{"enum":["none","vault"],"title":"Credential Source","type":"string"},"id":{"title":"Id","type":"string"},"integration_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Key"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error"},"status":{"title":"Status","type":"string"}},"required":["id","integration_key","label","status","active","credential_source","credential_id","connected_at","last_error"],"title":"IntegrationConnection","type":"object"},"IntegrationConnectionCreate":{"additionalProperties":false,"examples":[{"credential_id":"credential_example","label":"Production connection"}],"properties":{"config":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"null"}]},"description":"Optional bounded, non-secret fields declared by the integration config schema.","maxProperties":100,"title":"Config","type":"object"},"credential_id":{"description":"Required unless the integration auth type is NONE.","title":"Credential Id","type":"string"},"label":{"maxLength":120,"title":"Label","type":"string"}},"title":"IntegrationConnectionCreate","type":"object"},"IntegrationConnectionList":{"additionalProperties":false,"examples":[{"data":[{"active":false,"connected_at":"2026-01-15T12:00:00Z","credential_id":"credential_example","credential_source":"none","id":"id_example","integration_key":"example","label":"example","last_error":"example","status":"example"}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/IntegrationConnection"},"title":"Data","type":"array"}},"required":["data"],"title":"IntegrationConnectionList","type":"object"},"IntegrationConnectionValidation":{"additionalProperties":false,"examples":[{"id":"id_example","object":"integration_connection_validation","valid":false,"validated_at":"2026-01-15T12:00:00Z"}],"properties":{"id":{"title":"Id","type":"string"},"object":{"const":"integration_connection_validation","title":"Object","type":"string"},"valid":{"title":"Valid","type":"boolean"},"validated_at":{"format":"date-time","title":"Validated At","type":"string"}},"required":["id","object","valid","validated_at"],"title":"IntegrationConnectionValidation","type":"object"},"IntegrationFactoryCapabilityTest":{"additionalProperties":false,"examples":[{"capability_key":"example","capability_type":"READ","created_at":"2026-01-15T12:00:00Z","expires_at":"2026-01-15T12:00:00Z","id":"id_example","method":"example","object":"integration_factory_capability_test","run_id":"run_example","side_effecting":false,"status":"queued"}],"properties":{"capability_key":{"title":"Capability Key","type":"string"},"capability_type":{"enum":["READ","WRITE","DELETE","SYNC","WEBHOOK","ACTION","SEARCH","EXPORT","IMPORT","BATCH"],"title":"Capability Type","type":"string"},"completed_at":{"format":"date-time","title":"Completed At","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"duration_ms":{"minimum":0,"title":"Duration Ms","type":"integer"},"error":{"$ref":"#/components/schemas/IntegrationFactoryCapabilityTestError","title":"Error"},"expires_at":{"format":"date-time","title":"Expires At","type":"string"},"id":{"title":"Id","type":"string"},"method":{"title":"Method","type":"string"},"object":{"const":"integration_factory_capability_test","title":"Object","type":"string"},"result":{"additionalProperties":true,"description":"Bounded and secret-redacted capability execution result.","title":"Result","type":"object"},"run_id":{"title":"Run Id","type":"string"},"side_effecting":{"title":"Side Effecting","type":"boolean"},"started_at":{"format":"date-time","title":"Started At","type":"string"},"status":{"enum":["queued","running","succeeded","failed","unknown"],"title":"Status","type":"string"}},"required":["id","object","run_id","capability_key","capability_type","method","side_effecting","status","created_at","expires_at"],"title":"IntegrationFactoryCapabilityTest","type":"object"},"IntegrationFactoryCapabilityTestCreate":{"additionalProperties":false,"examples":[{"capability_key":"example"}],"properties":{"capability_key":{"maxLength":200,"minLength":1,"title":"Capability Key","type":"string"},"confirm_side_effects":{"default":false,"description":"Must be true for capabilities that can create, update, delete, or otherwise change external data.","title":"Confirm Side Effects","type":"boolean"},"credential_id":{"description":"Required unless the generated integration auth type is NONE.","title":"Credential Id","type":"string"},"params":{"additionalProperties":true,"description":"Capability input parameters, limited to 128 KiB after JSON encoding.","title":"Params","type":"object"}},"required":["capability_key"],"title":"IntegrationFactoryCapabilityTestCreate","type":"object"},"IntegrationFactoryCapabilityTestError":{"additionalProperties":false,"examples":[{"code":"INVALID_REQUEST","message":"Request accepted."}],"properties":{"code":{"title":"Code","type":"string"},"message":{"title":"Message","type":"string"}},"required":["code","message"],"title":"IntegrationFactoryCapabilityTestError","type":"object"},"IntegrationFactoryDiscoveryByUpload":{"additionalProperties":false,"examples":[{"api_name":"example","auth_type":"NONE","key":"example","upload_id":"upload_example"}],"properties":{"api_key_header":{"description":"Header used to send the stored API key; only valid with API_KEY.","maxLength":100,"pattern":"^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$","title":"Api Key Header","type":"string"},"api_name":{"maxLength":120,"minLength":1,"title":"Api Name","type":"string"},"auth_type":{"enum":["NONE","API_KEY","BASIC_AUTH","BEARER_TOKEN","CLIENT_CREDENTIALS"],"title":"Auth Type","type":"string"},"base_path":{"pattern":"^/","title":"Base Path","type":"string"},"base_url":{"format":"uri","minLength":1,"pattern":"^https://","title":"Base Url","type":"string"},"category":{"default":"CUSTOM","maxLength":100,"title":"Category","type":"string"},"custom_instructions":{"maxLength":8000,"title":"Custom Instructions","type":"string"},"documentation":{"maxLength":100000,"minLength":1,"title":"Documentation","type":"string"},"documentation_url":{"format":"uri","minLength":1,"pattern":"^https://","title":"Documentation Url","type":"string"},"key":{"maxLength":80,"title":"Key","type":"string"},"upload_id":{"title":"Upload Id","type":"string"}},"required":["api_name","key","auth_type","upload_id"],"title":"IntegrationFactoryDiscoveryByUpload","type":"object"},"IntegrationFactoryDiscoveryByUrl":{"additionalProperties":false,"examples":[{"api_name":"example","auth_type":"NONE","documentation_url":"https://portal.example.com/resource","key":"example"}],"properties":{"api_key_header":{"description":"Header used to send the stored API key; only valid with API_KEY.","maxLength":100,"pattern":"^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$","title":"Api Key Header","type":"string"},"api_name":{"maxLength":120,"minLength":1,"title":"Api Name","type":"string"},"auth_type":{"enum":["NONE","API_KEY","BASIC_AUTH","BEARER_TOKEN","CLIENT_CREDENTIALS"],"title":"Auth Type","type":"string"},"base_path":{"pattern":"^/","title":"Base Path","type":"string"},"base_url":{"format":"uri","minLength":1,"pattern":"^https://","title":"Base Url","type":"string"},"category":{"default":"CUSTOM","maxLength":100,"title":"Category","type":"string"},"custom_instructions":{"maxLength":8000,"title":"Custom Instructions","type":"string"},"documentation":{"maxLength":100000,"minLength":1,"title":"Documentation","type":"string"},"documentation_url":{"format":"uri","minLength":1,"pattern":"^https://","title":"Documentation Url","type":"string"},"key":{"maxLength":80,"title":"Key","type":"string"},"upload_id":{"title":"Upload Id","type":"string"}},"required":["api_name","key","auth_type","documentation_url"],"title":"IntegrationFactoryDiscoveryByUrl","type":"object"},"IntegrationFactoryDiscoveryCreate":{"examples":[{"api_name":"example","auth_type":"NONE","documentation_url":"https://portal.example.com/resource","key":"example"}],"oneOf":[{"$ref":"#/components/schemas/IntegrationFactoryDiscoveryByUrl"},{"$ref":"#/components/schemas/IntegrationFactoryDiscoveryInline"},{"$ref":"#/components/schemas/IntegrationFactoryDiscoveryByUpload"}],"title":"IntegrationFactoryDiscoveryCreate"},"IntegrationFactoryDiscoveryInline":{"additionalProperties":false,"examples":[{"api_name":"example","auth_type":"NONE","documentation":"example","key":"example"}],"properties":{"api_key_header":{"description":"Header used to send the stored API key; only valid with API_KEY.","maxLength":100,"pattern":"^[!#$%&'*+\\-.^_`|~0-9A-Za-z]+$","title":"Api Key Header","type":"string"},"api_name":{"maxLength":120,"minLength":1,"title":"Api Name","type":"string"},"auth_type":{"enum":["NONE","API_KEY","BASIC_AUTH","BEARER_TOKEN","CLIENT_CREDENTIALS"],"title":"Auth Type","type":"string"},"base_path":{"pattern":"^/","title":"Base Path","type":"string"},"base_url":{"format":"uri","minLength":1,"pattern":"^https://","title":"Base Url","type":"string"},"category":{"default":"CUSTOM","maxLength":100,"title":"Category","type":"string"},"custom_instructions":{"maxLength":8000,"title":"Custom Instructions","type":"string"},"documentation":{"maxLength":100000,"minLength":1,"title":"Documentation","type":"string"},"documentation_url":{"format":"uri","minLength":1,"pattern":"^https://","title":"Documentation Url","type":"string"},"key":{"maxLength":80,"title":"Key","type":"string"},"upload_id":{"title":"Upload Id","type":"string"}},"required":["api_name","key","auth_type","documentation"],"title":"IntegrationFactoryDiscoveryInline","type":"object"},"IntegrationFactoryExtensionDiscoveryByUpload":{"additionalProperties":false,"examples":[{"upload_id":"upload_example"}],"properties":{"custom_instructions":{"maxLength":8000,"title":"Custom Instructions","type":"string"},"documentation":{"maxLength":100000,"minLength":1,"title":"Documentation","type":"string"},"documentation_url":{"format":"uri","minLength":1,"pattern":"^https://","title":"Documentation Url","type":"string"},"upload_id":{"title":"Upload Id","type":"string"}},"required":["upload_id"],"title":"IntegrationFactoryExtensionDiscoveryByUpload","type":"object"},"IntegrationFactoryExtensionDiscoveryByUrl":{"additionalProperties":false,"examples":[{"documentation_url":"https://portal.example.com/resource"}],"properties":{"custom_instructions":{"maxLength":8000,"title":"Custom Instructions","type":"string"},"documentation":{"maxLength":100000,"minLength":1,"title":"Documentation","type":"string"},"documentation_url":{"format":"uri","minLength":1,"pattern":"^https://","title":"Documentation Url","type":"string"},"upload_id":{"title":"Upload Id","type":"string"}},"required":["documentation_url"],"title":"IntegrationFactoryExtensionDiscoveryByUrl","type":"object"},"IntegrationFactoryExtensionDiscoveryCreate":{"examples":[{"documentation_url":"https://portal.example.com/resource"}],"oneOf":[{"$ref":"#/components/schemas/IntegrationFactoryExtensionDiscoveryByUrl"},{"$ref":"#/components/schemas/IntegrationFactoryExtensionDiscoveryInline"},{"$ref":"#/components/schemas/IntegrationFactoryExtensionDiscoveryByUpload"}],"title":"IntegrationFactoryExtensionDiscoveryCreate"},"IntegrationFactoryExtensionDiscoveryInline":{"additionalProperties":false,"examples":[{"documentation":"example"}],"properties":{"custom_instructions":{"maxLength":8000,"title":"Custom Instructions","type":"string"},"documentation":{"maxLength":100000,"minLength":1,"title":"Documentation","type":"string"},"documentation_url":{"format":"uri","minLength":1,"pattern":"^https://","title":"Documentation Url","type":"string"},"upload_id":{"title":"Upload Id","type":"string"}},"required":["documentation"],"title":"IntegrationFactoryExtensionDiscoveryInline","type":"object"},"IntegrationFactoryGenerationCreate":{"additionalProperties":false,"examples":[{"discovery_id":"discovery_example"}],"properties":{"auth_type":{"enum":["NONE","API_KEY","BASIC_AUTH","BEARER_TOKEN","CLIENT_CREDENTIALS"],"title":"Auth Type","type":"string"},"base_path":{"pattern":"^/","title":"Base Path","type":"string"},"discovery_id":{"title":"Discovery Id","type":"string"},"endpoints":{"items":{"type":"string"},"maxItems":20,"minItems":1,"title":"Endpoints","type":"array","uniqueItems":true}},"required":["discovery_id"],"title":"IntegrationFactoryGenerationCreate","type":"object"},"IntegrationFactoryRun":{"additionalProperties":false,"examples":[{"auth_type":"NONE","created_at":"2026-01-15T12:00:00Z","endpoint_count":1,"expires_at":"2026-01-15T12:00:00Z","id":"id_example","key":"example","name":"Example workflow","object":"integration_factory_run","operation":"create","phase":"discovery","state_version":1,"status":"queued","updated_at":"2026-01-15T12:00:00Z"}],"properties":{"auth_type":{"enum":["NONE","API_KEY","BASIC_AUTH","BEARER_TOKEN","CLIENT_CREDENTIALS"],"title":"Auth Type","type":"string"},"capabilities":{"items":{"$ref":"#/components/schemas/IntegrationCapability"},"maxItems":20,"title":"Capabilities","type":"array"},"capability_tests":{"items":{"$ref":"#/components/schemas/IntegrationFactoryRunCapabilityTest"},"title":"Capability Tests","type":"array"},"connection_id":{"title":"Connection Id","type":"string"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"discovery":{"$ref":"#/components/schemas/IntegrationFactoryRunDiscovery","title":"Discovery"},"endpoint_count":{"maximum":30,"minimum":0,"title":"Endpoint Count","type":"integer"},"error":{"$ref":"#/components/schemas/IntegrationFactoryRunError","title":"Error"},"expires_at":{"format":"date-time","title":"Expires At","type":"string"},"id":{"title":"Id","type":"string"},"integration":{"$ref":"#/components/schemas/IntegrationFactoryRunIntegration","title":"Integration"},"key":{"title":"Key","type":"string"},"name":{"title":"Name","type":"string"},"object":{"const":"integration_factory_run","title":"Object","type":"string"},"operation":{"enum":["create","extend"],"title":"Operation","type":"string"},"phase":{"enum":["discovery","generation","validation","promotion","completed","failed"],"title":"Phase","type":"string"},"required_capability_test_keys":{"items":{"type":"string"},"maxItems":20,"title":"Required Capability Test Keys","type":"array"},"state_version":{"minimum":1,"title":"State Version","type":"integer"},"status":{"enum":["queued","discovering","awaiting_generation","generation_queued","generating","generated","validation_queued","validating","validated","promotion_queued","promoting","completed","failed"],"title":"Status","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","object","operation","status","phase","state_version","key","name","auth_type","endpoint_count","created_at","updated_at","expires_at"],"title":"IntegrationFactoryRun","type":"object"},"IntegrationFactoryRunCapabilityTest":{"additionalProperties":false,"examples":[{"capability_key":"example","id":"id_example","side_effecting":false,"status":"queued"}],"properties":{"capability_key":{"title":"Capability Key","type":"string"},"id":{"title":"Id","type":"string"},"side_effecting":{"title":"Side Effecting","type":"boolean"},"status":{"enum":["queued","running","succeeded","failed","unknown"],"title":"Status","type":"string"}},"required":["id","capability_key","side_effecting","status"],"title":"IntegrationFactoryRunCapabilityTest","type":"object"},"IntegrationFactoryRunDiscovery":{"additionalProperties":false,"examples":[{"endpoint_names":["example"],"proposed_base_path":"example","proposed_base_url":"https://portal.example.com/resource","proposed_key":"example","proposed_name":"example"}],"properties":{"endpoint_names":{"items":{"type":"string"},"maxItems":30,"minItems":1,"title":"Endpoint Names","type":"array"},"proposed_base_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proposed Base Path"},"proposed_base_url":{"anyOf":[{"format":"uri","minLength":1,"type":"string"},{"type":"null"}],"title":"Proposed Base Url"},"proposed_key":{"title":"Proposed Key","type":"string"},"proposed_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proposed Name"}},"required":["proposed_key","proposed_name","proposed_base_url","proposed_base_path","endpoint_names"],"title":"IntegrationFactoryRunDiscovery","type":"object"},"IntegrationFactoryRunError":{"additionalProperties":false,"examples":[{"code":"INVALID_REQUEST","message":"Request accepted."}],"properties":{"code":{"title":"Code","type":"string"},"message":{"title":"Message","type":"string"}},"required":["code","message"],"title":"IntegrationFactoryRunError","type":"object"},"IntegrationFactoryRunIntegration":{"additionalProperties":false,"examples":[{"id":"id_example","key":"example","status":"example","version":1}],"properties":{"id":{"title":"Id","type":"string"},"key":{"title":"Key","type":"string"},"status":{"title":"Status","type":"string"},"version":{"minimum":1,"title":"Version","type":"integer"}},"required":["id","key","version","status"],"title":"IntegrationFactoryRunIntegration","type":"object"},"IntegrationFactoryUpload":{"additionalProperties":false,"examples":[{"content_type":"example","expires_at":"2026-01-15T12:00:00Z","file_name":"example","id":"id_example","object":"integration_factory_upload","size_bytes":1,"status":"ready"}],"properties":{"content_type":{"title":"Content Type","type":"string"},"expires_at":{"format":"date-time","title":"Expires At","type":"string"},"file_name":{"title":"File Name","type":"string"},"id":{"title":"Id","type":"string"},"object":{"const":"integration_factory_upload","title":"Object","type":"string"},"size_bytes":{"maximum":20971520,"minimum":1,"title":"Size Bytes","type":"integer"},"status":{"enum":["ready","consumed"],"title":"Status","type":"string"}},"required":["id","object","status","file_name","content_type","size_bytes","expires_at"],"title":"IntegrationFactoryUpload","type":"object"},"IntegrationFactoryUploadCreate":{"additionalProperties":false,"examples":[{"content_type":"application/json","file_name":"example"}],"properties":{"content_type":{"enum":["application/json","application/pdf","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/yaml","application/x-yaml","text/markdown","text/plain","text/yaml"],"title":"Content Type","type":"string"},"file_name":{"maxLength":200,"minLength":1,"title":"File Name","type":"string"}},"required":["file_name","content_type"],"title":"IntegrationFactoryUploadCreate","type":"object"},"IntegrationFactoryUploadReservation":{"additionalProperties":false,"examples":[{"content_type":"example","file_name":"example","id":"id_example","max_bytes":20971520,"object":"integration_factory_upload","status":"pending","upload":{"expires_at":"2026-01-15T12:00:00Z","headers":{},"method":"PUT","url":"https://portal.example.com/resource"}}],"properties":{"content_type":{"title":"Content Type","type":"string"},"file_name":{"title":"File Name","type":"string"},"id":{"title":"Id","type":"string"},"max_bytes":{"const":20971520,"title":"Max Bytes","type":"integer"},"object":{"const":"integration_factory_upload","title":"Object","type":"string"},"status":{"const":"pending","title":"Status","type":"string"},"upload":{"$ref":"#/components/schemas/IntegrationFactoryUploadReservationUpload"}},"required":["id","object","status","file_name","content_type","max_bytes","upload"],"title":"IntegrationFactoryUploadReservation","type":"object"},"IntegrationFactoryUploadReservationUpload":{"additionalProperties":false,"examples":[{"expires_at":"2026-01-15T12:00:00Z","headers":{},"method":"PUT","url":"https://portal.example.com/resource"}],"properties":{"expires_at":{"format":"date-time","title":"Expires At","type":"string"},"headers":{"additionalProperties":{"type":"string"},"title":"Headers","type":"object"},"method":{"const":"PUT","title":"Method","type":"string"},"url":{"format":"uri","minLength":1,"title":"Url","type":"string"}},"required":["method","url","headers","expires_at"],"title":"IntegrationFactoryUploadReservationUpload","type":"object"},"IntegrationFactoryValidationCreate":{"additionalProperties":false,"examples":[{"credential_id":"credential_example"}],"properties":{"credential_id":{"description":"Required unless the generated integration auth type is NONE.","title":"Credential Id","type":"string"}},"title":"IntegrationFactoryValidationCreate","type":"object"},"IntegrationList":{"additionalProperties":false,"examples":[{"data":[{"auth_type":"OAUTH2","capabilities":[{"description":"Example organization-scoped resource.","input_schema":{},"key":"example","name":"Example workflow","output_schema":{},"requires_auth":false,"type":"READ"}],"category":"example","description":"Example organization-scoped resource.","documentation_url":"https://portal.example.com/resource","id":"id_example","is_beta":false,"key":"example","name":"Example workflow","version":1}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/Integration"},"title":"Data","type":"array"}},"required":["data"],"title":"IntegrationList","type":"object"},"KnowledgeSource":{"additionalProperties":false,"examples":[{"created_at":"2026-01-15T12:00:00Z","id":"id_example","name":"Example workflow","state":"example","type":"url","updated_at":"2026-01-15T12:00:00Z"}],"properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"error":{"$ref":"#/components/schemas/PublicResourceError","title":"Error"},"id":{"minLength":1,"title":"Id","type":"string"},"indexed_chunk_count":{"minimum":0,"title":"Indexed Chunk Count","type":"integer"},"name":{"title":"Name","type":"string"},"progress":{"title":"Progress","type":"string"},"state":{"title":"State","type":"string"},"type":{"enum":["url","file"],"title":"Type","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"},"upload":{"$ref":"#/components/schemas/KnowledgeSourceUpload","title":"Upload"}},"required":["id","type","state","name","created_at","updated_at"],"title":"KnowledgeSource","type":"object"},"KnowledgeSourceBatch":{"additionalProperties":false,"examples":[{"counts":{"awaiting_upload":1,"canceled":1,"deleted":1,"deleting":1,"failed":1,"indexed":1,"indexing":1,"pending":1,"total":1},"created_at":"2026-01-15T12:00:00Z","id":"id_example","installation_id":"installation_example","items":[{"id":"id_example","index":1,"state":"example","type":"url"}],"operation":"create_sources","status":"example","status_url":"https://portal.example.com/resource","updated_at":"2026-01-15T12:00:00Z"}],"properties":{"canceled_at":{"format":"date-time","title":"Canceled At","type":"string"},"completed_at":{"format":"date-time","title":"Completed At","type":"string"},"counts":{"$ref":"#/components/schemas/KnowledgeSourceBatchCounts"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"error":{"$ref":"#/components/schemas/PublicResourceError","title":"Error"},"id":{"minLength":1,"title":"Id","type":"string"},"installation_id":{"minLength":1,"title":"Installation Id","type":"string"},"items":{"items":{"$ref":"#/components/schemas/KnowledgeSourceBatchItem"},"title":"Items","type":"array"},"operation":{"const":"create_sources","title":"Operation","type":"string"},"started_at":{"format":"date-time","title":"Started At","type":"string"},"status":{"title":"Status","type":"string"},"status_url":{"title":"Status Url","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","installation_id","status","operation","counts","created_at","updated_at","status_url","items"],"title":"KnowledgeSourceBatch","type":"object"},"KnowledgeSourceBatchCounts":{"additionalProperties":false,"examples":[{"awaiting_upload":1,"canceled":1,"deleted":1,"deleting":1,"failed":1,"indexed":1,"indexing":1,"pending":1,"total":1}],"properties":{"awaiting_upload":{"minimum":0,"title":"Awaiting Upload","type":"integer"},"canceled":{"minimum":0,"title":"Canceled","type":"integer"},"deleted":{"minimum":0,"title":"Deleted","type":"integer"},"deleting":{"minimum":0,"title":"Deleting","type":"integer"},"failed":{"minimum":0,"title":"Failed","type":"integer"},"indexed":{"minimum":0,"title":"Indexed","type":"integer"},"indexing":{"minimum":0,"title":"Indexing","type":"integer"},"pending":{"minimum":0,"title":"Pending","type":"integer"},"total":{"minimum":0,"title":"Total","type":"integer"}},"required":["total","pending","awaiting_upload","indexing","indexed","deleting","deleted","failed","canceled"],"title":"KnowledgeSourceBatchCounts","type":"object"},"KnowledgeSourceBatchCreate":{"additionalProperties":false,"examples":[{"max_concurrency":5,"sources":[{"content_type":"application/pdf","file_name":"policy-manual.pdf","type":"file"},{"crawl_limit":50,"type":"url","url":"https://docs.example.com/policies/"}]}],"properties":{"max_concurrency":{"maximum":10,"minimum":1,"title":"Max Concurrency","type":"integer"},"sources":{"description":"Source payloads to add. Each item is validated against the installed agent version's live sourceSchemas contract; unknown keys are rejected by that schema.","examples":[[{"content_type":"application/pdf","file_name":"policy.pdf","type":"file"},{"crawl_limit":50,"type":"url","url":"https://docs.example.com/policies/"}]],"items":{"additionalProperties":true,"type":"object"},"maxItems":100,"minItems":1,"title":"Sources","type":"array"}},"required":["sources"],"title":"KnowledgeSourceBatchCreate","type":"object"},"KnowledgeSourceBatchItem":{"additionalProperties":false,"examples":[{"id":"id_example","index":1,"state":"example","type":"url"}],"properties":{"error":{"$ref":"#/components/schemas/PublicResourceError","title":"Error"},"id":{"minLength":1,"title":"Id","type":"string"},"index":{"minimum":0,"title":"Index","type":"integer"},"source":{"$ref":"#/components/schemas/KnowledgeSource","title":"Source"},"state":{"title":"State","type":"string"},"type":{"enum":["url","file"],"title":"Type","type":"string"},"upload":{"$ref":"#/components/schemas/KnowledgeSourceUpload","title":"Upload"}},"required":["id","index","type","state"],"title":"KnowledgeSourceBatchItem","type":"object"},"KnowledgeSourceCreate":{"additionalProperties":true,"examples":[{"content_type":"text/markdown","name":"Product documentation"}],"properties":{},"title":"KnowledgeSourceCreate","type":"object"},"KnowledgeSourceList":{"additionalProperties":false,"examples":[{"data":[{"created_at":"2026-01-15T12:00:00Z","id":"id_example","name":"Example workflow","state":"example","type":"url","updated_at":"2026-01-15T12:00:00Z"}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/KnowledgeSource"},"title":"Data","type":"array"}},"required":["data"],"title":"KnowledgeSourceList","type":"object"},"KnowledgeSourceUpload":{"additionalProperties":false,"examples":[{"expires_at":"2026-01-15T12:00:00Z","headers":{},"method":"PUT","url":"https://portal.example.com/resource"}],"properties":{"expires_at":{"format":"date-time","title":"Expires At","type":"string"},"headers":{"additionalProperties":{"type":"string"},"title":"Headers","type":"object"},"method":{"const":"PUT","title":"Method","type":"string"},"url":{"format":"uri","minLength":1,"title":"Url","type":"string"}},"required":["method","url","headers","expires_at"],"title":"KnowledgeSourceUpload","type":"object"},"MetricDashboard":{"additionalProperties":false,"examples":[{"dashboard":{},"period":{},"scope":{"id":"id_example","type":"agent"},"tiles":[{"data":[{}],"description":"Example organization-scoped resource.","id":"id_example","name":"Example workflow","type":"example","visualization":{}}]}],"properties":{"dashboard":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Dashboard","type":"object"},"period":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Period","type":"object"},"scope":{"$ref":"#/components/schemas/MetricScope"},"tiles":{"items":{"$ref":"#/components/schemas/MetricDashboardTile"},"title":"Tiles","type":"array"}},"required":["scope","dashboard","period","tiles"],"title":"MetricDashboard","type":"object"},"MetricDashboardList":{"additionalProperties":false,"examples":[{"data":[{"description":"Example organization-scoped resource.","id":"id_example","name":"Example workflow","tile_count":1,"url":"https://portal.example.com/resource","version":1}],"scope":{"id":"id_example","type":"agent"}}],"properties":{"data":{"items":{"$ref":"#/components/schemas/MetricDashboardSummary"},"title":"Data","type":"array"},"scope":{"$ref":"#/components/schemas/MetricScope"}},"required":["scope","data"],"title":"MetricDashboardList","type":"object"},"MetricDashboardSummary":{"additionalProperties":false,"examples":[{"description":"Example organization-scoped resource.","id":"id_example","name":"Example workflow","tile_count":1,"url":"https://portal.example.com/resource","version":1}],"properties":{"description":{"title":"Description","type":"string"},"id":{"minLength":1,"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"tile_count":{"title":"Tile Count","type":"integer"},"url":{"title":"Url","type":"string"},"version":{"title":"Version","type":"integer"}},"required":["id","name","description","version","tile_count","url"],"title":"MetricDashboardSummary","type":"object"},"MetricDashboardTile":{"additionalProperties":false,"examples":[{"data":[{}],"description":"Example organization-scoped resource.","id":"id_example","name":"Example workflow","type":"example","visualization":{}}],"properties":{"data":{"items":{"additionalProperties":true,"type":"object"},"title":"Data","type":"array"},"description":{"title":"Description","type":"string"},"id":{"minLength":1,"title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"},"visualization":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Visualization","type":"object"}},"required":["id","name","description","type","visualization","data"],"title":"MetricDashboardTile","type":"object"},"MetricScope":{"additionalProperties":false,"examples":[{"id":"id_example","type":"agent"}],"properties":{"agent_id":{"title":"Agent Id","type":"string"},"agent_versions":{"items":{"type":"string"},"title":"Agent Versions","type":"array"},"id":{"title":"Id","type":"string"},"type":{"enum":["agent","installation","workflow_definition"],"title":"Type","type":"string"}},"required":["type","id"],"title":"MetricScope","type":"object"},"MetricSummary":{"additionalProperties":false,"examples":[{"derived":{},"modeled":{},"observed":{},"period":{"from":"2026-01-15T12:00:00Z","timezone":"example","to":"2026-01-15T12:00:00Z"},"scope":{"id":"id_example","type":"agent"}}],"properties":{"derived":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Derived","type":"object"},"modeled":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Modeled","type":"object"},"observed":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Observed","type":"object"},"period":{"$ref":"#/components/schemas/MetricSummaryPeriod"},"scope":{"$ref":"#/components/schemas/MetricScope"}},"required":["scope","period","observed","derived","modeled"],"title":"MetricSummary","type":"object"},"MetricSummaryPeriod":{"additionalProperties":false,"examples":[{"from":"2026-01-15T12:00:00Z","timezone":"example","to":"2026-01-15T12:00:00Z"}],"properties":{"from":{"format":"date-time","title":"From","type":"string"},"timezone":{"title":"Timezone","type":"string"},"to":{"format":"date-time","title":"To","type":"string"}},"required":["from","to","timezone"],"title":"MetricSummaryPeriod","type":"object"},"Pagination":{"additionalProperties":false,"examples":[{"has_more":false,"limit":1,"offset":1,"total":1}],"properties":{"has_more":{"title":"Has More","type":"boolean"},"limit":{"minimum":1,"title":"Limit","type":"integer"},"offset":{"minimum":0,"title":"Offset","type":"integer"},"total":{"minimum":0,"title":"Total","type":"integer"}},"required":["total","limit","offset","has_more"],"title":"Pagination","type":"object"},"PlannerActionResult":{"additionalProperties":false,"examples":[{"status":"example"}],"properties":{"message":{"title":"Message","type":"string"},"runtime_run_id":{"title":"Runtime Run Id","type":"string"},"runtime_status":{"title":"Runtime Status","type":"string"},"status":{"title":"Status","type":"string"},"template_id":{"title":"Template Id","type":"string"},"version":{"title":"Version","type":"integer"},"workflow_definition_id":{"title":"Workflow Definition Id","type":"string"}},"required":["status"],"title":"PlannerActionResult","type":"object"},"PlannerAssistCreate":{"additionalProperties":false,"examples":[{"prompt":"example"}],"properties":{"current_code":{"title":"Current Code","type":"string"},"current_yaml":{"title":"Current Yaml","type":"string"},"editor_session_id":{"title":"Editor Session Id","type":"string"},"prompt":{"minLength":1,"title":"Prompt","type":"string"}},"required":["prompt"],"title":"PlannerAssistCreate","type":"object"},"PlannerBrowserSession":{"additionalProperties":false,"examples":[{"build_id":"build_example","control_mode":"human","step_number":1}],"properties":{"build_id":{"minLength":1,"title":"Build Id","type":"string"},"control_mode":{"enum":["human","shared"],"title":"Control Mode","type":"string"},"step_number":{"minimum":1,"title":"Step Number","type":"integer"},"vnc_control_url":{"format":"uri","minLength":1,"title":"Vnc Control Url","type":"string"},"vnc_control_url_expires_at":{"title":"Vnc Control Url Expires At","type":"number"},"vnc_url":{"format":"uri","minLength":1,"title":"Vnc Url","type":"string"},"vnc_url_expires_at":{"title":"Vnc Url Expires At","type":"number"}},"required":["build_id","step_number","control_mode"],"title":"PlannerBrowserSession","type":"object"},"PlannerBuild":{"additionalProperties":false,"examples":[{"build_id":"build_example","can_promote":false,"completed_at":"2026-01-15T12:00:00Z","created_at":"2026-01-15T12:00:00Z","current_step_number":1,"error_code":"example","last_event_cursor":1,"production_definition_id":"production_definition_example","state_version":1,"status":"example","updated_at":"2026-01-15T12:00:00Z"}],"properties":{"build_id":{"minLength":1,"title":"Build Id","type":"string"},"can_promote":{"title":"Can Promote","type":"boolean"},"completed_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Completed At"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"current_step_number":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"title":"Current Step Number"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"last_event_cursor":{"minimum":0,"title":"Last Event Cursor","type":"integer"},"planner_state":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Planner State","type":"object"},"production_definition_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Production Definition Id"},"state_version":{"minimum":1,"title":"State Version","type":"integer"},"status":{"title":"Status","type":"string"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["build_id","status","state_version","last_event_cursor","current_step_number","can_promote","error_code","production_definition_id","created_at","updated_at","completed_at"],"title":"PlannerBuild","type":"object"},"PlannerBuildCreate":{"additionalProperties":false,"examples":[{"request":"example"}],"properties":{"context":{"$ref":"#/components/schemas/PlannerBuildCreateContext","title":"Context"},"existing_yaml":{"title":"Existing Yaml","type":"string"},"modification_instructions":{"title":"Modification Instructions","type":"string"},"request":{"minLength":1,"title":"Request","type":"string"}},"required":["request"],"title":"PlannerBuildCreate","type":"object"},"PlannerBuildCreateContext":{"additionalProperties":false,"examples":[{"portal_url":"https://portal.example.com"}],"properties":{"credential_domain":{"title":"Credential Domain","type":"string"},"credential_id":{"title":"Credential Id","type":"string"},"inputs":{"items":{"additionalProperties":true,"type":"object"},"title":"Inputs","type":"array"},"outputs":{"items":{"additionalProperties":true,"type":"object"},"title":"Outputs","type":"array"},"portal_url":{"format":"uri","minLength":1,"title":"Portal Url","type":"string"},"recorded_task_id":{"title":"Recorded Task Id","type":"string"}},"title":"PlannerBuildCreateContext","type":"object"},"PlannerBuildList":{"additionalProperties":false,"examples":[{"data":[{"build_id":"build_example","can_promote":false,"completed_at":"2026-01-15T12:00:00Z","created_at":"2026-01-15T12:00:00Z","current_step_number":1,"error_code":"example","last_event_cursor":1,"production_definition_id":"production_definition_example","state_version":1,"status":"example","updated_at":"2026-01-15T12:00:00Z"}],"next_cursor":"example"}],"properties":{"data":{"items":{"$ref":"#/components/schemas/PlannerBuild"},"title":"Data","type":"array"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"required":["data","next_cursor"],"title":"PlannerBuildList","type":"object"},"PlannerCommand":{"additionalProperties":false,"examples":[{"build_id":"build_example","command_id":"command_example","expected_state_version":1,"kind":"example","runtime_run_id":"runtime_run_example","status":"queued","step_number":1}],"properties":{"accepted_state_version":{"deprecated":true,"description":"Compatibility hint only. Read the latest representation and reuse its quoted ETag for the next conditional mutation.","minimum":2,"title":"Accepted State Version","type":"integer"},"build_id":{"minLength":1,"title":"Build Id","type":"string"},"command_id":{"minLength":1,"title":"Command Id","type":"string"},"expected_state_version":{"minimum":1,"title":"Expected State Version","type":"integer"},"kind":{"title":"Kind","type":"string"},"runtime_run_id":{"minLength":1,"title":"Runtime Run Id","type":"string"},"status":{"const":"queued","title":"Status","type":"string"},"step_number":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"title":"Step Number"}},"required":["command_id","runtime_run_id","build_id","kind","step_number","status","expected_state_version"],"title":"PlannerCommand","type":"object"},"PlannerEvent":{"additionalProperties":false,"examples":[{"created_at":"2026-01-15T12:00:00Z","cursor":1,"data":{},"event":"example","schema_version":1}],"properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"cursor":{"minimum":1,"title":"Cursor","type":"integer"},"data":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Data","type":"object"},"event":{"title":"Event","type":"string"},"schema_version":{"minimum":1,"title":"Schema Version","type":"integer"}},"required":["cursor","event","schema_version","data","created_at"],"title":"PlannerEvent","type":"object"},"PlannerEventList":{"additionalProperties":false,"examples":[{"data":[{"created_at":"2026-01-15T12:00:00Z","cursor":1,"data":{},"event":"example","schema_version":1}],"has_more":false,"next_cursor":1}],"properties":{"data":{"items":{"$ref":"#/components/schemas/PlannerEvent"},"title":"Data","type":"array"},"has_more":{"title":"Has More","type":"boolean"},"next_cursor":{"minimum":0,"title":"Next Cursor","type":"integer"}},"required":["data","next_cursor","has_more"],"title":"PlannerEventList","type":"object"},"PlannerExport":{"additionalProperties":false,"examples":[{"status":"example"}],"properties":{"fixture_json":{"title":"Fixture Json","type":"string"},"status":{"title":"Status","type":"string"},"yaml_definition":{"title":"Yaml Definition","type":"string"}},"required":["status"],"title":"PlannerExport","type":"object"},"PlannerPromotionCreate":{"additionalProperties":false,"examples":[{"name":"Eligibility verification"}],"properties":{"description":{"title":"Description","type":"string"},"name":{"minLength":1,"title":"Name","type":"string"},"review":{"anyOf":[{"$ref":"#/components/schemas/PlannerPromotionCreateReview"},{"type":"null"}],"description":"Explicit routing for entity rows this workflow hands to a person. Omit it when the workflow produces no human-review queue.","title":"Review"}},"title":"PlannerPromotionCreate","type":"object"},"PlannerPromotionCreateReview":{"additionalProperties":false,"examples":[{"decisions":{"approve":"approved","reject":"rejected"},"item_id_prefix":"eligibility","pending_statuses":["waiting_for_review"]}],"properties":{"decisions":{"$ref":"#/components/schemas/PlannerPromotionCreateReviewDecisions"},"item_id_prefix":{"pattern":"^[A-Za-z0-9]+$","title":"Item Id Prefix","type":"string"},"pending_statuses":{"items":{"minLength":1,"pattern":"\\S","type":"string"},"minItems":1,"title":"Pending Statuses","type":"array","uniqueItems":true},"revisable_statuses":{"description":"Resolved statuses that may be reopened and must not overlap pending_statuses.","items":{"minLength":1,"pattern":"\\S","type":"string"},"title":"Revisable Statuses","type":"array","uniqueItems":true}},"required":["item_id_prefix","pending_statuses","decisions"],"title":"PlannerPromotionCreateReview","type":"object"},"PlannerPromotionCreateReviewDecisions":{"additionalProperties":false,"examples":[{"approve":"approved","reject":"rejected"}],"minProperties":1,"properties":{"approve":{"minLength":1,"pattern":"\\S","title":"Approve","type":"string"},"defer":{"minLength":1,"pattern":"\\S","title":"Defer","type":"string"},"reject":{"minLength":1,"pattern":"\\S","title":"Reject","type":"string"}},"title":"PlannerPromotionCreateReviewDecisions","type":"object"},"PlannerReviewRevision":{"additionalProperties":false,"examples":[{"revision_token":"example","workflow_instance_id":"workflow_instance_example"}],"properties":{"execution_id":{"description":"The execution that produced this item. Required so a revision is resolved within one run instead of the organization's whole decided history.","title":"Execution Id","type":"string"},"revision_token":{"description":"The revision_token returned when the state being reversed was written. If the item has moved on since - including moving away and back - the result is conflict and nothing is written.","title":"Revision Token","type":"string"},"workflow_instance_id":{"description":"The Planner workflow run that produced this item. Use this instead of execution_id for planner_workflow items.","title":"Workflow Instance Id","type":"string"}},"required":["workflow_instance_id","revision_token"],"title":"PlannerReviewRevision","type":"object"},"PlannerStepActionCreate":{"additionalProperties":false,"examples":[{"action":"ACCEPT","expected_state_version":1}],"properties":{"action":{"enum":["ACCEPT","REJECT","MESSAGE","RETRY","TEST"],"title":"Action","type":"string"},"comment":{"title":"Comment","type":"string"},"edited_code":{"title":"Edited Code","type":"string"},"edited_yaml_params":{"title":"Edited Yaml Params","type":"string"},"expected_state_version":{"minimum":1,"title":"Expected State Version","type":"integer"}},"required":["action","expected_state_version"],"title":"PlannerStepActionCreate","type":"object"},"PlannerTemplateCreate":{"additionalProperties":false,"examples":[{"name":"Daily eligibility check"}],"properties":{"category":{"title":"Category","type":"string"},"description":{"title":"Description","type":"string"},"name":{"title":"Name","type":"string"}},"title":"PlannerTemplateCreate","type":"object"},"PlannerWorkflowReviewItem":{"additionalProperties":false,"examples":[{"available_decisions":["approve"],"execution_status_url":"https://portal.example.com/resource","id":"id_example","item_type":"example","source":"planner_workflow","state":"waiting_for_review","waiting_since":"2026-01-15T12:00:00Z","workflow_definition_id":"workflow_definition_example","workflow_instance_id":"workflow_instance_example"}],"properties":{"agent_id":{"title":"Agent Id","type":"string"},"agent_version":{"title":"Agent Version","type":"string"},"available_decisions":{"items":{"enum":["approve","reject","defer"],"type":"string"},"title":"Available Decisions","type":"array"},"execution_id":{"title":"Execution Id","type":"string"},"execution_status_url":{"title":"Execution Status Url","type":"string"},"id":{"title":"Id","type":"string"},"installation_id":{"title":"Installation Id","type":"string"},"item_type":{"title":"Item Type","type":"string"},"revision_token":{"title":"Revision Token","type":"string"},"source":{"const":"planner_workflow","title":"Source","type":"string"},"state":{"enum":["waiting_for_review","resolved"],"title":"State","type":"string"},"summary":{"additionalProperties":{"type":"string"},"title":"Summary","type":"object"},"waiting_since":{"format":"date-time","title":"Waiting Since","type":"string"},"workflow_definition_id":{"title":"Workflow Definition Id","type":"string"},"workflow_instance_id":{"title":"Workflow Instance Id","type":"string"}},"required":["id","source","workflow_definition_id","workflow_instance_id","item_type","state","available_decisions","waiting_since","execution_status_url"],"title":"PlannerWorkflowReviewItem","type":"object"},"PublicResourceError":{"additionalProperties":false,"examples":[{"code":"INVALID_REQUEST","message":"Request accepted."}],"properties":{"code":{"title":"Code","type":"string"},"message":{"title":"Message","type":"string"},"retryable":{"title":"Retryable","type":"boolean"}},"required":["code","message"],"title":"PublicResourceError","type":"object"},"QueueDesign":{"additionalProperties":false,"examples":[{"design_session_id":"design_session_example","id":"qds_example","live_url":"https://portal.example.com/resource","review_url":"https://portal.example.com/resource","status":"example","title":"example","workflow_definition_id":"workflow_definition_example"}],"properties":{"current_version":{"anyOf":[{"$ref":"#/components/schemas/QueueDesignVersion"},{"type":"null"}],"default":null},"design_session_id":{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Design Session Id","type":"string"},"id":{"maxLength":200,"pattern":"^qds_[A-Za-z0-9_-]+$","title":"Id","type":"string"},"live_url":{"maxLength":2048,"title":"Live Url","type":"string"},"publication":{"anyOf":[{"additionalProperties":true,"maxProperties":64,"type":"object"},{"type":"null"}],"default":null,"title":"Publication"},"review_url":{"maxLength":2048,"title":"Review Url","type":"string"},"run":{"anyOf":[{"$ref":"#/components/schemas/QueueDesignRun"},{"type":"null"}],"default":null},"status":{"maxLength":80,"minLength":1,"title":"Status","type":"string"},"title":{"maxLength":500,"title":"Title","type":"string"},"workflow_definition_id":{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Workflow Definition Id","type":"string"}},"required":["id","workflow_definition_id","title","status","design_session_id","review_url","live_url"],"title":"QueueDesign","type":"object"},"QueueDesignApprove":{"additionalProperties":false,"examples":[{"expected_live_version_id":"expected_live_version_example","resolved_yaml_hash":"aaaaaaaaaaaaaaaa","version_id":"version_example"}],"properties":{"expected_live_version_id":{"anyOf":[{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},{"type":"null"}],"description":"Current publication.live_version_id (a publication receipt ID), or explicit null before first publication. A stale value conflicts without approving.","title":"Expected Live Version Id"},"resolved_yaml_hash":{"description":"Exact 16-character lowercase resolved_yaml_hash returned for that design version (the existing truncated SHA-256 content hash). System approval is recorded separately from human review and does not publish.","maxLength":16,"minLength":16,"pattern":"^[0-9a-f]{16}$","title":"Resolved Yaml Hash","type":"string"},"version_id":{"description":"Exact immutable design version to approve with a system API key.","maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Version Id","type":"string"}},"required":["version_id","resolved_yaml_hash","expected_live_version_id"],"title":"QueueDesignApprove","type":"object"},"QueueDesignCancel":{"additionalProperties":false,"examples":[{"run_id":"run_example"}],"properties":{"run_id":{"anyOf":[{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},{"type":"null"}],"default":null,"title":"Run Id"}},"title":"QueueDesignCancel","type":"object"},"QueueDesignCreate":{"additionalProperties":false,"examples":[{"prompt":"example","workflow_definition_id":"workflow_definition_example"}],"properties":{"prompt":{"maxLength":20000,"minLength":1,"pattern":"\\S","title":"Prompt","type":"string"},"workflow_definition_id":{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Workflow Definition Id","type":"string"}},"required":["workflow_definition_id","prompt"],"title":"QueueDesignCreate","type":"object"},"QueueDesignEvent":{"additionalProperties":false,"examples":[{"data":{},"run_id":"run_example","seq":1,"type":"example"}],"properties":{"created_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Created At"},"data":{"additionalProperties":true,"maxProperties":64,"title":"Data","type":"object"},"run_id":{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Run Id","type":"string"},"seq":{"minimum":1,"title":"Seq","type":"integer"},"type":{"maxLength":100,"minLength":1,"title":"Type","type":"string"}},"required":["seq","run_id","type","data"],"title":"QueueDesignEvent","type":"object"},"QueueDesignEventList":{"additionalProperties":false,"examples":[{"data":[{"data":{},"run_id":"run_example","seq":1,"type":"example"}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/QueueDesignEvent"},"maxItems":100,"title":"Data","type":"array"},"next_cursor":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"title":"Next Cursor"}},"required":["data"],"title":"QueueDesignEventList","type":"object"},"QueueDesignList":{"additionalProperties":false,"examples":[{"data":[{"design_session_id":"design_session_example","id":"qds_example","live_url":"https://portal.example.com/resource","review_url":"https://portal.example.com/resource","status":"example","title":"example","workflow_definition_id":"workflow_definition_example"}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/QueueDesign"},"maxItems":100,"title":"Data","type":"array"},"next_cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"title":"Next Cursor"}},"required":["data"],"title":"QueueDesignList","type":"object"},"QueueDesignMessageCreate":{"additionalProperties":false,"examples":[{"prompt":"example"}],"properties":{"prompt":{"maxLength":20000,"minLength":1,"pattern":"\\S","title":"Prompt","type":"string"}},"required":["prompt"],"title":"QueueDesignMessageCreate","type":"object"},"QueueDesignPublish":{"additionalProperties":false,"examples":[{"expected_live_version_id":"expected_live_version_example","version_id":"version_example"}],"properties":{"expected_live_version_id":{"anyOf":[{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},{"type":"null"}],"description":"Current publication.live_version_id (a publication receipt ID), or explicit null before first publication. A stale value is a conflict.","title":"Expected Live Version Id"},"version_id":{"description":"Exact approved design version ID, not its ordinal or a publication receipt. Approval may come from human web review or an authorized system key. Closed sessions cannot publish.","maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Version Id","type":"string"}},"required":["version_id","expected_live_version_id"],"title":"QueueDesignPublish","type":"object"},"QueueDesignRollback":{"additionalProperties":false,"examples":[{"expected_live_version_id":"expected_live_version_example","to_version_id":"to_version_example"}],"properties":{"expected_live_version_id":{"anyOf":[{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},{"type":"null"}],"description":"Current publication.live_version_id (a publication receipt ID). Required, nullable only when no publication exists.","title":"Expected Live Version Id"},"to_version_id":{"description":"Publication receipt ID from publication.history or publication.baseline_version_id, not a design version ID. Rollback remains available after session cleanup.","maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"To Version Id","type":"string"}},"required":["to_version_id","expected_live_version_id"],"title":"QueueDesignRollback","type":"object"},"QueueDesignRun":{"additionalProperties":false,"examples":[{"id":"id_example","status":"example"}],"properties":{"id":{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Id","type":"string"},"status":{"maxLength":80,"minLength":1,"title":"Status","type":"string"}},"required":["id","status"],"title":"QueueDesignRun","type":"object"},"QueueDesignTarget":{"additionalProperties":false,"examples":[{"live_url":"https://portal.example.com/resource","title":"example","workflow_definition_id":"workflow_definition_example"}],"properties":{"live_url":{"maxLength":2048,"title":"Live Url","type":"string"},"live_version_id":{"anyOf":[{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},{"type":"null"}],"default":null,"title":"Live Version Id"},"title":{"maxLength":500,"title":"Title","type":"string"},"workflow_definition_id":{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Workflow Definition Id","type":"string"}},"required":["workflow_definition_id","title","live_url"],"title":"QueueDesignTarget","type":"object"},"QueueDesignTargetList":{"additionalProperties":false,"examples":[{"data":[{"live_url":"https://portal.example.com/resource","title":"example","workflow_definition_id":"workflow_definition_example"}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/QueueDesignTarget"},"maxItems":100,"title":"Data","type":"array"},"next_cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"title":"Next Cursor"}},"required":["data"],"title":"QueueDesignTargetList","type":"object"},"QueueDesignVersion":{"additionalProperties":false,"examples":[{"id":"id_example","preview_urls":["https://portal.example.com/resource"],"requires_frontend_change":false,"resolved_yaml_hash":"aaaaaaaaaaaaaaaa","session_id":"qds_example","state":"example","validation":{},"version":1}],"properties":{"approval_actor_type":{"anyOf":[{"enum":["HUMAN","SYSTEM"],"type":"string"},{"type":"null"}],"default":null,"description":"Persisted approval identity, never inferred from the current caller or key creator. Null means no attributed approval is exposed.","title":"Approval Actor Type"},"approved_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"default":null,"title":"Approved At"},"approved_by_credential_id":{"anyOf":[{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},{"type":"null"}],"default":null,"title":"Approved By Credential Id"},"approved_by_service_principal_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Approved By Service Principal Id"},"approved_by_user_id":{"anyOf":[{"maxLength":200,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"title":"Approved By User Id"},"approved_resolved_yaml_hash":{"anyOf":[{"maxLength":16,"minLength":16,"pattern":"^[0-9a-f]{16}$","type":"string"},{"type":"null"}],"default":null,"title":"Approved Resolved Yaml Hash"},"id":{"maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Id","type":"string"},"preview_urls":{"items":{"maxLength":2048,"type":"string"},"maxItems":10,"title":"Preview Urls","type":"array"},"requires_frontend_change":{"title":"Requires Frontend Change","type":"boolean"},"resolved_yaml_hash":{"anyOf":[{"maxLength":16,"minLength":16,"pattern":"^[0-9a-f]{16}$","type":"string"},{"type":"null"}],"title":"Resolved Yaml Hash"},"session_id":{"maxLength":200,"pattern":"^qds_[A-Za-z0-9_-]+$","title":"Session Id","type":"string"},"state":{"maxLength":80,"minLength":1,"title":"State","type":"string"},"validation":{"additionalProperties":true,"maxProperties":64,"title":"Validation","type":"object"},"version":{"minimum":1,"title":"Version","type":"integer"}},"required":["id","session_id","version","state","resolved_yaml_hash","requires_frontend_change","validation","preview_urls"],"title":"QueueDesignVersion","type":"object"},"QueueDesignVersionList":{"additionalProperties":false,"examples":[{"data":[{"id":"id_example","preview_urls":["https://portal.example.com/resource"],"requires_frontend_change":false,"resolved_yaml_hash":"aaaaaaaaaaaaaaaa","session_id":"qds_example","state":"example","validation":{},"version":1}]}],"properties":{"data":{"items":{"$ref":"#/components/schemas/QueueDesignVersion"},"maxItems":100,"title":"Data","type":"array"},"next_cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"title":"Next Cursor"}},"required":["data"],"title":"QueueDesignVersionList","type":"object"},"ReviewDecisionCreate":{"additionalProperties":false,"examples":[{"decision":"approve","item_ids":["example"]}],"if":{"properties":{"revise":{}},"required":["revise"]},"properties":{"decision":{"description":"Which decisions an item accepts depends on its agent version; an unsupported one reports decision_not_supported for that item rather than failing the batch.","enum":["approve","reject","defer"],"title":"Decision","type":"string"},"item_ids":{"description":"Review item ids from a listing or an execution result. Exactly one id is allowed when revise is present, since a revision token describes one row.","items":{"type":"string"},"maxItems":200,"minItems":1,"title":"Item Ids","type":"array"},"note":{"description":"Optional audit note stored with the decision.","maxLength":2000,"title":"Note","type":"string"},"revise":{"anyOf":[{"$ref":"#/components/schemas/AgentReviewRevision"},{"$ref":"#/components/schemas/PlannerReviewRevision"}],"description":"Reopen one already-resolved item. Requires the review_items:revise scope, which is not granted by default. Deliberately one item at a time: the revision token describes one row's exact state and cannot speak for a batch.","title":"Revise"}},"required":["item_ids","decision"],"then":{"properties":{"item_ids":{"maxItems":1}}},"title":"ReviewDecisionCreate","type":"object"},"ReviewDecisionOutcome":{"additionalProperties":false,"examples":[{"applied":false,"id":"id_example"}],"properties":{"applied":{"title":"Applied","type":"boolean"},"decision":{"title":"Decision","type":"string"},"id":{"title":"Id","type":"string"},"reason":{"description":"Why this id was not applied. conflict means the item changed between being read and being written \u2014 re-read it and decide again. not_revisable means the item is resolved and its agent does not allow reopening that status. write_failed means the write itself did not complete; the item is unchanged and retrying is safe.","enum":["not_found","decision_not_supported","not_revisable","conflict","write_failed"],"title":"Reason","type":"string"},"revision_token":{"description":"Present when applied. Pass it back in revise to reverse this exact decision later; it is the only way to obtain one, since listings withhold internal status and a resolved item leaves the listing.","title":"Revision Token","type":"string"},"still_waiting":{"description":"The item remains open after this decision, as deferring does.","title":"Still Waiting","type":"boolean"}},"required":["id","applied"],"title":"ReviewDecisionOutcome","type":"object"},"ReviewDecisionResult":{"additionalProperties":false,"examples":[{"applied_count":1,"decision":"example","failed_count":1,"results":[{"applied":false,"id":"id_example"}]}],"properties":{"applied_count":{"minimum":0,"title":"Applied Count","type":"integer"},"decision":{"title":"Decision","type":"string"},"failed_count":{"minimum":0,"title":"Failed Count","type":"integer"},"results":{"description":"One entry per requested id, in request order. Each reflects what the write actually did.","items":{"$ref":"#/components/schemas/ReviewDecisionOutcome"},"title":"Results","type":"array"}},"required":["decision","applied_count","failed_count","results"],"title":"ReviewDecisionResult","type":"object"},"ReviewItem":{"examples":[{"agent_id":"agent_example","agent_version":"1.0.0","available_decisions":["approve"],"execution_id":"execution_example","execution_status_url":"https://portal.example.com/resource","id":"id_example","installation_id":"installation_example","item_type":"example","source":"agent","state":"waiting_for_review","waiting_since":"2026-01-15T12:00:00Z"}],"oneOf":[{"$ref":"#/components/schemas/CatalogAgentReviewItem"},{"$ref":"#/components/schemas/PlannerWorkflowReviewItem"}],"title":"ReviewItem"},"ReviewItemList":{"additionalProperties":false,"examples":[{"data":[{"agent_id":"agent_example","agent_version":"1.0.0","available_decisions":["approve"],"execution_id":"execution_example","execution_status_url":"https://portal.example.com/resource","id":"id_example","installation_id":"installation_example","item_type":"example","source":"agent","state":"waiting_for_review","waiting_since":"2026-01-15T12:00:00Z"}],"pagination":{"has_more":false,"limit":1,"offset":1,"total":1}}],"properties":{"data":{"items":{"$ref":"#/components/schemas/ReviewItem"},"title":"Data","type":"array"},"pagination":{"$ref":"#/components/schemas/ReviewItemListPagination"}},"required":["data","pagination"],"title":"ReviewItemList","type":"object"},"ReviewItemListPagination":{"additionalProperties":false,"examples":[{"has_more":false,"limit":1,"offset":1,"total":1}],"properties":{"has_more":{"title":"Has More","type":"boolean"},"limit":{"minimum":1,"title":"Limit","type":"integer"},"offset":{"minimum":0,"title":"Offset","type":"integer"},"total":{"minimum":0,"title":"Total","type":"integer"}},"required":["total","limit","offset","has_more"],"title":"ReviewItemListPagination","type":"object"},"Schedule":{"additionalProperties":false,"examples":[{"action_count":1,"cron_expression":"example","id":"id_example","last_action_at":"2026-01-15T12:00:00Z","next_action_at":"2026-01-15T12:00:00Z","note":"example","overlap_policy":"BUFFER_ALL","recent_actions":[{"scheduled_at":"2026-01-15T12:00:00Z","started_at":"2026-01-15T12:00:00Z","workflow_instance_id":"workflow_instance_example"}],"skipped_overlap_count":1,"status":"active","workflow_definition_id":"workflow_definition_example","workflow_definition_name":"example"}],"properties":{"action_count":{"minimum":0,"title":"Action Count","type":"integer"},"cron_expression":{"title":"Cron Expression","type":"string"},"id":{"minLength":1,"title":"Id","type":"string"},"last_action_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Last Action At"},"next_action_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Next Action At"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"overlap_policy":{"enum":["BUFFER_ALL","ALLOW_ALL","SKIP","CANCEL_OTHER","TERMINATE_OTHER"],"title":"Overlap Policy","type":"string"},"recent_actions":{"items":{"$ref":"#/components/schemas/ScheduleRecentAction"},"title":"Recent Actions","type":"array"},"skipped_overlap_count":{"minimum":0,"title":"Skipped Overlap Count","type":"integer"},"status":{"enum":["active","paused"],"title":"Status","type":"string"},"workflow_definition_id":{"minLength":1,"title":"Workflow Definition Id","type":"string"},"workflow_definition_name":{"title":"Workflow Definition Name","type":"string"}},"required":["id","workflow_definition_id","workflow_definition_name","cron_expression","overlap_policy","status","note","next_action_at","last_action_at","action_count","skipped_overlap_count","recent_actions"],"title":"Schedule","type":"object"},"ScheduleCommandResult":{"additionalProperties":false,"examples":[{"status":"paused","workflow_definition_id":"workflow_definition_example"}],"properties":{"status":{"enum":["paused","active","triggered","accepted","deleted"],"title":"Status","type":"string"},"workflow_definition_id":{"minLength":1,"title":"Workflow Definition Id","type":"string"},"workflow_instance_id":{"title":"Workflow Instance Id","type":"string"}},"required":["workflow_definition_id","status"],"title":"ScheduleCommandResult","type":"object"},"ScheduleCreate":{"additionalProperties":false,"examples":[{"cron_expression":"example"}],"properties":{"cron_expression":{"minLength":1,"title":"Cron Expression","type":"string"},"input":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Input","type":"object"},"note":{"title":"Note","type":"string"},"overlap_policy":{"enum":["BUFFER_ALL","ALLOW_ALL","SKIP","CANCEL_OTHER","TERMINATE_OTHER"],"title":"Overlap Policy","type":"string"}},"required":["cron_expression"],"title":"ScheduleCreate","type":"object"},"ScheduleList":{"additionalProperties":false,"examples":[{"data":[{"action_count":1,"cron_expression":"example","id":"id_example","last_action_at":"2026-01-15T12:00:00Z","next_action_at":"2026-01-15T12:00:00Z","note":"example","overlap_policy":"BUFFER_ALL","recent_actions":[{"scheduled_at":"2026-01-15T12:00:00Z","started_at":"2026-01-15T12:00:00Z","workflow_instance_id":"workflow_instance_example"}],"skipped_overlap_count":1,"status":"active","workflow_definition_id":"workflow_definition_example","workflow_definition_name":"example"}],"pagination":{"has_more":false,"limit":1,"offset":1,"total":1}}],"properties":{"data":{"items":{"$ref":"#/components/schemas/Schedule"},"title":"Data","type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"],"title":"ScheduleList","type":"object"},"ScheduleNote":{"additionalProperties":false,"examples":[{"note":"Paused during portal maintenance."}],"properties":{"note":{"title":"Note","type":"string"}},"title":"ScheduleNote","type":"object"},"ScheduleRecentAction":{"additionalProperties":false,"examples":[{"scheduled_at":"2026-01-15T12:00:00Z","started_at":"2026-01-15T12:00:00Z","workflow_instance_id":"workflow_instance_example"}],"properties":{"scheduled_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Scheduled At"},"started_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Started At"},"workflow_instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Instance Id"}},"required":["scheduled_at","started_at","workflow_instance_id"],"title":"ScheduleRecentAction","type":"object"},"ScheduleTriggerCreate":{"additionalProperties":false,"examples":[{"overlap_policy":"SKIP"}],"properties":{"overlap_policy":{"enum":["BUFFER_ALL","ALLOW_ALL","SKIP","CANCEL_OTHER","TERMINATE_OTHER"],"title":"Overlap Policy","type":"string"}},"title":"ScheduleTriggerCreate","type":"object"},"ScheduleUpdate":{"additionalProperties":false,"examples":[{"cron_expression":"0 9 * * 1-5"}],"properties":{"cron_expression":{"minLength":1,"title":"Cron Expression","type":"string"},"input":{"additionalProperties":true,"description":"Fields are defined by the referenced published or generated schema.","title":"Input","type":"object"},"note":{"title":"Note","type":"string"},"overlap_policy":{"enum":["BUFFER_ALL","ALLOW_ALL","SKIP","CANCEL_OTHER","TERMINATE_OTHER"],"title":"Overlap Policy","type":"string"}},"title":"ScheduleUpdate","type":"object"},"SmsInbox":{"additionalProperties":false,"examples":[{"created":false,"message":"Request accepted.","phone_number":"+14155550123","provider":"voip","provider_managed":false,"status":"active"}],"properties":{"created":{"description":"True only when this request purchased the number.","title":"Created","type":"boolean"},"message":{"title":"Message","type":"string"},"phone_number":{"description":"Organization default number in E.164 format.","pattern":"^\\+[1-9][0-9]{7,14}$","title":"Phone Number","type":"string"},"provider":{"const":"voip","description":"Provider-neutral number type. Vendor details are managed by XY.","title":"Provider","type":"string"},"provider_managed":{"title":"Provider Managed","type":"boolean"},"status":{"enum":["active","external"],"title":"Status","type":"string"}},"required":["phone_number","provider","provider_managed","status","created","message"],"title":"SmsInbox","type":"object"},"SmsInboxMessage":{"additionalProperties":false,"examples":[{"body":"example","from_number":"+14155550123","id":"id_example","received_at_ms":1,"to_number":"+14155550123"}],"properties":{"body":{"description":"Sensitive inbound message body. Do not log or persist it unnecessarily.","title":"Body","type":"string"},"from_number":{"title":"From Number","type":"string"},"id":{"description":"Opaque provider message identifier.","title":"Id","type":"string"},"received_at_ms":{"description":"Provider receive time as Unix milliseconds.","minimum":0,"title":"Received At Ms","type":"integer"},"to_number":{"pattern":"^\\+[1-9][0-9]{7,14}$","title":"To Number","type":"string"}},"required":["id","from_number","to_number","body","received_at_ms"],"title":"SmsInboxMessage","type":"object"},"SmsInboxMessages":{"additionalProperties":false,"examples":[{"messages":[{"body":"example","from_number":"+14155550123","id":"id_example","received_at_ms":1,"to_number":"+14155550123"}],"phone_number":"+14155550123","provider":"voip"}],"properties":{"messages":{"description":"Matching messages ordered newest first.","items":{"$ref":"#/components/schemas/SmsInboxMessage"},"maxItems":50,"title":"Messages","type":"array"},"phone_number":{"pattern":"^\\+[1-9][0-9]{7,14}$","title":"Phone Number","type":"string"},"provider":{"const":"voip","title":"Provider","type":"string"}},"required":["phone_number","provider","messages"],"title":"SmsInboxMessages","type":"object"},"SmsInboxProvisionRequest":{"additionalProperties":false,"examples":[{"area_code":"415","country_code":"US"}],"properties":{"area_code":{"description":"Optional preferred three-digit area code. Availability is provider-dependent.","pattern":"^[0-9]{3}$","title":"Area Code","type":"string"},"country_code":{"const":"US","default":"US","description":"Country for the dedicated number. The first release supports US numbers.","title":"Country Code","type":"string"}},"title":"SmsInboxProvisionRequest","type":"object"},"UsageSummary":{"additionalProperties":false,"examples":[{"limits":{"max_active_browser_sessions":1,"max_active_builds":1,"max_active_factory_runs":1,"max_build_starts_per_day":1,"max_factory_starts_per_day":1},"period":{"day_start":"2026-01-15T12:00:00Z"},"usage":{"active_browser_sessions":1,"active_builds":1,"active_factory_runs":1,"build_starts_today":1,"factory_starts_today":1}}],"properties":{"limits":{"$ref":"#/components/schemas/UsageSummaryLimits"},"period":{"$ref":"#/components/schemas/UsageSummaryPeriod"},"usage":{"$ref":"#/components/schemas/UsageSummaryUsage"}},"required":["period","limits","usage"],"title":"UsageSummary","type":"object"},"UsageSummaryLimits":{"additionalProperties":false,"examples":[{"max_active_browser_sessions":1,"max_active_builds":1,"max_active_factory_runs":1,"max_build_starts_per_day":1,"max_factory_starts_per_day":1}],"properties":{"max_active_browser_sessions":{"minimum":0,"title":"Max Active Browser Sessions","type":"integer"},"max_active_builds":{"minimum":0,"title":"Max Active Builds","type":"integer"},"max_active_factory_runs":{"minimum":0,"title":"Max Active Factory Runs","type":"integer"},"max_build_starts_per_day":{"minimum":0,"title":"Max Build Starts Per Day","type":"integer"},"max_factory_starts_per_day":{"minimum":0,"title":"Max Factory Starts Per Day","type":"integer"}},"required":["max_active_builds","max_build_starts_per_day","max_active_browser_sessions","max_active_factory_runs","max_factory_starts_per_day"],"title":"UsageSummaryLimits","type":"object"},"UsageSummaryPeriod":{"additionalProperties":false,"examples":[{"day_start":"2026-01-15T12:00:00Z"}],"properties":{"day_start":{"format":"date-time","title":"Day Start","type":"string"}},"required":["day_start"],"title":"UsageSummaryPeriod","type":"object"},"UsageSummaryUsage":{"additionalProperties":false,"examples":[{"active_browser_sessions":1,"active_builds":1,"active_factory_runs":1,"build_starts_today":1,"factory_starts_today":1}],"properties":{"active_browser_sessions":{"title":"Active Browser Sessions","type":"integer"},"active_builds":{"title":"Active Builds","type":"integer"},"active_factory_runs":{"title":"Active Factory Runs","type":"integer"},"build_starts_today":{"title":"Build Starts Today","type":"integer"},"factory_starts_today":{"title":"Factory Starts Today","type":"integer"}},"required":["active_builds","build_starts_today","active_browser_sessions","active_factory_runs","factory_starts_today"],"title":"UsageSummaryUsage","type":"object"},"WorkflowExecution":{"additionalProperties":false,"examples":[{"status":"example","status_url":"https://portal.example.com/resource","workflow_definition_id":"workflow_definition_example","workflow_instance_id":"workflow_instance_example"}],"properties":{"status":{"description":"Accepted runtime state, or the current durable state on an idempotent replay.","examples":["running"],"title":"Status","type":"string"},"status_url":{"description":"Relative URL for safe activity-phase status.","title":"Status Url","type":"string"},"workflow_definition_id":{"title":"Workflow Definition Id","type":"string"},"workflow_instance_id":{"title":"Workflow Instance Id","type":"string"}},"required":["workflow_definition_id","workflow_instance_id","status","status_url"],"title":"WorkflowExecution","type":"object"},"WorkflowExecutionCreate":{"additionalProperties":false,"examples":[{"input":{"record_id":"record_example"}}],"properties":{"input":{"additionalProperties":true,"default":{},"description":"Runtime input for this run. Omit it to use the definition's input template.","title":"Input","type":"object"}},"title":"WorkflowExecutionCreate","type":"object"},"WorkflowPhase":{"additionalProperties":false,"examples":[{"activity":"example","number":1,"recorded_at":"2026-01-15T12:00:00Z","status":"example"}],"properties":{"activity":{"title":"Activity","type":"string"},"child_workflow_id":{"title":"Child Workflow Id","type":"string"},"error_type":{"title":"Error Type","type":"string"},"event_id":{"title":"Event Id","type":"integer"},"number":{"minimum":1,"title":"Number","type":"integer"},"recorded_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Recorded At"},"status":{"title":"Status","type":"string"}},"required":["number","activity","status","recorded_at"],"title":"WorkflowPhase","type":"object"},"WorkflowPhaseProjection":{"additionalProperties":false,"examples":[{"child_workflows":{"failed":1,"succeeded":1},"current_phase":{"activity":"example","number":1,"recorded_at":"2026-01-15T12:00:00Z","status":"example"},"execution_status":"example","phases":[{"activity":"example","number":1,"recorded_at":"2026-01-15T12:00:00Z","status":"example"}],"workflow_instance_id":"workflow_instance_example","workflow_status":"example"}],"properties":{"child_workflows":{"$ref":"#/components/schemas/ChildWorkflowSummary"},"current_phase":{"anyOf":[{"$ref":"#/components/schemas/WorkflowPhase"},{"type":"null"}]},"execution_id":{"title":"Execution Id","type":"string"},"execution_status":{"title":"Execution Status","type":"string"},"phases":{"items":{"$ref":"#/components/schemas/WorkflowPhase"},"title":"Phases","type":"array"},"workflow_definition_id":{"title":"Workflow Definition Id","type":"string"},"workflow_error_type":{"title":"Workflow Error Type","type":"string"},"workflow_instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Instance Id"},"workflow_status":{"title":"Workflow Status","type":"string"}},"required":["workflow_instance_id","workflow_status","execution_status","current_phase","phases","child_workflows"],"title":"WorkflowPhaseProjection","type":"object"}},"securitySchemes":{"bearerAuth":{"bearerFormat":"XY API key","description":"Paste the complete organization-scoped key returned by XY. Queue UI read/write/publish support personal or service keys; queue_ui:approve requires a service key. MCP OAuth credentials are forwarded by the trusted MCP service, not pasted here as ordinary REST keys.","scheme":"bearer","type":"http"}}},"info":{"contact":{"name":"XY support","url":"https://www.xy.ai/contact"},"description":"Build organization-scoped integrations with XY agents, workflows, and governed operations. Create an API key in **XY \u2192 Organization settings \u2192 API Keys**, then select **Authorize** and enter the full bearer value. Keys are environment-bound and responses never expose stored secrets.\n\nStart with `GET /api/v1/auth/check`, then discover agents with `GET /api/v1/agents`. Use `Idempotency-Key` where documented, retaining the same key and body when recovering an operation. Inspect durable state after an ambiguous response; do not blindly replay mutations.\n\nQueue UI Designer uses explicitly selected `queue_ui:read`, `queue_ui:write`, and `queue_ui:publish` scopes on personal or service credentials. Sensitive `queue_ui:approve` requires a service/system API key and is excluded from OAuth. These are public, not STAFF-only scopes. Delegated ceilings, designer capability, resource permissions, exact human or system approval, and publication's independent scope and live-receipt comparison remain separate checks.","title":"XY Developer API","version":"1.3.0"},"openapi":"3.1.0","paths":{"/api/v1/agent-requests":{"post":{"description":"Create an organization-scoped draft and receive a hosted form URL. Send the partner to that form to complete and submit the specification before XY reviews it.\n\n**Required scope:** `agent_requests:write`","operationId":"createAgentRequest","parameters":[{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRequestCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRequest"}}},"description":"The custom-agent request draft and its hosted partner form were created.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"Link":{"description":"Hosted partner form URL with rel=\"form\".","schema":{"type":"string"}},"Location":{"description":"Relative URL of the accepted request.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"example":5,"type":"integer"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Create a hosted request draft","tags":["Custom agent requests"]}},"/api/v1/agent-requests/{request_id}":{"get":{"description":"Read the original specification, public delivery state, conversation history, and resulting published agent identity when available.\n\n**Required scope:** `agent_requests:read`","operationId":"getAgentRequest","parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRequest"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get an agent request","tags":["Custom agent requests"]}},"/api/v1/agent-requests/{request_id}/messages":{"post":{"description":"Answer an XY clarification or add context. A reply to needs_information returns the request to in_progress; terminal requests reject new messages.\n\n**Required scope:** `agent_requests:write`","operationId":"createAgentRequestMessage","parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRequestMessageCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRequestMessage"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Add a request message","tags":["Custom agent requests"]}},"/api/v1/agents":{"get":{"description":"List the published agents available to this organization.\n\n**Required scope:** `agents:read`","operationId":"listAgents","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List available agents","tags":["Agent catalog"]}},"/api/v1/agents/{agent_id}":{"get":{"description":"Read one agent and the versions available to install.\n\n**Required scope:** `agents:read`","operationId":"getAgent","parameters":[{"in":"path","name":"agent_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get an agent","tags":["Agent catalog"]}},"/api/v1/agents/{agent_id}/installations":{"post":{"description":"Create an organization-scoped installation of an exact agent version.\n\n**Required scope:** `installations:write`","operationId":"createInstallation","parameters":[{"in":"path","name":"agent_id","required":true,"schema":{"type":"string"}},{"description":"Exact semantic version to install.","in":"query","name":"agent_version","required":false,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallationCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Installation"}}},"description":"The resource was created directly in a terminal failed state; no polling retry is needed.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Installation"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Install an agent","tags":["Installations"]}},"/api/v1/agents/{agent_id}/metrics":{"get":{"description":"Query governed metrics for one published agent over an optional time window.\n\n**Required scope:** `metrics:read`","operationId":"getAgentMetrics","parameters":[{"in":"path","name":"agent_id","required":true,"schema":{"type":"string"}},{"description":"Inclusive ISO-8601 start time.","in":"query","name":"from","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Exclusive ISO-8601 end time.","in":"query","name":"to","required":false,"schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricSummary"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get agent metrics","tags":["Analytics"]}},"/api/v1/agents/{agent_id}/metrics/dashboards":{"get":{"description":"List approved presentation-ready metric views available for an agent.\n\n**Required scope:** `metrics:read`","operationId":"listAgentMetricDashboards","parameters":[{"in":"path","name":"agent_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricDashboardList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List agent metric views","tags":["Analytics"]}},"/api/v1/agents/{agent_id}/metrics/dashboards/{dashboard_id}":{"get":{"description":"Return visualization metadata and aliased tile data that a partner can render in its own UI.\n\n**Required scope:** `metrics:read`","operationId":"renderAgentMetricDashboard","parameters":[{"in":"path","name":"agent_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"dashboard_id","required":true,"schema":{"type":"string"}},{"description":"Inclusive ISO-8601 start time.","in":"query","name":"from","required":false,"schema":{"format":"date","type":"string"}},{"description":"Exclusive ISO-8601 end time.","in":"query","name":"to","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricDashboard"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get an agent metric view","tags":["Analytics"]}},"/api/v1/auth/check":{"get":{"description":"Verify the bearer key and return its environment and granted scopes without exposing organization or secret data.","operationId":"checkAuthentication","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthCheck"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Check an API key","tags":["Authentication"]}},"/api/v1/browser/sessions":{"post":{"description":"Create a retained authoring session for one Planner browser step.\n\n**Required scope:** `browser:write`","operationId":"createBrowserSession","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserSessionCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserSession"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Create a browser session","tags":["Browser Studio"]}},"/api/v1/browser/sessions/{session_id}":{"delete":{"description":"Close a retained authoring session and release its browser capacity.\n\n**Required scope:** `browser:write`","operationId":"closeBrowserSession","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserPromptCancelResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Close a browser session","tags":["Browser Studio"]},"get":{"description":"Read session state and refresh its short-lived viewer link.\n\n**Required scope:** `browser:read`","operationId":"getBrowserSession","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserSession"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a browser session","tags":["Browser Studio"]}},"/api/v1/browser/sessions/{session_id}/apply":{"post":{"description":"Return the current draft to its Planner step for testing and review.\n\n**Required scope:** `browser:write + planner:write`","operationId":"applyBrowserDraft","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserDraftApply"}}},"required":false},"responses":{"200":{"content":{"text/event-stream":{"example":"id: 17\nevent: status\ndata: {\"status\":\"running\"}\n\n","schema":{"type":"string"}}},"description":"A server-sent event stream. Reconnect with Last-Event-ID or the documented durable cursor.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Apply a browser draft","tags":["Browser Studio"]}},"/api/v1/browser/sessions/{session_id}/cdp":{"post":{"description":"Run a raw Chrome DevTools Protocol command. This privileged surface can inspect authenticated browser state.\n\n**Required scope:** `browser:debug`","operationId":"runBrowserCdpCommand","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserCdpCreate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserCdpResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Run a CDP command","tags":["Browser Studio"]}},"/api/v1/browser/sessions/{session_id}/commands":{"post":{"description":"Run a deployed Studio command, including endpoint observation and API-map tools.\n\n**Required scope:** `browser:write`","operationId":"runBrowserCommand","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserCommandCreate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserCommandResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Run a browser command","tags":["Browser Studio"]}},"/api/v1/browser/sessions/{session_id}/control":{"post":{"description":"Change a retained session between human and shared control.\n\n**Required scope:** `browser:control`","operationId":"controlBrowserSession","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserControlCreate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserControlResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Change session control","tags":["Browser Studio"]}},"/api/v1/browser/sessions/{session_id}/draft":{"get":{"description":"Read the current reusable activity draft from a retained session.\n\n**Required scope:** `browser:read`","operationId":"getBrowserDraft","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserDraft"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get the activity draft","tags":["Browser Studio"]}},"/api/v1/browser/sessions/{session_id}/prompts":{"post":{"description":"Ask Browser Copilot to author, inspect, or debug the current step.\n\n**Required scope:** `browser:write`","operationId":"promptBrowserSession","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserPromptCreate"}}},"required":true},"responses":{"200":{"content":{"text/event-stream":{"example":"id: 17\nevent: status\ndata: {\"status\":\"running\"}\n\n","schema":{"type":"string"}}},"description":"A server-sent event stream. Reconnect with Last-Event-ID or the documented durable cursor.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Prompt Browser Copilot","tags":["Browser Studio"]}},"/api/v1/browser/sessions/{session_id}/prompts/cancel":{"post":{"description":"Cancel the active Browser Copilot prompt.\n\n**Required scope:** `browser:write`","operationId":"cancelBrowserPrompt","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserPromptCancelResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Cancel a Copilot prompt","tags":["Browser Studio"]}},"/api/v1/browser/tools":{"get":{"description":"List safe commands supported by the retained Browser Studio runtime.\n\n**Required scope:** `browser:read`","operationId":"listBrowserTools","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserToolList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List browser tools","tags":["Browser Studio"]}},"/api/v1/credentials":{"get":{"description":"List secret-free metadata for credential references available to workflows.\n\n**Required scope:** `credentials:read`","operationId":"listCredentials","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List credentials","tags":["Runtime credentials"]},"post":{"description":"Create a secret-backed credential reference. Secret values are never returned later.\n\n**Required scope:** `credentials:write`","operationId":"createCredential","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credential"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Create a credential","tags":["Runtime credentials"]}},"/api/v1/credentials/{credential_id}":{"delete":{"description":"Revoke the reference and invalidate browser sessions that depend on it.\n\n**Required scope:** `credentials:write`","operationId":"revokeCredential","parameters":[{"in":"path","name":"credential_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credential"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Revoke a credential","tags":["Runtime credentials"]},"get":{"description":"Read secret-free metadata for one credential reference.\n\n**Required scope:** `credentials:read`","operationId":"getCredential","parameters":[{"in":"path","name":"credential_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credential"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a credential","tags":["Runtime credentials"]}},"/api/v1/credentials/{credential_id}/rotations":{"post":{"description":"Rotate password, TOTP, PIN, phone, or note fields for a credential reference.\n\n**Required scope:** `credentials:write`","operationId":"rotateCredential","parameters":[{"in":"path","name":"credential_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialRotate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credential"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Rotate a credential","tags":["Runtime credentials"]}},"/api/v1/dashboard-agent/query":{"post":{"description":"Ask a read-only analytics question about organization workflow data.\n\n**Required scope:** `dashboards:read`","operationId":"queryDashboardAgent","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardQueryCreate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardQueryResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Query governed analytics","tags":["Analytics"]}},"/api/v1/executions":{"get":{"description":"List this organization's public execution records with optional filters and pagination.\n\n**Required scope:** `executions:read`","operationId":"listExecutions","parameters":[{"description":"Optional execution-status filter.","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Optional agent filter.","in":"query","name":"agent_id","required":false,"schema":{"type":"string"}},{"description":"Optional installation filter.","in":"query","name":"installation_id","required":false,"schema":{"type":"string"}},{"description":"Page size.","in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Zero-based page offset.","in":"query","name":"offset","required":false,"schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentExecutionList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List executions","tags":["Executions"]}},"/api/v1/executions/{execution_id}":{"get":{"description":"Read status, result, or safe failure information for one execution.\n\n**Required scope:** `executions:read`","operationId":"getExecution","parameters":[{"in":"path","name":"execution_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentExecution"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get an execution","tags":["Executions"]}},"/api/v1/executions/{execution_id}/phases":{"get":{"description":"Read safe activity phases for a catalog-agent execution without controlling the run.\n\n**Required scope:** `executions:read`","operationId":"getExecutionPhases","parameters":[{"in":"path","name":"execution_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowPhaseProjection"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get execution phases","tags":["Run observability"]}},"/api/v1/installations/{installation_id}":{"get":{"description":"Read provisioning, connection, and readiness state for an installation.\n\n**Required scope:** `installations:read`","operationId":"getInstallation","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Installation"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get an installation","tags":["Installations"]}},"/api/v1/installations/{installation_id}/authorization-actions":{"get":{"description":"List current and previous authorization actions for an installation.\n\n**Required scope:** `installations:read`","operationId":"listAuthorizationActions","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationActionList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List authorization actions","tags":["Installations"]},"post":{"description":"Start an OAuth or connection authorization action required by an installation.\n\n**Required scope:** `installations:write`","operationId":"createAuthorizationAction","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationActionCreate"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationAction"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Start authorization","tags":["Installations"]}},"/api/v1/installations/{installation_id}/executions":{"post":{"description":"Start an asynchronous run of an installed agent. Poll the returned status URL for completion.\n\n**Required scope:** `executions:write`","operationId":"createExecution","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentExecutionCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentExecution"}}},"description":"The resource was created directly in a terminal failed state; no polling retry is needed.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentExecution"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Start an agent execution","tags":["Executions"]}},"/api/v1/installations/{installation_id}/metrics":{"get":{"description":"Query governed metrics for one installation over an optional time window.\n\n**Required scope:** `metrics:read`","operationId":"getInstallationMetrics","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}},{"description":"Inclusive ISO-8601 start time.","in":"query","name":"from","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Exclusive ISO-8601 end time.","in":"query","name":"to","required":false,"schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricSummary"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get installation metrics","tags":["Analytics"]}},"/api/v1/installations/{installation_id}/metrics/dashboards":{"get":{"description":"List approved presentation-ready metric views available for an installation.\n\n**Required scope:** `metrics:read`","operationId":"listInstallationMetricDashboards","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricDashboardList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List installation metric views","tags":["Analytics"]}},"/api/v1/installations/{installation_id}/metrics/dashboards/{dashboard_id}":{"get":{"description":"Return visualization metadata and aliased tile data that a partner can render in its own UI.\n\n**Required scope:** `metrics:read`","operationId":"renderInstallationMetricDashboard","parameters":[{"in":"path","name":"dashboard_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}},{"description":"Inclusive ISO-8601 start time.","in":"query","name":"from","required":false,"schema":{"format":"date","type":"string"}},{"description":"Exclusive ISO-8601 end time.","in":"query","name":"to","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricDashboard"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get an installation metric view","tags":["Analytics"]}},"/api/v1/installations/{installation_id}/provisioning-retries":{"post":{"description":"Retry an installation whose provisioning did not complete.\n\n**Required scope:** `installations:write`","operationId":"createProvisioningRetry","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Installation"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Retry provisioning","tags":["Installations"]}},"/api/v1/installations/{installation_id}/source-batches":{"post":{"description":"Queue creation of multiple file or URL knowledge sources for one installation.\n\n**Required scope:** `installations:write`","operationId":"createSourceBatch","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSourceBatchCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSourceBatch"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Create a source batch","tags":["Knowledge sources"]}},"/api/v1/installations/{installation_id}/source-batches/{batch_id}":{"get":{"description":"Read item-level creation, upload, and indexing state for one source batch.\n\n**Required scope:** `installations:read`","operationId":"getSourceBatch","parameters":[{"in":"path","name":"batch_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSourceBatch"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a source batch","tags":["Knowledge sources"]}},"/api/v1/installations/{installation_id}/source-batches/{batch_id}/cancel":{"post":{"description":"Cancel queued source creation work for a source batch.\n\n**Required scope:** `installations:write`","operationId":"cancelSourceBatch","parameters":[{"in":"path","name":"batch_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSourceBatch"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Cancel a source batch","tags":["Knowledge sources"]}},"/api/v1/installations/{installation_id}/source-batches/{batch_id}/complete":{"post":{"description":"Queue completion checks for uploaded file sources in a batch.\n\n**Required scope:** `installations:write`","operationId":"completeSourceBatchUploads","parameters":[{"in":"path","name":"batch_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSourceBatch"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Complete batch uploads","tags":["Knowledge sources"]}},"/api/v1/installations/{installation_id}/source-batches/{batch_id}/upload-actions":{"post":{"description":"Create fresh signed PUT upload actions for pending file sources in a batch.\n\n**Required scope:** `installations:write`","operationId":"createSourceBatchUploadActions","parameters":[{"in":"path","name":"batch_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSourceBatch"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Create batch upload actions","tags":["Knowledge sources"]}},"/api/v1/installations/{installation_id}/sources":{"get":{"description":"List the knowledge sources attached to an installation.\n\n**Required scope:** `installations:read`","operationId":"listSources","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSourceList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List sources","tags":["Knowledge sources"]},"post":{"description":"Create an upload target for a file-backed knowledge source.\n\n**Required scope:** `installations:write`","operationId":"createSource","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSourceCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSource"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Create a source upload","tags":["Knowledge sources"]}},"/api/v1/installations/{installation_id}/sources/{source_id}":{"delete":{"description":"Remove a knowledge source from an installation.\n\n**Required scope:** `installations:write`","operationId":"deleteSource","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"source_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Delete a source","tags":["Knowledge sources"]},"get":{"description":"Read upload and indexing state for one knowledge source.\n\n**Required scope:** `installations:read`","operationId":"getSource","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"source_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSource"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a source","tags":["Knowledge sources"]}},"/api/v1/installations/{installation_id}/sources/{source_id}/complete":{"post":{"description":"Mark a direct upload complete so ingestion and indexing can begin.\n\n**Required scope:** `installations:write`","operationId":"completeSourceUpload","parameters":[{"in":"path","name":"installation_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"source_id","required":true,"schema":{"type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeSource"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Complete a source upload","tags":["Knowledge sources"]}},"/api/v1/integrations":{"get":{"description":"List live global and organization-owned integrations with safe capability schemas.\n\n**Required scope:** `integrations:read`","operationId":"listIntegrations","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List integrations","tags":["Integrations"]}},"/api/v1/integrations/catalog":{"get":{"description":"Read the integration catalog in a partner-friendly representation.\n\n**Required scope:** `integrations:read`","operationId":"getIntegrationCatalog","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get the integration catalog","tags":["Integrations"]}},"/api/v1/integrations/categories":{"get":{"description":"List categories represented in the organization's visible integration catalog.\n\n**Required scope:** `integrations:read`","operationId":"listIntegrationCategories","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationCategoryList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List integration categories","tags":["Integrations"]}},"/api/v1/integrations/connections":{"get":{"description":"List secret-free organization service connections available to workflows.\n\n**Required scope:** `integrations:read`","operationId":"listIntegrationConnections","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationConnectionList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List connections","tags":["Integration connections"]}},"/api/v1/integrations/connections/{connection_id}":{"delete":{"description":"Deactivate an organization service connection without deleting its encrypted credential.\n\n**Required scope:** `integrations:connect`","operationId":"deleteIntegrationConnection","parameters":[{"in":"path","name":"connection_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Disconnect an integration","tags":["Integration connections"]}},"/api/v1/integrations/connections/{connection_id}/validate":{"post":{"description":"Run a safe read-only credential probe without returning response data or vault material.\n\n**Required scope:** `integrations:connect`","operationId":"validateIntegrationConnection","parameters":[{"in":"path","name":"connection_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationConnectionValidation"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Validate a connection","tags":["Integration connections"]}},"/api/v1/integrations/factory/discoveries":{"post":{"description":"Start durable endpoint discovery from one HTTPS URL, pasted document, or completed private upload.\n\n**Required scope:** `integrations:generate`","operationId":"createFactoryDiscovery","parameters":[{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryDiscoveryCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryRun"}}},"description":"Request completed successfully.","headers":{"ETag":{"description":"Quoted resource state version for the next conditional mutation.","schema":{"pattern":"^\"[1-9][0-9]*\"$","type":"string"}},"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"Location":{"description":"Relative URL of the durable factory run.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"example":2,"type":"integer"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Start discovery","tags":["Integration Factory"]}},"/api/v1/integrations/factory/discoveries/{run_id}":{"get":{"description":"Read the durable discovery projection and endpoint choices.\n\n**Required scope:** `integrations:read`","operationId":"getFactoryDiscovery","parameters":[{"in":"path","name":"run_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryRun"}}},"description":"Request completed successfully.","headers":{"ETag":{"description":"Quoted resource state version for the next conditional mutation.","schema":{"pattern":"^\"[1-9][0-9]*\"$","type":"string"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get discovery","tags":["Integration Factory"]}},"/api/v1/integrations/factory/discoveries/{run_id}/events":{"get":{"description":"Replay or stream organization-scoped factory events.\n\n**Required scope:** `integrations:read`","operationId":"listFactoryDiscoveryEvents","parameters":[{"in":"path","name":"run_id","required":true,"schema":{"type":"string"}},{"description":"Return events after this numeric cursor.","in":"query","name":"after","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Maximum replay events to return.","in":"query","name":"limit","required":false,"schema":{"maximum":500,"minimum":1,"type":"integer"}},{"description":"Set true to continue as a server-sent event stream.","in":"query","name":"stream","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Resume after this durable event cursor. If after is also supplied, both values must match.","in":"header","name":"Last-Event-ID","required":false,"schema":{"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FactoryEventList"}},"text/event-stream":{"example":"id: 17\nevent: status\ndata: {\"status\":\"running\"}\n\n","schema":{"type":"string"}}},"description":"A server-sent event stream. Reconnect with Last-Event-ID or the documented durable cursor.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Read discovery events","tags":["Integration Factory"]}},"/api/v1/integrations/factory/generations":{"post":{"description":"Generate capability definitions for selected discovered endpoints. Requires If-Match with the discovery state version.\n\n**Required scope:** `integrations:generate`","operationId":"createFactoryGeneration","parameters":[{"description":"The quoted ETag returned with the latest resource representation, for example \"17\". A bare positive integer remains accepted during the compatibility transition.","in":"header","name":"If-Match","required":true,"schema":{"oneOf":[{"pattern":"^\"[1-9][0-9]*\"$","type":"string"},{"deprecated":true,"minimum":1,"type":"integer"}]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryGenerationCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryRun"}}},"description":"Request completed successfully.","headers":{"ETag":{"description":"Quoted resource state version for the next conditional mutation.","schema":{"pattern":"^\"[1-9][0-9]*\"$","type":"string"}},"Location":{"description":"Relative URL of the durable factory run.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"example":2,"type":"integer"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Start generation","tags":["Integration Factory"]}},"/api/v1/integrations/factory/generations/{run_id}":{"get":{"description":"Read generated capabilities, validation state, promotion state, and the resulting connection id.\n\n**Required scope:** `integrations:read`","operationId":"getFactoryGeneration","parameters":[{"in":"path","name":"run_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryRun"}}},"description":"Request completed successfully.","headers":{"ETag":{"description":"Quoted resource state version for the next conditional mutation.","schema":{"pattern":"^\"[1-9][0-9]*\"$","type":"string"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get generation","tags":["Integration Factory"]}},"/api/v1/integrations/factory/generations/{run_id}/capability-tests":{"post":{"description":"Durably execute one generated capability before promotion. Write, action, and delete capabilities require explicit side-effect confirmation. Requires Idempotency-Key and If-Match.\n\n**Required scope:** `integrations:generate`","operationId":"createFactoryCapabilityTest","parameters":[{"in":"path","name":"run_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}},{"description":"The quoted ETag returned with the latest resource representation, for example \"17\". A bare positive integer remains accepted during the compatibility transition.","in":"header","name":"If-Match","required":true,"schema":{"oneOf":[{"pattern":"^\"[1-9][0-9]*\"$","type":"string"},{"deprecated":true,"minimum":1,"type":"integer"}]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryCapabilityTestCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryCapabilityTest"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"Location":{"description":"Relative URL of the durable factory run.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"example":2,"type":"integer"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Test a generated capability","tags":["Integration Factory"]}},"/api/v1/integrations/factory/generations/{run_id}/capability-tests/{test_id}":{"get":{"description":"Read the encrypted-at-rest, organization-scoped result of a generated capability test.\n\n**Required scope:** `integrations:read`","operationId":"getFactoryCapabilityTest","parameters":[{"in":"path","name":"run_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"test_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryCapabilityTest"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a capability test","tags":["Integration Factory"]}},"/api/v1/integrations/factory/generations/{run_id}/events":{"get":{"description":"Replay or stream the full factory lifecycle event history.\n\n**Required scope:** `integrations:read`","operationId":"listFactoryGenerationEvents","parameters":[{"in":"path","name":"run_id","required":true,"schema":{"type":"string"}},{"description":"Return events after this numeric cursor.","in":"query","name":"after","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Maximum replay events to return.","in":"query","name":"limit","required":false,"schema":{"maximum":500,"minimum":1,"type":"integer"}},{"description":"Set true to continue as a server-sent event stream.","in":"query","name":"stream","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Resume after this durable event cursor. If after is also supplied, both values must match.","in":"header","name":"Last-Event-ID","required":false,"schema":{"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FactoryEventList"}},"text/event-stream":{"example":"id: 17\nevent: status\ndata: {\"status\":\"running\"}\n\n","schema":{"type":"string"}}},"description":"A server-sent event stream. Reconnect with Last-Event-ID or the documented durable cursor.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Read generation events","tags":["Integration Factory"]}},"/api/v1/integrations/factory/generations/{run_id}/promote":{"post":{"description":"Atomically make the validated and explicitly tested version live only for the requesting organization. Global promotion is unavailable through the public API.\n\n**Required scope:** `integrations:promote`","operationId":"promoteFactoryGeneration","parameters":[{"in":"path","name":"run_id","required":true,"schema":{"type":"string"}},{"description":"The quoted ETag returned with the latest resource representation, for example \"17\". A bare positive integer remains accepted during the compatibility transition.","in":"header","name":"If-Match","required":true,"schema":{"oneOf":[{"pattern":"^\"[1-9][0-9]*\"$","type":"string"},{"deprecated":true,"minimum":1,"type":"integer"}]}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryRun"}}},"description":"Request completed successfully.","headers":{"ETag":{"description":"Quoted resource state version for the next conditional mutation.","schema":{"pattern":"^\"[1-9][0-9]*\"$","type":"string"}},"Location":{"description":"Relative URL of the durable factory run.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"example":2,"type":"integer"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Promote a generation","tags":["Integration Factory"]}},"/api/v1/integrations/factory/generations/{run_id}/validations":{"post":{"description":"Validate structure and execute safe runtime probes using an organization-owned encrypted credential reference.\n\n**Required scope:** `integrations:generate`","operationId":"createFactoryValidation","parameters":[{"in":"path","name":"run_id","required":true,"schema":{"type":"string"}},{"description":"The quoted ETag returned with the latest resource representation, for example \"17\". A bare positive integer remains accepted during the compatibility transition.","in":"header","name":"If-Match","required":true,"schema":{"oneOf":[{"pattern":"^\"[1-9][0-9]*\"$","type":"string"},{"deprecated":true,"minimum":1,"type":"integer"}]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryValidationCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryRun"}}},"description":"Request completed successfully.","headers":{"ETag":{"description":"Quoted resource state version for the next conditional mutation.","schema":{"pattern":"^\"[1-9][0-9]*\"$","type":"string"}},"Location":{"description":"Relative URL of the durable factory run.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"example":2,"type":"integer"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Validate a generation","tags":["Integration Factory"]}},"/api/v1/integrations/factory/uploads":{"post":{"description":"Create a short-lived signed upload target for private API documentation. Document bytes never pass through the API process.\n\n**Required scope:** `integrations:generate`","operationId":"createFactoryUpload","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryUploadCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryUploadReservation"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Create a document upload","tags":["Integration Factory"]}},"/api/v1/integrations/factory/uploads/{upload_id}/complete":{"post":{"description":"Verify the uploaded document's content type and bounded size before discovery can consume it.\n\n**Required scope:** `integrations:generate`","operationId":"completeFactoryUpload","parameters":[{"in":"path","name":"upload_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryUpload"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Complete a document upload","tags":["Integration Factory"]}},"/api/v1/integrations/{type_key}":{"get":{"description":"Read one visible integration and its executable capability contracts.\n\n**Required scope:** `integrations:read`","operationId":"getIntegration","parameters":[{"in":"path","name":"type_key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get an integration","tags":["Integrations"]}},"/api/v1/integrations/{type_key}/connections":{"post":{"description":"Attach an organization-owned encrypted credential reference to a live integration.\n\n**Required scope:** `integrations:connect`","operationId":"createIntegrationConnection","parameters":[{"in":"path","name":"type_key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationConnectionCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationConnection"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Create a connection","tags":["Integration connections"]}},"/api/v1/integrations/{type_key}/factory/discoveries":{"post":{"description":"Start a durable extension run for an organization-owned integration. The resulting draft inherits unchanged live capabilities.\n\n**Required scope:** `integrations:generate`","operationId":"createFactoryExtensionDiscovery","parameters":[{"in":"path","name":"type_key","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryExtensionDiscoveryCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFactoryRun"}}},"description":"Request completed successfully.","headers":{"ETag":{"description":"Quoted resource state version for the next conditional mutation.","schema":{"pattern":"^\"[1-9][0-9]*\"$","type":"string"}},"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"Location":{"description":"Relative URL of the durable factory run.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"example":2,"type":"integer"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Discover additional capabilities","tags":["Integration Factory"]}},"/api/v1/planner/builds":{"get":{"description":"List durable builds with cursor pagination and optional status filtering.\n\n**Required scope:** `planner:read`","operationId":"listPlannerBuilds","parameters":[{"description":"Maximum builds to return.","in":"query","name":"limit","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor from the previous page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Optional build-status filter.","in":"query","name":"status","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerBuildList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List Planner builds","tags":["Workflow Planner"]},"post":{"description":"Queue a durable workflow build from a natural-language request and structured context.\n\n**Required scope:** `planner:write`","operationId":"startPlannerBuild","parameters":[{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerBuildCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerBuild"}}},"description":"Request completed successfully.","headers":{"ETag":{"description":"Quoted resource state version for the next conditional mutation.","schema":{"pattern":"^\"[1-9][0-9]*\"$","type":"string"}},"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Start a Planner build","tags":["Workflow Planner"]}},"/api/v1/planner/builds/{build_id}":{"get":{"description":"Read current build state, step decisions, and version information.\n\n**Required scope:** `planner:read`","operationId":"getPlannerBuild","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerBuild"}}},"description":"Request completed successfully.","headers":{"ETag":{"description":"Quoted resource state version for the next conditional mutation.","schema":{"pattern":"^\"[1-9][0-9]*\"$","type":"string"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a Planner build","tags":["Workflow Planner"]}},"/api/v1/planner/builds/{build_id}/abandon":{"post":{"description":"Stop work on a build while retaining its durable audit history.\n\n**Required scope:** `planner:write`","operationId":"abandonPlannerBuild","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}},{"description":"The quoted ETag returned with the latest resource representation, for example \"17\". A bare positive integer remains accepted during the compatibility transition.","in":"header","name":"If-Match","required":true,"schema":{"oneOf":[{"pattern":"^\"[1-9][0-9]*\"$","type":"string"},{"deprecated":true,"minimum":1,"type":"integer"}]}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerCommand"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Abandon a build","tags":["Workflow Planner"]}},"/api/v1/planner/builds/{build_id}/events":{"get":{"description":"Replay durable build events by cursor or follow them as a server-sent event stream.\n\n**Required scope:** `planner:read`","operationId":"listPlannerEvents","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}},{"description":"Return events after this numeric cursor.","in":"query","name":"after","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Maximum replay events to return.","in":"query","name":"limit","required":false,"schema":{"maximum":500,"minimum":1,"type":"integer"}},{"description":"Set true to continue as a server-sent event stream.","in":"query","name":"stream","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Resume after this durable event cursor. If after is also supplied, both values must match.","in":"header","name":"Last-Event-ID","required":false,"schema":{"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerEventList"}},"text/event-stream":{"example":"id: 17\nevent: status\ndata: {\"status\":\"running\"}\n\n","schema":{"type":"string"}}},"description":"A server-sent event stream. Reconnect with Last-Event-ID or the documented durable cursor.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Read Planner events","tags":["Workflow Planner"]}},"/api/v1/planner/builds/{build_id}/export":{"get":{"description":"Download the compiled workflow bundle for a build.\n\n**Required scope:** `planner:export`","operationId":"exportPlannerBuild","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerExport"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Export a build","tags":["Workflow Planner"]}},"/api/v1/planner/builds/{build_id}/promote":{"post":{"description":"Explicitly promote a completed, reviewed build into a reusable workflow definition. An optional review contract makes the workflow's produced queue items reachable through the review API.\n\n**Required scope:** `planner:promote`","operationId":"promotePlannerBuild","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}},{"description":"The quoted ETag returned with the latest resource representation, for example \"17\". A bare positive integer remains accepted during the compatibility transition.","in":"header","name":"If-Match","required":true,"schema":{"oneOf":[{"pattern":"^\"[1-9][0-9]*\"$","type":"string"},{"deprecated":true,"minimum":1,"type":"integer"}]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerPromotionCreate"}}},"required":false},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerCommand"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Promote a build","tags":["Workflow Planner"]}},"/api/v1/planner/builds/{build_id}/resume":{"post":{"description":"Resume a paused or recoverable Planner build.\n\n**Required scope:** `planner:write`","operationId":"resumePlannerBuild","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}},{"description":"The quoted ETag returned with the latest resource representation, for example \"17\". A bare positive integer remains accepted during the compatibility transition.","in":"header","name":"If-Match","required":true,"schema":{"oneOf":[{"pattern":"^\"[1-9][0-9]*\"$","type":"string"},{"deprecated":true,"minimum":1,"type":"integer"}]}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerCommand"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Resume a build","tags":["Workflow Planner"]}},"/api/v1/planner/builds/{build_id}/steps/{step_number}/actions":{"post":{"description":"Accept, reject, test, retry, or message one step using optimistic state versioning.\n\n**Required scope:** `planner:write`","operationId":"actOnPlannerStep","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"step_number","required":true,"schema":{"type":"integer"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerStepActionCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerCommand"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Act on a Planner step","tags":["Workflow Planner"]}},"/api/v1/planner/builds/{build_id}/steps/{step_number}/assist":{"post":{"description":"Ask the workflow editor to help repair or improve one step.\n\n**Required scope:** `planner:write`","operationId":"assistPlannerStep","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"step_number","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerAssistCreate"}}},"required":true},"responses":{"200":{"content":{"text/event-stream":{"example":"id: 17\nevent: status\ndata: {\"status\":\"running\"}\n\n","schema":{"type":"string"}}},"description":"A server-sent event stream. Reconnect with Last-Event-ID or the documented durable cursor.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Request step assistance","tags":["Workflow Planner"]}},"/api/v1/planner/builds/{build_id}/steps/{step_number}/browser-session":{"get":{"description":"Mint a short-lived noVNC observer link for the browser currently generating or testing this Planner step. This does not start a browser.\n\n**Required scope:** `planner:view`","operationId":"getPlannerBrowserSession","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"step_number","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerBrowserSession"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get the current Planner browser","tags":["Planner browser view"]}},"/api/v1/planner/builds/{build_id}/steps/{step_number}/browser-session/control":{"post":{"description":"Switch the current Planner generation or test browser between human and shared control.\n\n**Required scope:** `planner:control`","operationId":"controlPlannerBrowserSession","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"step_number","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserControlCreate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerBrowserSession"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Change browser control","tags":["Planner browser view"]}},"/api/v1/planner/builds/{build_id}/steps/{step_number}/cancel":{"post":{"description":"Cancel a currently running test for one Planner step.\n\n**Required scope:** `planner:write`","operationId":"cancelPlannerStep","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"step_number","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerActionResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Cancel a step test","tags":["Workflow Planner"]}},"/api/v1/planner/builds/{build_id}/template":{"post":{"description":"Save a completed build as a reusable workflow template.\n\n**Required scope:** `planner:promote`","operationId":"savePlannerTemplate","parameters":[{"in":"path","name":"build_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerTemplateCreate"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannerActionResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Save a build as a template","tags":["Workflow Planner"]}},"/api/v1/queue-designs":{"get":{"description":"List queue designs visible to the authenticated person or organization system principal.\n\n**Required scope:** `queue_ui:read`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"listQueueDesigns","parameters":[{"description":"Maximum designs, from 1 through 100.","in":"query","name":"limit","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor from the previous page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List queue designs","tags":["Queue UI Designer"]},"post":{"description":"Describe the operator view for an eligible workflow. Return the design and generation status for review. Requires authorized personal or system access and Idempotency-Key.\n\n**Required scope:** `queue_ui:write`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"startQueueDesign","parameters":[{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesign"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Start a queue design","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/targets":{"get":{"description":"List authorized app-managed workflows eligible for queue design with personal or system access.\n\n**Required scope:** `queue_ui:read`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"listQueueDesignTargets","parameters":[{"description":"Maximum targets, from 1 through 100.","in":"query","name":"limit","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor from the previous page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignTargetList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Find workflows to design","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/{session_id}":{"get":{"description":"Read generation, review, and publication state with review and live links.\n\n**Required scope:** `queue_ui:read`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"getQueueDesign","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesign"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a queue design","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/{session_id}/approve":{"post":{"description":"Use a system API key with explicit queue_ui:approve authority to approve the exact version_id and returned 16-character resolved_yaml_hash. Supply the current publication.live_version_id receipt, or explicit null before first publication, as required expected_live_version_id; stale approval conflicts. Personal keys and user-bound OAuth cannot call this operation. Approval is attributed to the system principal, not the key creator or a human reviewer, and does not publish. Target authorization and version eligibility are rechecked.\n\n**Required scope:** `queue_ui:approve`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"approveQueueDesign","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignApprove"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesign"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Approve an exact queue design","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/{session_id}/cancel":{"post":{"description":"Cancel the selected or current generation run while retaining the design and previews.\n\n**Required scope:** `queue_ui:write`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"cancelQueueDesignRun","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignCancel"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesign"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Stop design generation","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/{session_id}/events":{"get":{"description":"Read durable JSON progress events for a run. Retain run_id and after_seq together; start at zero for a new run. Inspect state and events after an interrupted mutation instead of blindly replaying it. Completed generation is not approval or publication.\n\n**Required scope:** `queue_ui:read`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"listQueueDesignEvents","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"Optional generation run to inspect.","in":"query","name":"run_id","required":false,"schema":{"type":"string"}},{"description":"Return events after this sequence number; defaults to zero.","in":"query","name":"after_seq","required":false,"schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Maximum events, from 1 through 100; defaults to 100.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignEventList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Read design progress","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/{session_id}/messages":{"post":{"description":"Describe changes to generate a new version. Reuse Idempotency-Key when retrying the same request.\n\n**Required scope:** `queue_ui:write`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"messageQueueDesign","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignMessageCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesign"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Revise a queue design","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/{session_id}/previews":{"delete":{"description":"Close the design session before durable preview cleanup. Further messages and publishing are refused; start a fresh session to design again. Immutable versions, publication history, and the live queue are retained. Cleanup retries and rollback to prior publication receipts remain available.\n\n**Required scope:** `queue_ui:write`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"teardownQueueDesignPreviews","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesign"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Clean up design previews","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/{session_id}/publish":{"post":{"description":"Publish the exact approved design version_id with authorized personal or system access. expected_live_version_id is publication.live_version_id, a publication receipt ID, or explicit null before first publication. A stale receipt is a conflict. Approval and target publication permission are checked separately; this cannot approve a design or publish from a closed session.\n\n**Required scope:** `queue_ui:publish`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"publishQueueDesign","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignPublish"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesign"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Publish an approved design","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/{session_id}/rollback":{"post":{"description":"Restore to_version_id from publication.history or publication.baseline_version_id, both publication receipt IDs, not design version IDs. Supply the current publication.live_version_id as expected_live_version_id. Requires current target publication permission for the personal or system principal. Business data is unchanged; rollback remains available from a closed session.\n\n**Required scope:** `queue_ui:publish`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"rollbackQueueDesign","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignRollback"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesign"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Restore a previous queue design","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/{session_id}/versions":{"get":{"description":"Compare saved versions and their validation and preview links.\n\n**Required scope:** `queue_ui:read`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"listQueueDesignVersions","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"Maximum versions, from 1 through 100.","in":"query","name":"limit","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor from the previous page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignVersionList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List design versions","tags":["Queue UI Designer"]}},"/api/v1/queue-designs/{session_id}/versions/{version_id}":{"get":{"description":"Inspect one exact version before opening it for human review.\n\n**Required scope:** `queue_ui:read`\n\n**Credential policy:** read/write/publish support personal and service API keys or user-bound MCP OAuth; queue_ui:approve requires a service/system API key and is excluded from OAuth. Queue UI scopes are independent public opt-ins, not STAFF-only scopes and not part of the default partner preset. Select them within your applicable delegated API-key or OAuth grant ceiling. The service also rechecks useQueueUIDesigner, verified principal identity, public session source, and applicable resource permissions.","operationId":"getQueueDesignVersion","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDesignVersion"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a design version","tags":["Queue UI Designer"]}},"/api/v1/review-items":{"get":{"description":"List durable items waiting for a person from catalog agents or API-promoted Planner agent workflows. Pass state=resolved with the source execution_id or workflow_instance_id to list that run's already-decided items, each carrying the revision_token needed to reopen it.\n\n**Required scope:** `review_items:read`","operationId":"listReviewItems","parameters":[{"description":"Optional agent filter.","in":"query","name":"agent_id","required":false,"schema":{"type":"string"}},{"description":"Optional installation filter.","in":"query","name":"installation_id","required":false,"schema":{"type":"string"}},{"description":"Optional execution filter.","in":"query","name":"execution_id","required":false,"schema":{"type":"string"}},{"description":"Optional promoted Planner workflow filter.","in":"query","name":"workflow_definition_id","required":false,"schema":{"type":"string"}},{"description":"Optional exact workflow-run filter.","in":"query","name":"workflow_instance_id","required":false,"schema":{"type":"string"}},{"description":"open (default) lists items waiting for a person. resolved lists already-decided items and returns each one's revision_token; it requires execution_id or workflow_instance_id.","in":"query","name":"state","required":false,"schema":{"type":"string"}},{"description":"Page size.","in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Zero-based page offset.","in":"query","name":"offset","required":false,"schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewItemList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List review items","tags":["Human review"]}},"/api/v1/review-items/decisions":{"post":{"description":"Apply one decision to one or more review items with an optional audit note. Which decisions an item accepts depends on its agent or Planner promotion review contract. Every item reports its own outcome, so a partially applied batch is normal. Reopening an already-resolved item is a separate, explicitly scoped operation described by the revise field.\n\n**Required scope:** `review_items:write`","operationId":"decideReviewItems","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewDecisionCreate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewDecisionResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Submit review decisions","tags":["Human review"]}},"/api/v1/schedules":{"get":{"description":"List recurring schedules for promoted workflow definitions.\n\n**Required scope:** `schedules:read`","operationId":"listSchedules","parameters":[{"description":"Page size.","in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Zero-based page offset.","in":"query","name":"offset","required":false,"schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Set true to return only paused schedules.","in":"query","name":"paused_only","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List schedules","tags":["Schedules"]}},"/api/v1/sessions/{session_id}":{"get":{"description":"Read normalized state and capabilities for a Planner build or Browser Copilot session.\n\n**Required scope:** `sessions:read`","operationId":"getCoordinationSession","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoordinationSession"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a coordinated session","tags":["Session coordination"]}},"/api/v1/sessions/{session_id}/events":{"get":{"description":"Replay or follow durable Planner events. Browser output is delivered on the message stream and is not replayable.\n\n**Required scope:** `sessions:read`","operationId":"getCoordinationSessionEvents","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"Return events after this numeric cursor.","in":"query","name":"after","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Maximum replay events to return.","in":"query","name":"limit","required":false,"schema":{"maximum":500,"minimum":1,"type":"integer"}},{"description":"Set true to continue as a server-sent event stream.","in":"query","name":"stream","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Resume after this durable event cursor. If after is also supplied, both values must match.","in":"header","name":"Last-Event-ID","required":false,"schema":{"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoordinationSessionEventList"}},"text/event-stream":{"example":"id: 17\nevent: status\ndata: {\"status\":\"running\"}\n\n","schema":{"type":"string"}}},"description":"A server-sent event stream. Reconnect with Last-Event-ID or the documented durable cursor.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Read coordinated session events","tags":["Session coordination"]}},"/api/v1/sessions/{session_id}/messages":{"post":{"description":"Send attributed feedback to Planner, Browser Copilot, or a queue design. Planner and queue design messages require Idempotency-Key. Queue designs additionally require queue_ui:write and use their dedicated events endpoint for progress; Browser output streams in this response.\n\n**Required scope:** `sessions:write`","operationId":"sendCoordinationSessionMessage","parameters":[{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}},{"description":"Required for Planner sessions (pbld_) and queue designs (qds_). Reusing it safely replays the Planner command result. Browser sessions (bas_) are not idempotent and must not be retried after an ambiguous disconnect.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoordinationSessionMessageCreate"}}},"required":true},"responses":{"200":{"content":{"text/event-stream":{"example":"id: 17\nevent: status\ndata: {\"status\":\"running\"}\n\n","schema":{"type":"string"}}},"description":"A server-sent message stream. Browser output is live and cannot be replayed after disconnect; Planner progress is replayed through the session events endpoint.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Message a coordinated session","tags":["Session coordination"]}},"/api/v1/sms-inbox":{"post":{"description":"Idempotently purchase the organization's first dedicated SMS-capable number, or return the existing default number without purchasing another. Additional numbers are not available through the public API.\n\n**Required scope:** `credentials:write`","operationId":"provisionSmsInbox","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsInboxProvisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsInbox"}}},"description":"The existing default organization number was returned; no number was purchased.","headers":{"Location":{"description":"Canonical relative URL of the default SMS inbox.","schema":{"example":"/api/v1/sms-inbox","type":"string"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsInbox"}}},"description":"A dedicated organization number was purchased and configured.","headers":{"Location":{"description":"Canonical relative URL of the default SMS inbox.","schema":{"example":"/api/v1/sms-inbox","type":"string"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The provider or organization credential vault could not complete provisioning.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}}},"security":[{"bearerAuth":[]}],"summary":"Provision the default SMS inbox","tags":["SMS inbox"]}},"/api/v1/sms-inbox/messages":{"get":{"description":"Read recent messages delivered to the caller organization's dedicated VoIP number. The shared real-SIM inbox is never exposed through this route.\n\n**Required scope:** `sms:read`","operationId":"listSmsInboxMessages","parameters":[{"description":"Return only messages received strictly after this Unix timestamp in milliseconds.","in":"query","name":"after_ms","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Maximum messages to return, from 1 through 50.","in":"query","name":"limit","required":false,"schema":{"maximum":50,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsInboxMessages"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The dedicated inbox provider could not be read.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}}},"security":[{"bearerAuth":[]}],"summary":"Read dedicated inbox messages","tags":["SMS inbox"]}},"/api/v1/usage":{"get":{"description":"Read organization-level Planner agent, Integration Factory, and browser operation quota consumption.\n\n**Required scope:** `usage:read`","operationId":"getMarketplaceUsage","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageSummary"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get platform usage","tags":["Usage"]}},"/api/v1/usage/planner":{"get":{"description":"Read organization-level Planner and browser operation quota consumption.\n\n**Required scope:** `usage:read`","operationId":"getPlannerUsage","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageSummary"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get Planner usage","tags":["Usage"]}},"/api/v1/workflow-definitions/{workflow_definition_id}/executions":{"post":{"description":"Start one asynchronous run of an eligible promoted workflow definition with optional runtime input. Coalescing singleton definitions are not eligible. This does not create or modify a recurring schedule.\n\n**Required scope:** `executions:write`","operationId":"createWorkflowExecution","parameters":[{"in":"path","name":"workflow_definition_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowExecutionCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowExecution"}}},"description":"The one-off workflow execution was accepted.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"Location":{"description":"Relative URL for the accepted run's safe phase projection.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"example":2,"type":"integer"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The idempotency key conflicts with an earlier request, or the definition uses a coalescing singleton execution mode that is not eligible for one-off execution.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The workflow runtime could not accept the execution.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}}},"security":[{"bearerAuth":[]}],"summary":"Start a workflow execution","tags":["Workflow executions"]}},"/api/v1/workflow-definitions/{workflow_definition_id}/metrics/dashboards":{"get":{"description":"List approved presentation-ready metric views for one explicitly granted production workflow definition.\n\n**Required scope:** `metrics:read`","operationId":"listWorkflowMetricDashboards","parameters":[{"in":"path","name":"workflow_definition_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricDashboardList"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"List workflow metric views","tags":["Analytics"]}},"/api/v1/workflow-definitions/{workflow_definition_id}/metrics/dashboards/{dashboard_id}":{"get":{"description":"Return visualization metadata and aliased tile data for one explicitly granted production workflow definition.\n\n**Required scope:** `metrics:read`","operationId":"renderWorkflowMetricDashboard","parameters":[{"in":"path","name":"dashboard_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"workflow_definition_id","required":true,"schema":{"type":"string"}},{"description":"Inclusive ISO-8601 start time.","in":"query","name":"from","required":false,"schema":{"format":"date","type":"string"}},{"description":"Exclusive ISO-8601 end time.","in":"query","name":"to","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricDashboard"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a workflow metric view","tags":["Analytics"]}},"/api/v1/workflow-definitions/{workflow_definition_id}/schedule":{"delete":{"description":"Delete the schedule without deleting its workflow definition.\n\n**Required scope:** `schedules:write`","operationId":"deleteSchedule","parameters":[{"in":"path","name":"workflow_definition_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleCommandResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Delete a schedule","tags":["Schedules"]},"get":{"description":"Read a workflow definition's schedule and recent actions.\n\n**Required scope:** `schedules:read`","operationId":"getSchedule","parameters":[{"in":"path","name":"workflow_definition_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get a schedule","tags":["Schedules"]},"patch":{"description":"Update cron, frozen input, overlap policy, or operator note.\n\n**Required scope:** `schedules:write`","operationId":"updateSchedule","parameters":[{"in":"path","name":"workflow_definition_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Update a schedule","tags":["Schedules"]},"post":{"description":"Create a recurring schedule for a promoted workflow definition.\n\n**Required scope:** `schedules:write`","operationId":"createSchedule","parameters":[{"in":"path","name":"workflow_definition_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Create a schedule","tags":["Schedules"]}},"/api/v1/workflow-definitions/{workflow_definition_id}/schedule/pause":{"post":{"description":"Pause future actions without deleting the schedule.\n\n**Required scope:** `schedules:write`","operationId":"pauseSchedule","parameters":[{"in":"path","name":"workflow_definition_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleNote"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleCommandResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Pause a schedule","tags":["Schedules"]}},"/api/v1/workflow-definitions/{workflow_definition_id}/schedule/resume":{"post":{"description":"Resume future actions for a paused schedule.\n\n**Required scope:** `schedules:write`","operationId":"resumeSchedule","parameters":[{"in":"path","name":"workflow_definition_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleNote"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleCommandResult"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Resume a schedule","tags":["Schedules"]}},"/api/v1/workflow-definitions/{workflow_definition_id}/schedule/trigger":{"post":{"description":"Start the scheduled compiled workflow immediately.\n\n**Required scope:** `schedules:write`","operationId":"triggerSchedule","parameters":[{"in":"path","name":"workflow_definition_id","required":true,"schema":{"type":"string"}},{"description":"A unique 1-200 character key. Reusing it safely replays the original command result.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":200,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleTriggerCreate"}}},"required":false},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleCommandResult"}}},"description":"Request completed successfully.","headers":{"Idempotency-Replayed":{"description":"True when this response reused an earlier request claim.","schema":{"type":"boolean"}},"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Trigger a schedule","tags":["Schedules"]}},"/api/v1/workflow-runs/{workflow_instance_id}/phases":{"get":{"description":"Read safe activity phases for an exact workflow run.\n\n**Required scope:** `executions:read`","operationId":"getWorkflowPhases","parameters":[{"in":"path","name":"workflow_instance_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowPhaseProjection"}}},"description":"Request completed successfully.","headers":{"X-Request-ID":{"description":"Opaque correlation ID to include when contacting XY support.","schema":{"pattern":"^mreq_[A-Za-z0-9_-]+$","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}},"security":[{"bearerAuth":[]}],"summary":"Get workflow phases","tags":["Run observability"]}},"/health":{"get":{"description":"Confirm that the public Developer API process is running.","operationId":"checkHealth","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}},"description":"The service is healthy."}},"security":[],"summary":"Check service health","tags":["Health"]}}},"servers":[{"description":"Current environment","url":"https://api.xy.ai"}],"tags":[{"description":"Validate organization-scoped bearer credentials before making capability calls.","name":"Authentication"},{"description":"Discover productized agents published to your organization.","name":"Agent catalog"},{"description":"Configure exact agent versions and the connections they need.","name":"Installations"},{"description":"Upload and manage files used by knowledge-backed agents.","name":"Knowledge sources"},{"description":"Start installed agents and poll their public execution records.","name":"Executions"},{"description":"Read durable review work and submit explicit human decisions.","name":"Human review"},{"description":"Inspect safe workflow phases without changing the run.","name":"Run observability"},{"description":"Run promoted workflow definitions on demand.","name":"Workflow executions"},{"description":"Query governed workflow analytics and render approved metrics.","name":"Analytics"},{"description":"Operate recurring runs of promoted workflow definitions.","name":"Schedules"},{"description":"Build, review, test, export, and explicitly promote reusable workflows.","name":"Workflow Planner"},{"description":"Observe or briefly control the browser currently used by a Planner generation or step test.","name":"Planner browser view"},{"description":"Design workflow operator screens with authorized personal or organization system access. queue_ui:read/write/publish are independent opt-in public scopes for both API-key types. Sensitive queue_ui:approve is system-key-only and requires an exact version and resolved hash; human web approval remains separate. Live delegated ceilings, principal identity, feature availability, ownership, and resource permissions are rechecked. Approval does not publish, and publishing requires its own scope and live-version comparison.","name":"Queue UI Designer"},{"description":"Coordinate Planner, Browser Copilot, and queue design sessions. Queue designs retain their own scopes and run-specific events endpoint.","name":"Session coordination"},{"description":"Develop one browser step in a retained Chrome authoring session.","name":"Browser Studio"},{"description":"Manage secret-backed references without returning stored credential values.","name":"Runtime credentials"},{"description":"Browse global and organization-owned executable integration contracts.","name":"Integrations"},{"description":"Attach encrypted credential references to integrations for workflow execution.","name":"Integration connections"},{"description":"Discover, generate, validate, and promote organization-scoped integrations through durable jobs.","name":"Integration Factory"},{"description":"Provision and inspect the dedicated organization number used by browser workflows for SMS verification.","name":"SMS inbox"},{"description":"Inspect organization-level capacity and quota consumption.","name":"Usage"},{"description":"Request custom work outside the published agent catalog.","name":"Custom agent requests"},{"description":"Public service readiness.","name":"Health"}]}