components: schemas: AccessTypeEnum: enum: - PRIVATE - PUBLIC - WORKSPACE - TENANT title: AccessTypeEnum type: string AssistantRequest: description: Request model for assistant interactions. properties: component_id: anyOf: - type: string - type: 'null' title: Component Id field_name: anyOf: - type: string - type: 'null' title: Field Name flow_id: title: Flow Id type: string input_value: anyOf: - maxLength: 2000 type: string - type: 'null' title: Input Value max_retries: anyOf: - maximum: 5 minimum: 1 type: integer - type: 'null' title: Max Retries model_name: anyOf: - type: string - type: 'null' title: Model Name provider: anyOf: - type: string - type: 'null' title: Provider session_id: anyOf: - type: string - type: 'null' title: Session Id required: - flow_id title: AssistantRequest type: object AuthSettings: description: Model representing authentication settings for MCP. properties: auth_type: default: none enum: - none - apikey - oauth title: Auth Type type: string oauth_auth_url: anyOf: - type: string - type: 'null' title: Oauth Auth Url oauth_callback_path: anyOf: - type: string - type: 'null' title: Oauth Callback Path oauth_callback_url: anyOf: - type: string - type: 'null' title: Oauth Callback Url oauth_client_id: anyOf: - type: string - type: 'null' title: Oauth Client Id oauth_client_secret: anyOf: - format: password type: string writeOnly: true - type: 'null' title: Oauth Client Secret oauth_host: anyOf: - type: string - type: 'null' title: Oauth Host oauth_mcp_scope: anyOf: - type: string - type: 'null' title: Oauth Mcp Scope oauth_port: anyOf: - type: string - type: 'null' title: Oauth Port oauth_provider_scope: anyOf: - type: string - type: 'null' title: Oauth Provider Scope oauth_server_url: anyOf: - type: string - type: 'null' title: Oauth Server Url oauth_token_url: anyOf: - type: string - type: 'null' title: Oauth Token Url title: AuthSettings type: object AuthzAuditLogRead: description: Read-only projection of an ``AuthzAuditLog`` row. properties: action: title: Action type: string details: anyOf: - additionalProperties: true type: object - type: 'null' title: Details id: format: uuid title: Id type: string resource_id: anyOf: - format: uuid type: string - type: 'null' title: Resource Id resource_type: anyOf: - type: string - type: 'null' title: Resource Type result: title: Result type: string timestamp: format: date-time title: Timestamp type: string user_id: anyOf: - format: uuid type: string - type: 'null' title: User Id required: - id - user_id - action - resource_type - resource_id - result - details - timestamp title: AuthzAuditLogRead type: object AuthzAuditPage: description: Paginated audit-log response. properties: items: items: $ref: '#/components/schemas/AuthzAuditLogRead' title: Items type: array page: title: Page type: integer pages: title: Pages type: integer size: title: Size type: integer total: title: Total type: integer required: - items - total - page - size - pages title: AuthzAuditPage type: object Body_build_flow_api_v1_build__flow_id__flow_post: properties: data: anyOf: - $ref: '#/components/schemas/FlowDataRequest' - type: 'null' files: anyOf: - items: type: string type: array - type: 'null' title: Files inputs: anyOf: - $ref: '#/components/schemas/InputValueRequest' - type: 'null' title: Body_build_flow_api_v1_build__flow_id__flow_post type: object Body_build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post: properties: files: anyOf: - items: type: string type: array - type: 'null' title: Files inputs: anyOf: - $ref: '#/components/schemas/InputValueRequest' - type: 'null' title: Body_build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post type: object Body_experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post: properties: inputs: anyOf: - items: $ref: '#/components/schemas/InputValueRequest' type: array - type: 'null' title: Inputs outputs: anyOf: - items: type: string type: array - type: 'null' title: Outputs session_id: anyOf: - type: string - type: 'null' title: Session Id stream: default: false title: Stream type: boolean tweaks: anyOf: - $ref: '#/components/schemas/Tweaks' - type: 'null' title: Body_experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post type: object Body_simplified_run_flow_api_v1_run__flow_id_or_name__post: properties: context: anyOf: - additionalProperties: true type: object - type: 'null' title: Context input_request: anyOf: - $ref: '#/components/schemas/SimplifiedAPIRequest' - type: 'null' title: Body_simplified_run_flow_api_v1_run__flow_id_or_name__post type: object Body_upload_file_api_v1_files_upload__flow_id__post: properties: file: contentMediaType: application/octet-stream title: File type: string required: - file title: Body_upload_file_api_v1_files_upload__flow_id__post type: object Body_upload_file_api_v1_flows_upload__post: properties: file: anyOf: - contentMediaType: application/octet-stream type: string - type: 'null' title: File title: Body_upload_file_api_v1_flows_upload__post type: object Body_upload_file_api_v1_projects_upload__post: properties: file: anyOf: - contentMediaType: application/octet-stream type: string - type: 'null' title: File title: Body_upload_file_api_v1_projects_upload__post type: object Body_upload_user_file_api_v2_files__post: properties: file: contentMediaType: application/octet-stream title: File type: string required: - file title: Body_upload_user_file_api_v2_files__post type: object Body_upload_user_file_api_v2_files_post: properties: file: contentMediaType: application/octet-stream title: File type: string required: - file title: Body_upload_user_file_api_v2_files_post type: object Body_upload_vibe_attachment_api_v1_agentic_vibe_attachments_post: properties: file: contentMediaType: application/octet-stream title: File type: string required: - file title: Body_upload_vibe_attachment_api_v1_agentic_vibe_attachments_post type: object BundleBuildResponse: description: Bundle build response. properties: bundle_path: title: Bundle Path type: string bundle_size: title: Bundle Size type: integer dependencies: items: type: string title: Dependencies type: array flow_id: title: Flow Id type: string flow_name: title: Flow Name type: string version: title: Version type: string required: - flow_id - flow_name - bundle_path - bundle_size - dependencies - version title: BundleBuildResponse type: object CancelFlowResponse: description: Response model for flow build cancellation. properties: message: title: Message type: string success: title: Success type: boolean required: - success - message title: CancelFlowResponse type: object ChatOutputResponse: description: Chat output response schema. properties: component_id: anyOf: - type: string - type: 'null' title: Component Id files: default: [] items: $ref: '#/components/schemas/lfx__utils__schemas__File' title: Files type: array message: anyOf: - type: string - items: anyOf: - type: string - additionalProperties: true type: object type: array title: Message sender: anyOf: - type: string - type: 'null' default: Machine title: Sender sender_name: anyOf: - type: string - type: 'null' default: AI title: Sender Name session_id: anyOf: - type: string - type: 'null' title: Session Id stream_url: anyOf: - type: string - type: 'null' title: Stream Url type: title: Type type: string required: - message - type title: ChatOutputResponse type: object CloudBuildLogsResponse: description: Cloud Build logs fetched through the Studio backend. properties: build_id: title: Build Id type: string log_url: anyOf: - type: string - type: 'null' title: Log Url logs: items: type: string title: Logs type: array status: anyOf: - type: string - type: 'null' title: Status required: - build_id - logs title: CloudBuildLogsResponse type: object CodeContent-Input: description: Content type for code snippets. properties: code: title: Code type: string duration: anyOf: - type: integer - type: 'null' title: Duration header: anyOf: - $ref: '#/components/schemas/HeaderDict' - type: 'null' language: title: Language type: string title: anyOf: - type: string - type: 'null' title: Title type: const: code default: code title: Type type: string required: - code - language title: CodeContent type: object CodeContent-Output: additionalProperties: true type: object ComponentOutput: description: Component output schema. properties: content: anyOf: - {} - type: 'null' title: Content metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata status: $ref: '#/components/schemas/JobStatus' type: description: >- Type of the component output (e.g., 'message', 'data', 'tool', 'text') title: Type type: string required: - type - status title: ComponentOutput type: object ComposerUrlResponse: description: Response model for MCP Composer connection details. properties: error_message: anyOf: - type: string - type: 'null' title: Error Message legacy_sse_url: anyOf: - type: string - type: 'null' title: Legacy Sse Url project_id: title: Project Id type: string streamable_http_url: anyOf: - type: string - type: 'null' title: Streamable Http Url uses_composer: title: Uses Composer type: boolean required: - project_id - uses_composer title: ComposerUrlResponse type: object ConfigResponse: description: >- Full configuration response for authenticated users. The 'type' field is a discriminator to distinguish from PublicConfigResponse. properties: allow_custom_components: title: Allow Custom Components type: boolean authz_enabled: default: false title: Authz Enabled type: boolean auto_saving: title: Auto Saving type: boolean auto_saving_interval: title: Auto Saving Interval type: integer custom_component_admin_only: title: Custom Component Admin Only type: boolean default_folder_name: title: Default Folder Name type: string embedded_mode: title: Embedded Mode type: boolean enable_extension_reload: title: Enable Extension Reload type: boolean event_delivery: enum: - polling - streaming - direct title: Event Delivery type: string feature_flags: $ref: '#/components/schemas/FeatureFlags' frontend_timeout: title: Frontend Timeout type: integer health_check_max_retries: title: Health Check Max Retries type: integer hide_getting_started_progress: title: Hide Getting Started Progress type: boolean hide_logout_button: title: Hide Logout Button type: boolean hide_new_flow_button: title: Hide New Flow Button type: boolean hide_new_project_button: title: Hide New Project Button type: boolean hide_starter_projects: title: Hide Starter Projects type: boolean max_file_size_upload: title: Max File Size Upload type: integer mcp_base_url: title: Mcp Base Url type: string mcp_servers_locked: title: Mcp Servers Locked type: boolean public_flow_cleanup_interval: title: Public Flow Cleanup Interval type: integer public_flow_expiration: title: Public Flow Expiration type: integer serialization_max_items_length: title: Serialization Max Items Length type: integer serialization_max_text_length: title: Serialization Max Text Length type: integer signup_blocked_email_domains: default: [] items: type: string title: Signup Blocked Email Domains type: array type: const: full default: full title: Type type: string voice_mode_available: title: Voice Mode Available type: boolean webhook_auth_enable: title: Webhook Auth Enable type: boolean webhook_polling_interval: title: Webhook Polling Interval type: integer required: - feature_flags - max_file_size_upload - event_delivery - voice_mode_available - frontend_timeout - mcp_base_url - enable_extension_reload - serialization_max_items_length - serialization_max_text_length - auto_saving - auto_saving_interval - health_check_max_retries - webhook_polling_interval - public_flow_cleanup_interval - public_flow_expiration - webhook_auth_enable - default_folder_name - hide_getting_started_progress - allow_custom_components - embedded_mode - hide_logout_button - hide_new_project_button - hide_new_flow_button - hide_starter_projects - mcp_servers_locked - custom_component_admin_only title: ConfigResponse type: object ContentBlock-Input: description: A block of content that can contain different types of content. properties: allow_markdown: default: true title: Allow Markdown type: boolean contents: items: oneOf: - $ref: '#/components/schemas/ToolContent-Input' - $ref: '#/components/schemas/ErrorContent-Input' - $ref: '#/components/schemas/TextContent-Input' - $ref: '#/components/schemas/MediaContent-Input' - $ref: '#/components/schemas/CodeContent-Input' - $ref: '#/components/schemas/JSONContent-Input' title: Contents type: array media_url: anyOf: - items: type: string type: array - type: 'null' title: Media Url title: title: Title type: string required: - title - contents title: ContentBlock type: object ContentBlock-Output: description: A block of content that can contain different types of content. properties: allow_markdown: default: true title: Allow Markdown type: boolean contents: items: additionalProperties: true type: object title: Contents type: array media_url: anyOf: - items: type: string type: array - type: 'null' title: Media Url title: title: Title type: string required: - title - contents title: ContentBlock type: object CreateFileFolder: properties: name: maxLength: 120 minLength: 1 title: Name type: string parent_id: anyOf: - format: uuid type: string - type: 'null' title: Parent Id source_path: anyOf: - maxLength: 400 type: string - type: 'null' title: Source Path required: - name title: CreateFileFolder type: object CreatePublishedAgentSessionRequest: properties: session_metadata: additionalProperties: true title: Session Metadata type: object title: anyOf: - maxLength: 512 type: string - type: 'null' title: Title title: CreatePublishedAgentSessionRequest type: object DependencyDiagnosticResponse: properties: blocking: title: Blocking type: boolean code: title: Code type: string import_name: anyOf: - type: string - type: 'null' title: Import Name message: title: Message type: string node_id: anyOf: - type: string - type: 'null' title: Node Id requirement: anyOf: - type: string - type: 'null' title: Requirement severity: title: Severity type: string suggestion: anyOf: - type: string - type: 'null' title: Suggestion required: - code - message - severity - blocking title: DependencyDiagnosticResponse type: object DependencyMappingResponse: properties: distribution_name: title: Distribution Name type: string import_name: title: Import Name type: string node_id: anyOf: - type: string - type: 'null' title: Node Id source: title: Source type: string required: - import_name - distribution_name - source title: DependencyMappingResponse type: object DependencyResolutionResponse: description: >- Dependency preview produced by the bundle builder's authoritative resolver. properties: blocking_diagnostics: items: $ref: '#/components/schemas/DependencyDiagnosticResponse' title: Blocking Diagnostics type: array component_count: title: Component Count type: integer constraints: items: type: string title: Constraints type: array constraints_fingerprint: title: Constraints Fingerprint type: string custom_code_count: title: Custom Code Count type: integer dependencies: items: type: string title: Dependencies type: array diagnostics: items: $ref: '#/components/schemas/DependencyDiagnosticResponse' title: Diagnostics type: array fingerprint: title: Fingerprint type: string flow_fingerprint: title: Flow Fingerprint type: string flow_id: title: Flow Id type: string flow_name: title: Flow Name type: string has_blocking_diagnostics: title: Has Blocking Diagnostics type: boolean locked_dependencies: items: type: string title: Locked Dependencies type: array locked_dependency_count: title: Locked Dependency Count type: integer mappings: items: $ref: '#/components/schemas/DependencyMappingResponse' title: Mappings type: array runtime_fingerprint: title: Runtime Fingerprint type: string warnings: items: $ref: '#/components/schemas/DependencyDiagnosticResponse' title: Warnings type: array required: - flow_id - flow_name - dependencies - locked_dependencies - locked_dependency_count - mappings - diagnostics - warnings - blocking_diagnostics - has_blocking_diagnostics - fingerprint - flow_fingerprint - constraints_fingerprint - runtime_fingerprint - constraints - component_count - custom_code_count title: DependencyResolutionResponse type: object DeployAgentRequest: description: Deploy agent request. properties: resolution_fingerprint: maxLength: 64 minLength: 64 pattern: ^[0-9a-f]{64}$ title: Resolution Fingerprint type: string version: default: 1.0.0 title: Version type: string required: - resolution_fingerprint title: DeployAgentRequest type: object DeployAgentResponse: description: Deploy agent response. properties: deployment_id: title: Deployment Id type: string flow_id: title: Flow Id type: string flow_name: title: Flow Name type: string message: title: Message type: string status: title: Status type: string required: - deployment_id - flow_id - flow_name - status - message title: DeployAgentResponse type: object DeploymentStatusResponse: description: Deployment status response. properties: build_id: anyOf: - type: string - type: 'null' title: Build Id bundle_path: anyOf: - type: string - type: 'null' title: Bundle Path deployment_id: title: Deployment Id type: string error: anyOf: - type: string - type: 'null' title: Error flow_id: title: Flow Id type: string flow_name: title: Flow Name type: string image_name: anyOf: - type: string - type: 'null' title: Image Name last_updated: anyOf: - type: string - type: 'null' title: Last Updated log_url: anyOf: - type: string - type: 'null' title: Log Url logs: anyOf: - items: type: string type: array - type: 'null' title: Logs operation_name: anyOf: - type: string - type: 'null' title: Operation Name progress: anyOf: - type: string - type: 'null' title: Progress status: title: Status type: string version: title: Version type: string required: - deployment_id - status - flow_id - flow_name - version title: DeploymentStatusResponse type: object DirectoryConnectionTestRequest: properties: username: anyOf: - maxLength: 320 type: string - type: 'null' title: Username title: DirectoryConnectionTestRequest type: object DirectoryConnectionTestResponse: properties: network: title: Network type: boolean provider: title: Provider type: string search: title: Search type: boolean service_bind: title: Service Bind type: boolean tls: title: Tls type: boolean user_found: anyOf: - type: boolean - type: 'null' title: User Found required: - provider - network - tls - service_bind - search - user_found title: DirectoryConnectionTestResponse type: object EffectivePermissionsRequest: description: Body for :func:`get_effective_permissions`. properties: actions: anyOf: - items: type: string type: array - type: 'null' description: >- Actions to check. Each entry is lowercased and de-duplicated; the list is capped at 10. Defaults to read/write/execute/delete/create. title: Actions domain: default: '*' description: Authorization domain — typically ``project:{folder_id}`` or ``*``. title: Domain type: string resource_ids: description: >- Resource IDs to evaluate. Capped at 500 per request to keep batch_enforce bounded. items: format: uuid type: string title: Resource Ids type: array resource_type: enum: - flow - deployment - project - knowledge_base - variable - file - component title: Resource Type type: string required: - resource_type - resource_ids title: EffectivePermissionsRequest type: object EffectivePermissionsResponse: description: 'Response: ``{resource_id: [allowed_actions]}``.' properties: permissions: additionalProperties: items: type: string type: array propertyNames: format: uuid title: Permissions type: object resource_type: enum: - flow - deployment - project - knowledge_base - variable - file - component title: Resource Type type: string required: - resource_type - permissions title: EffectivePermissionsResponse type: object ErrorContent-Input: description: Content type for error messages. properties: component: anyOf: - type: string - type: 'null' title: Component duration: anyOf: - type: integer - type: 'null' title: Duration field: anyOf: - type: string - type: 'null' title: Field header: anyOf: - $ref: '#/components/schemas/HeaderDict' - type: 'null' reason: anyOf: - type: string - type: 'null' title: Reason solution: anyOf: - type: string - type: 'null' title: Solution traceback: anyOf: - type: string - type: 'null' title: Traceback type: const: error default: error title: Type type: string title: ErrorContent type: object ErrorContent-Output: additionalProperties: true type: object ErrorDetail: description: Error detail schema. properties: code: anyOf: - type: string - type: 'null' title: Code details: anyOf: - additionalProperties: true type: object - type: 'null' title: Details error: title: Error type: string required: - error title: ErrorDetail type: object EventDeliveryType: enum: - streaming - direct - polling title: EventDeliveryType type: string ExtensionEventResponse: properties: payload: additionalProperties: true title: Payload type: object timestamp: title: Timestamp type: number type: title: Type type: string required: - type - timestamp - payload title: ExtensionEventResponse type: object ExtensionEventsResponse: properties: events: items: $ref: '#/components/schemas/ExtensionEventResponse' title: Events type: array settled: title: Settled type: boolean required: - events - settled title: ExtensionEventsResponse type: object FeatureFlags: additionalProperties: false properties: mvp_components: default: false title: Mvp Components type: boolean wxo_deployments: default: false title: Wxo Deployments type: boolean title: FeatureFlags type: object FlowCopyToPersonRequest: properties: include_api_keys: default: false title: Include Api Keys type: boolean target_user_id: format: uuid title: Target User Id type: string required: - target_user_id title: FlowCopyToPersonRequest type: object FlowCopyToWorkspaceRequest: properties: include_api_keys: default: false title: Include Api Keys type: boolean target_workspace_id: format: uuid title: Target Workspace Id type: string required: - target_workspace_id title: FlowCopyToWorkspaceRequest type: object FlowCreate: properties: access_type: $ref: '#/components/schemas/AccessTypeEnum' default: PRIVATE action_description: anyOf: - type: string - type: 'null' description: The description of the action associated with the flow title: Action Description action_name: anyOf: - type: string - type: 'null' description: The name of the action associated with the flow title: Action Name data: anyOf: - additionalProperties: true type: object - type: 'null' title: Data description: anyOf: - type: string - type: 'null' title: Description endpoint_name: anyOf: - type: string - type: 'null' title: Endpoint Name folder_id: anyOf: - format: uuid type: string - type: 'null' title: Folder Id fs_path: anyOf: - type: string - type: 'null' title: Fs Path gradient: anyOf: - type: string - type: 'null' title: Gradient icon: anyOf: - type: string - type: 'null' title: Icon icon_bg_color: anyOf: - type: string - type: 'null' title: Icon Bg Color id: anyOf: - format: uuid type: string - type: 'null' title: Id is_component: anyOf: - type: boolean - type: 'null' default: false title: Is Component locked: anyOf: - type: boolean - type: 'null' default: false title: Locked mcp_enabled: anyOf: - type: boolean - type: 'null' default: false description: Can be exposed in the MCP server title: Mcp Enabled name: title: Name type: string tags: anyOf: - items: type: string type: array - type: 'null' title: Tags updated_at: anyOf: - format: date-time type: string - type: 'null' title: Updated At user_id: anyOf: - format: uuid type: string - type: 'null' title: User Id webhook: anyOf: - type: boolean - type: 'null' default: false description: Can be used on the webhook endpoint title: Webhook workspace_id: anyOf: - format: uuid type: string - type: 'null' title: Workspace Id required: - name title: FlowCreate type: object FlowDataRequest: properties: edges: items: additionalProperties: true type: object title: Edges type: array nodes: items: additionalProperties: true type: object title: Nodes type: array viewport: anyOf: - additionalProperties: true type: object - type: 'null' title: Viewport required: - nodes - edges title: FlowDataRequest type: object FlowEventCreate: properties: summary: default: '' maxLength: 500 title: Summary type: string type: enum: - component_added - component_removed - component_configured - connection_added - connection_removed - flow_updated - flow_settled title: Type type: string required: - type title: FlowEventCreate type: object FlowEventResponse: properties: summary: title: Summary type: string timestamp: title: Timestamp type: number type: title: Type type: string required: - type - timestamp - summary title: FlowEventResponse type: object FlowEventsResponse: properties: events: items: $ref: '#/components/schemas/FlowEventResponse' title: Events type: array settled: title: Settled type: boolean required: - events - settled title: FlowEventsResponse type: object FlowHeader: description: Model representing a header for a flow - Without the data. properties: access_type: anyOf: - $ref: '#/components/schemas/AccessTypeEnum' - type: 'null' description: The access type of the flow action_description: anyOf: - type: string - type: 'null' description: The description of the action associated with the flow title: Action Description action_name: anyOf: - type: string - type: 'null' description: The name of the action associated with the flow title: Action Name data: anyOf: - additionalProperties: true type: object - type: 'null' description: The data of the component, if is_component is True title: Data description: anyOf: - type: string - type: 'null' description: A description of the flow title: Description endpoint_name: anyOf: - type: string - type: 'null' description: The name of the endpoint associated with this flow title: Endpoint Name folder_id: anyOf: - format: uuid type: string - type: 'null' description: >- The ID of the folder containing the flow. None if not associated with a folder title: Folder Id id: description: Unique identifier for the flow format: uuid title: Id type: string is_component: anyOf: - type: boolean - type: 'null' description: Flag indicating whether the flow is a component title: Is Component mcp_enabled: anyOf: - type: boolean - type: 'null' description: Flag indicating whether the flow is exposed in the MCP server title: Mcp Enabled name: description: The name of the flow title: Name type: string tags: anyOf: - items: type: string type: array - type: 'null' description: The tags of the flow title: Tags required: - id - name title: FlowHeader type: object FlowListCreate: properties: flows: items: $ref: '#/components/schemas/FlowCreate' title: Flows type: array required: - flows title: FlowListCreate type: object FlowRead: properties: access_type: $ref: '#/components/schemas/AccessTypeEnum' default: PRIVATE action_description: anyOf: - type: string - type: 'null' description: The description of the action associated with the flow title: Action Description action_name: anyOf: - type: string - type: 'null' description: The name of the action associated with the flow title: Action Name data: anyOf: - additionalProperties: true type: object - type: 'null' title: Data description: anyOf: - type: string - type: 'null' title: Description endpoint_name: anyOf: - type: string - type: 'null' title: Endpoint Name folder_id: anyOf: - format: uuid type: string - type: 'null' title: Folder Id gradient: anyOf: - type: string - type: 'null' title: Gradient icon: anyOf: - type: string - type: 'null' title: Icon icon_bg_color: anyOf: - type: string - type: 'null' title: Icon Bg Color id: format: uuid title: Id type: string is_component: anyOf: - type: boolean - type: 'null' default: false title: Is Component locked: anyOf: - type: boolean - type: 'null' default: false title: Locked mcp_enabled: anyOf: - type: boolean - type: 'null' default: false description: Can be exposed in the MCP server title: Mcp Enabled name: title: Name type: string name_key: anyOf: - type: string - type: 'null' description: Stable i18n key derived from the original English name title: Name Key tags: anyOf: - items: type: string type: array - type: 'null' description: The tags of the flow title: Tags updated_at: anyOf: - format: date-time type: string - type: 'null' title: Updated At user_id: anyOf: - format: uuid type: string - type: 'null' title: User Id webhook: anyOf: - type: boolean - type: 'null' default: false description: Can be used on the webhook endpoint title: Webhook workspace_id: anyOf: - format: uuid type: string - type: 'null' title: Workspace Id required: - name - id - user_id - folder_id title: FlowRead type: object FlowShareInfo: description: Flow share information model. properties: access_type: title: Access Type type: string flow_id: format: uuid title: Flow Id type: string flow_name: title: Flow Name type: string last_shared: anyOf: - format: date-time type: string - type: 'null' title: Last Shared owner_id: format: uuid title: Owner Id type: string share_count: title: Share Count type: integer shared_with_users: items: format: uuid type: string title: Shared With Users type: array shared_with_workspaces: items: format: uuid type: string title: Shared With Workspaces type: array required: - flow_id - flow_name - owner_id - access_type - shared_with_users - shared_with_workspaces - share_count - last_shared title: FlowShareInfo type: object FlowShareRequest: description: Flow share request model. properties: message: anyOf: - type: string - type: 'null' title: Message permissions: anyOf: - items: type: string type: array - type: 'null' default: - read title: Permissions user_ids: anyOf: - items: format: uuid type: string type: array - type: 'null' title: User Ids workspace_ids: anyOf: - items: format: uuid type: string type: array - type: 'null' title: Workspace Ids title: FlowShareRequest type: object FlowShareResponse: properties: errors: items: type: string title: Errors type: array flow_id: format: uuid title: Flow Id type: string flow_name: title: Flow Name type: string shared_with_users: items: format: uuid type: string title: Shared With Users type: array shared_with_workspaces: items: format: uuid type: string title: Shared With Workspaces type: array required: - flow_id - flow_name - shared_with_users - shared_with_workspaces - errors title: FlowShareResponse type: object FlowUnshareRequest: properties: user_ids: anyOf: - items: format: uuid type: string type: array - type: 'null' title: User Ids workspace_ids: anyOf: - items: format: uuid type: string type: array - type: 'null' title: Workspace Ids title: FlowUnshareRequest type: object FlowUnshareResponse: properties: flow_id: format: uuid title: Flow Id type: string flow_name: title: Flow Name type: string unshared_from_users: items: format: uuid type: string title: Unshared From Users type: array unshared_from_workspaces: items: format: uuid type: string title: Unshared From Workspaces type: array required: - flow_id - flow_name - unshared_from_users - unshared_from_workspaces title: FlowUnshareResponse type: object FlowUpdate: properties: access_type: anyOf: - $ref: '#/components/schemas/AccessTypeEnum' - type: 'null' action_description: anyOf: - type: string - type: 'null' title: Action Description action_name: anyOf: - type: string - type: 'null' title: Action Name data: anyOf: - additionalProperties: true type: object - type: 'null' title: Data description: anyOf: - type: string - type: 'null' title: Description endpoint_name: anyOf: - type: string - type: 'null' title: Endpoint Name folder_id: anyOf: - format: uuid type: string - type: 'null' title: Folder Id fs_path: anyOf: - type: string - type: 'null' title: Fs Path locked: anyOf: - type: boolean - type: 'null' title: Locked mcp_enabled: anyOf: - type: boolean - type: 'null' title: Mcp Enabled name: anyOf: - type: string - type: 'null' title: Name workspace_id: anyOf: - format: uuid type: string - type: 'null' title: Workspace Id title: FlowUpdate type: object FolderCreate: properties: auth_settings: anyOf: - additionalProperties: true type: object - type: 'null' title: Auth Settings components_list: anyOf: - items: format: uuid type: string type: array - type: 'null' title: Components List description: anyOf: - type: string - type: 'null' title: Description flows_list: anyOf: - items: format: uuid type: string type: array - type: 'null' title: Flows List name: title: Name type: string required: - name title: FolderCreate type: object FolderRead: properties: description: anyOf: - type: string - type: 'null' title: Description id: format: uuid title: Id type: string name: title: Name type: string parent_id: anyOf: - format: uuid type: string - type: 'null' title: Parent Id tenant_id: anyOf: - format: uuid type: string - type: 'null' description: Tenant ID if tenant scoped title: Tenant Id workspace_id: anyOf: - format: uuid type: string - type: 'null' description: Workspace ID if workspace scoped title: Workspace Id required: - name - id - parent_id title: FolderRead type: object FolderReadWithFlows: properties: description: anyOf: - type: string - type: 'null' title: Description flows: default: [] items: $ref: '#/components/schemas/FlowRead' title: Flows type: array id: format: uuid title: Id type: string name: title: Name type: string parent_id: anyOf: - format: uuid type: string - type: 'null' title: Parent Id required: - name - id - parent_id title: FolderReadWithFlows type: object FolderUpdate: properties: auth_settings: anyOf: - additionalProperties: true type: object - type: 'null' title: Auth Settings components: items: format: uuid type: string title: Components type: array description: anyOf: - type: string - type: 'null' title: Description flows: items: format: uuid type: string title: Flows type: array name: anyOf: - type: string - type: 'null' title: Name parent_id: anyOf: - format: uuid type: string - type: 'null' title: Parent Id title: FolderUpdate type: object FolderWithPaginatedFlows: properties: flows: $ref: '#/components/schemas/Page_FlowRead_' folder: $ref: '#/components/schemas/FolderRead' required: - folder - flows title: FolderWithPaginatedFlows type: object ForgotPasswordRequest: description: Request model for initiating password reset. properties: email: title: Email type: string required: - email title: ForgotPasswordRequest type: object GraphData: properties: edges: items: additionalProperties: true type: object title: Edges type: array nodes: items: additionalProperties: true type: object title: Nodes type: array viewport: anyOf: - $ref: '#/components/schemas/ViewPort' - type: 'null' required: - nodes - edges title: GraphData type: object GraphDumpResponse: properties: data: $ref: '#/components/schemas/GraphData' description: anyOf: - type: string - type: 'null' title: Description endpoint_name: anyOf: - type: string - type: 'null' title: Endpoint Name is_component: anyOf: - type: boolean - type: 'null' title: Is Component name: anyOf: - type: string - type: 'null' title: Name required: - data title: GraphDumpResponse type: object HITLRequestPublic: properties: actions_json: anyOf: - items: {} type: array - type: 'null' title: Actions Json allowed_user_ids: anyOf: - items: {} type: array - type: 'null' title: Allowed User Ids created_at: format: date-time title: Created At type: string expires_at: anyOf: - format: date-time type: string - type: 'null' title: Expires At form_schema_json: anyOf: - additionalProperties: true type: object - type: 'null' title: Form Schema Json id: format: uuid title: Id type: string job_id: anyOf: - type: string - type: 'null' title: Job Id node_id: title: Node Id type: string rendered_content: anyOf: - type: string - type: 'null' title: Rendered Content selected_action_id: anyOf: - type: string - type: 'null' title: Selected Action Id status: title: Status type: string submitted_data_json: anyOf: - additionalProperties: true type: object - type: 'null' title: Submitted Data Json updated_at: format: date-time title: Updated At type: string workflow_run_id: format: uuid title: Workflow Run Id type: string required: - id - workflow_run_id - node_id - status - created_at - updated_at title: HITLRequestPublic type: object HITLSubmitBody: properties: cache_key: anyOf: - type: string - type: 'null' title: Cache Key selected_action_id: anyOf: - type: string - type: 'null' title: Selected Action Id submitted_data: additionalProperties: true title: Submitted Data type: object title: HITLSubmitBody type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object HeaderDict: properties: icon: anyOf: - type: string - type: 'null' title: Icon title: anyOf: - type: string - type: 'null' title: Title title: HeaderDict type: object HealthResponse: properties: chat: default: error check the server logs title: Chat type: string db: default: error check the server logs title: Db type: string status: default: nok title: Status type: string title: HealthResponse type: object InputValueRequest: additionalProperties: false examples: - components: - components_id - Component Name input_value: input_value session: session_id - components: - Component Name input_value: input_value - input_value: input_value - components: - Component Name input_value: input_value session: session_id - input_value: input_value session: session_id - input_value: input_value type: chat - input_value: '{"key": "value"}' type: json properties: client_request_time: anyOf: - type: integer - type: 'null' description: >- Client-side timestamp in milliseconds when the request was initiated. Used to calculate accurate end-to-end duration. title: Client Request Time components: anyOf: - items: type: string type: array - type: 'null' default: [] title: Components input_value: anyOf: - type: string - type: 'null' title: Input Value session: anyOf: - type: string - type: 'null' title: Session type: anyOf: - enum: - chat - text - any type: string - type: 'null' default: any description: >- Defines on which components the input value should be applied. 'any' applies to all input components. title: Type title: InputValueRequest type: object JSONContent-Input: description: Content type for JSON content. properties: data: additionalProperties: true title: Data type: object duration: anyOf: - type: integer - type: 'null' title: Duration header: anyOf: - $ref: '#/components/schemas/HeaderDict' - type: 'null' type: const: json default: json title: Type type: string required: - data title: JSONContent type: object JSONContent-Output: additionalProperties: true type: object JobStatus: description: Job execution status. enum: - queued - in_progress - completed - failed - cancelled - timed_out title: JobStatus type: string MCPInstallRequest: properties: client: title: Client type: string transport: anyOf: - enum: - sse - streamablehttp type: string - type: 'null' title: Transport required: - client title: MCPInstallRequest type: object MCPProjectUpdateRequest: description: Request model for updating MCP project settings including auth. properties: auth_settings: anyOf: - $ref: '#/components/schemas/AuthSettings' - type: 'null' settings: items: $ref: '#/components/schemas/MCPSettings' title: Settings type: array required: - settings title: MCPProjectUpdateRequest type: object MCPSettings: description: Model representing MCP settings for a flow. properties: action_description: anyOf: - type: string - type: 'null' title: Action Description action_name: anyOf: - type: string - type: 'null' title: Action Name description: anyOf: - type: string - type: 'null' title: Description id: format: uuid title: Id type: string mcp_enabled: anyOf: - type: boolean - type: 'null' title: Mcp Enabled name: anyOf: - type: string - type: 'null' title: Name required: - id title: MCPSettings type: object MediaContent-Input: description: Content type for media content. properties: caption: anyOf: - type: string - type: 'null' title: Caption duration: anyOf: - type: integer - type: 'null' title: Duration header: anyOf: - $ref: '#/components/schemas/HeaderDict' - type: 'null' type: const: media default: media title: Type type: string urls: items: type: string title: Urls type: array required: - urls title: MediaContent type: object MediaContent-Output: additionalProperties: true type: object MessageRead: properties: category: default: message title: Category type: string content_blocks: items: $ref: '#/components/schemas/ContentBlock-Output' title: Content Blocks type: array context_id: anyOf: - type: string - type: 'null' title: Context Id edit: default: false title: Edit type: boolean error: default: false title: Error type: boolean files: items: type: string title: Files type: array flow_id: anyOf: - format: uuid type: string - type: 'null' title: Flow Id id: format: uuid title: Id type: string is_output: default: false title: Is Output type: boolean properties: $ref: '#/components/schemas/Properties' run_id: anyOf: - format: uuid type: string - type: 'null' title: Run Id sender: title: Sender type: string sender_name: title: Sender Name type: string session_id: title: Session Id type: string session_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Session Metadata text: title: Text type: string timestamp: format: date-time title: Timestamp type: string user_id: anyOf: - format: uuid type: string - type: 'null' title: User Id required: - sender - sender_name - session_id - text - id title: MessageRead type: object MessageResponse: properties: category: anyOf: - type: string - type: 'null' title: Category content_blocks: anyOf: - items: $ref: '#/components/schemas/ContentBlock-Output' type: array - type: 'null' title: Content Blocks context_id: anyOf: - type: string - type: 'null' title: Context Id duration: anyOf: - type: number - type: 'null' title: Duration edit: title: Edit type: boolean files: default: [] items: type: string title: Files type: array flow_id: anyOf: - format: uuid type: string - type: 'null' title: Flow Id id: anyOf: - type: string - format: uuid type: string - type: 'null' title: Id properties: anyOf: - $ref: '#/components/schemas/Properties' - type: 'null' sender: title: Sender type: string sender_name: title: Sender Name type: string session_id: title: Session Id type: string session_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Session Metadata text: title: Text type: string timestamp: format: date-time title: Timestamp type: string required: - sender - sender_name - session_id - text - edit title: MessageResponse type: object MessageUpdate: properties: category: anyOf: - type: string - type: 'null' title: Category content_blocks: anyOf: - items: $ref: '#/components/schemas/ContentBlock-Input' type: array - type: 'null' title: Content Blocks edit: anyOf: - type: boolean - type: 'null' title: Edit error: anyOf: - type: boolean - type: 'null' title: Error files: anyOf: - items: type: string type: array - type: 'null' title: Files properties: anyOf: - $ref: '#/components/schemas/Properties' - type: 'null' sender: anyOf: - type: string - type: 'null' title: Sender sender_name: anyOf: - type: string - type: 'null' title: Sender Name session_id: anyOf: - type: string - type: 'null' title: Session Id session_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Session Metadata text: anyOf: - type: string - type: 'null' title: Text title: MessageUpdate type: object OpenAIResponsesRequest: description: OpenAI-compatible responses request with flow_id as model parameter. properties: background: default: false description: Whether to process in background title: Background type: boolean include: anyOf: - items: type: string type: array - type: 'null' description: Additional response data to include, e.g., ['tool_call.results'] title: Include input: description: The input text to process title: Input type: string model: description: The flow ID to execute (used instead of OpenAI model) title: Model type: string previous_response_id: anyOf: - type: string - type: 'null' description: ID of previous response to continue conversation title: Previous Response Id stream: default: false description: Whether to stream the response title: Stream type: boolean tools: anyOf: - items: {} type: array - type: 'null' description: Tools are not supported yet title: Tools required: - model - input title: OpenAIResponsesRequest type: object Page_FlowRead_: properties: items: items: $ref: '#/components/schemas/FlowRead' title: Items type: array page: minimum: 1 title: Page type: integer pages: minimum: 0 title: Pages type: integer size: minimum: 1 title: Size type: integer total: minimum: 0 title: Total type: integer required: - items - total - page - size - pages title: Page[FlowRead] type: object Page_TransactionLogsResponse_: properties: items: items: $ref: '#/components/schemas/TransactionLogsResponse' title: Items type: array page: minimum: 1 title: Page type: integer pages: minimum: 0 title: Pages type: integer size: minimum: 1 title: Size type: integer total: minimum: 0 title: Total type: integer required: - items - total - page - size - pages title: Page[TransactionLogsResponse] type: object PreviousVersionDisableResult: properties: agent_id: title: Agent Id type: string id: format: uuid title: Id type: string previous_status: title: Previous Status type: string status: title: Status type: string version: title: Version type: string required: - id - agent_id - version - previous_status - status title: PreviousVersionDisableResult type: object ProductionRunRead: properties: agent_display_name: anyOf: - type: string - type: 'null' title: Agent Display Name agent_id: anyOf: - type: string - type: 'null' title: Agent Id agent_version: anyOf: - type: string - type: 'null' title: Agent Version created_at: format: date-time title: Created At type: string error_message: anyOf: - type: string - type: 'null' title: Error Message id: format: uuid title: Id type: string input_payload: additionalProperties: true title: Input Payload type: object logs_tail: items: {} title: Logs Tail type: array published_agent_id: anyOf: - format: uuid type: string - type: 'null' title: Published Agent Id result_payload: anyOf: - additionalProperties: true type: object - type: 'null' title: Result Payload session_id: anyOf: - format: uuid type: string - type: 'null' title: Session Id status: title: Status type: string tenant_id: format: uuid title: Tenant Id type: string trigger_message_id: anyOf: - format: uuid type: string - type: 'null' title: Trigger Message Id updated_at: format: date-time title: Updated At type: string required: - id - tenant_id - published_agent_id - session_id - trigger_message_id - status - input_payload - logs_tail - result_payload - error_message - created_at - updated_at title: ProductionRunRead type: object Properties: properties: allow_markdown: default: false title: Allow Markdown type: boolean background_color: anyOf: - type: string - type: 'null' title: Background Color build_duration: anyOf: - type: number - type: 'null' title: Build Duration edited: default: false title: Edited type: boolean icon: anyOf: - type: string - type: 'null' title: Icon positive_feedback: anyOf: - type: boolean - type: 'null' title: Positive Feedback source: $ref: '#/components/schemas/Source' state: default: complete enum: - partial - complete title: State type: string targets: default: [] items: {} title: Targets type: array text_color: anyOf: - type: string - type: 'null' title: Text Color usage: anyOf: - $ref: '#/components/schemas/Usage' - type: 'null' title: Properties type: object PublicConfigResponse: description: >- Configuration response for public/unauthenticated endpoints like the public playground. Contains only the configuration values needed for public features, without sensitive data. The 'type' field is a discriminator to distinguish from full ConfigResponse. properties: allow_custom_components: title: Allow Custom Components type: boolean authz_enabled: default: false title: Authz Enabled type: boolean enable_extension_reload: title: Enable Extension Reload type: boolean event_delivery: enum: - polling - streaming - direct title: Event Delivery type: string feature_flags: $ref: '#/components/schemas/FeatureFlags' frontend_timeout: title: Frontend Timeout type: integer max_file_size_upload: title: Max File Size Upload type: integer mcp_base_url: title: Mcp Base Url type: string type: const: public default: public title: Type type: string voice_mode_available: title: Voice Mode Available type: boolean required: - feature_flags - max_file_size_upload - event_delivery - voice_mode_available - frontend_timeout - mcp_base_url - enable_extension_reload - allow_custom_components title: PublicConfigResponse type: object PublishAgentRequest: properties: agent_id: maxLength: 256 minLength: 1 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ title: Agent Id type: string agent_model_config: additionalProperties: true title: Agent Model Config type: object allowed_tools: items: type: string title: Allowed Tools type: array flow_id: format: uuid title: Flow Id type: string max_runs_per_day: anyOf: - minimum: 1 type: integer - type: 'null' title: Max Runs Per Day max_tokens_per_run: anyOf: - minimum: 1 type: integer - type: 'null' title: Max Tokens Per Run role_names: items: type: string title: Role Names type: array runflow_target_overrides: additionalProperties: type: string title: Runflow Target Overrides type: object runtime_profile: default: chat-standard title: Runtime Profile type: string status: default: draft title: Status type: string timeout_seconds: default: 300 maximum: 86400 minimum: 1 title: Timeout Seconds type: integer version: maxLength: 64 minLength: 1 title: Version type: string visibility: additionalProperties: true title: Visibility type: object required: - flow_id - agent_id - version title: PublishAgentRequest type: object PublishedAgentCatalogItem: properties: agent_id: title: Agent Id type: string agent_model_config: additionalProperties: true title: Agent Model Config type: object allowed_tools: items: {} title: Allowed Tools type: array approved_at: anyOf: - format: date-time type: string - type: 'null' title: Approved At approved_by: anyOf: - format: uuid type: string - type: 'null' title: Approved By capability_manifest: additionalProperties: true title: Capability Manifest type: object created_at: format: date-time title: Created At type: string created_by: anyOf: - format: uuid type: string - type: 'null' title: Created By flow_id: anyOf: - format: uuid type: string - type: 'null' title: Flow Id graph_payload_ref: title: Graph Payload Ref type: string id: format: uuid title: Id type: string latest_build_error: anyOf: - type: string - type: 'null' title: Latest Build Error latest_build_status: anyOf: - type: string - type: 'null' title: Latest Build Status latest_image_ref: anyOf: - type: string - type: 'null' title: Latest Image Ref max_runs_per_day: anyOf: - type: integer - type: 'null' title: Max Runs Per Day max_tokens_per_run: anyOf: - type: integer - type: 'null' title: Max Tokens Per Run runflow_manifest: anyOf: - additionalProperties: true type: object - type: 'null' title: Runflow Manifest runflow_manifest_summary: anyOf: - additionalProperties: true type: object - type: 'null' title: Runflow Manifest Summary runtime_profile: title: Runtime Profile type: string status: title: Status type: string supports_chat: default: true title: Supports Chat type: boolean supports_files: default: true title: Supports Files type: boolean supports_sessions: default: true title: Supports Sessions type: boolean supports_streaming: default: false title: Supports Streaming type: boolean tenant_id: format: uuid title: Tenant Id type: string timeout_seconds: title: Timeout Seconds type: integer updated_at: format: date-time title: Updated At type: string version: title: Version type: string visibility: additionalProperties: true title: Visibility type: object required: - id - tenant_id - agent_id - version - flow_id - graph_payload_ref - runtime_profile - agent_model_config - allowed_tools - timeout_seconds - visibility - capability_manifest - status - created_by - approved_by - approved_at - created_at - updated_at title: PublishedAgentCatalogItem type: object PublishedAgentMessageRead: properties: agent_display_name: anyOf: - type: string - type: 'null' title: Agent Display Name agent_id: anyOf: - type: string - type: 'null' title: Agent Id agent_version: anyOf: - type: string - type: 'null' title: Agent Version created_at: format: date-time title: Created At type: string created_by: anyOf: - format: uuid type: string - type: 'null' title: Created By error: title: Error type: boolean files: items: type: string title: Files type: array id: format: uuid title: Id type: string message_metadata: additionalProperties: true title: Message Metadata type: object published_agent_id: anyOf: - format: uuid type: string - type: 'null' title: Published Agent Id role: title: Role type: string run_id: anyOf: - format: uuid type: string - type: 'null' title: Run Id session_id: format: uuid title: Session Id type: string tenant_id: format: uuid title: Tenant Id type: string text: title: Text type: string updated_at: format: date-time title: Updated At type: string required: - id - tenant_id - published_agent_id - session_id - run_id - created_by - role - text - files - error - message_metadata - created_at - updated_at title: PublishedAgentMessageRead type: object PublishedAgentRead: properties: agent_id: title: Agent Id type: string agent_model_config: additionalProperties: true title: Agent Model Config type: object allowed_tools: items: {} title: Allowed Tools type: array approved_at: anyOf: - format: date-time type: string - type: 'null' title: Approved At approved_by: anyOf: - format: uuid type: string - type: 'null' title: Approved By capability_manifest: additionalProperties: true title: Capability Manifest type: object created_at: format: date-time title: Created At type: string created_by: anyOf: - format: uuid type: string - type: 'null' title: Created By flow_id: anyOf: - format: uuid type: string - type: 'null' title: Flow Id graph_payload_ref: title: Graph Payload Ref type: string id: format: uuid title: Id type: string latest_build_error: anyOf: - type: string - type: 'null' title: Latest Build Error latest_build_status: anyOf: - type: string - type: 'null' title: Latest Build Status latest_image_ref: anyOf: - type: string - type: 'null' title: Latest Image Ref max_runs_per_day: anyOf: - type: integer - type: 'null' title: Max Runs Per Day max_tokens_per_run: anyOf: - type: integer - type: 'null' title: Max Tokens Per Run runflow_manifest: anyOf: - additionalProperties: true type: object - type: 'null' title: Runflow Manifest runflow_manifest_summary: anyOf: - additionalProperties: true type: object - type: 'null' title: Runflow Manifest Summary runtime_profile: title: Runtime Profile type: string status: title: Status type: string tenant_id: format: uuid title: Tenant Id type: string timeout_seconds: title: Timeout Seconds type: integer updated_at: format: date-time title: Updated At type: string version: title: Version type: string visibility: additionalProperties: true title: Visibility type: object required: - id - tenant_id - agent_id - version - flow_id - graph_payload_ref - runtime_profile - agent_model_config - allowed_tools - timeout_seconds - visibility - capability_manifest - status - created_by - approved_by - approved_at - created_at - updated_at title: PublishedAgentRead type: object PublishedAgentSessionRead: properties: agent_display_name: anyOf: - type: string - type: 'null' title: Agent Display Name agent_id: anyOf: - type: string - type: 'null' title: Agent Id agent_version: anyOf: - type: string - type: 'null' title: Agent Version created_at: format: date-time title: Created At type: string created_by: anyOf: - format: uuid type: string - type: 'null' title: Created By id: format: uuid title: Id type: string published_agent_id: anyOf: - format: uuid type: string - type: 'null' title: Published Agent Id session_metadata: additionalProperties: true title: Session Metadata type: object status: title: Status type: string tenant_id: format: uuid title: Tenant Id type: string title: anyOf: - type: string - type: 'null' title: Title updated_at: format: date-time title: Updated At type: string required: - id - tenant_id - published_agent_id - created_by - title - status - session_metadata - created_at - updated_at title: PublishedAgentSessionRead type: object PurgePublishedAgentResponse: properties: deleted: title: Deleted type: boolean image_refs: items: type: string title: Image Refs type: array operation_id: title: Operation Id type: string published_agent_id: format: uuid title: Published Agent Id type: string required: - published_agent_id - operation_id - deleted title: PurgePublishedAgentResponse type: object RemapRunflowTargetReplacement: properties: from_published_agent_id: format: uuid title: From Published Agent Id type: string to_published_agent_id: format: uuid title: To Published Agent Id type: string required: - from_published_agent_id - to_published_agent_id title: RemapRunflowTargetReplacement type: object RemapRunflowTargetsRequest: properties: replacements: items: $ref: '#/components/schemas/RemapRunflowTargetReplacement' minItems: 1 title: Replacements type: array required: - replacements title: RemapRunflowTargetsRequest type: object RemapRunflowTargetsResponse: properties: operation_id: title: Operation Id type: string published_agent_id: format: uuid title: Published Agent Id type: string replaced: title: Replaced type: integer runflow_manifest: anyOf: - additionalProperties: true type: object - type: 'null' title: Runflow Manifest required: - published_agent_id - operation_id - replaced title: RemapRunflowTargetsResponse type: object RenameFileFolder: properties: name: maxLength: 120 minLength: 1 title: Name type: string required: - name title: RenameFileFolder type: object ResendOTPRequest: description: Request model for resending OTP. properties: email: title: Email type: string required: - email title: ResendOTPRequest type: object ResetPasswordRequest: description: Request model for completing password reset with an OTP code. properties: email: title: Email type: string new_password: title: New Password type: string otp_code: title: Otp Code type: string required: - email - otp_code - new_password title: ResetPasswordRequest type: object ResultData: properties: artifacts: anyOf: - {} - type: 'null' title: Artifacts component_display_name: anyOf: - type: string - type: 'null' title: Component Display Name component_id: anyOf: - type: string - type: 'null' title: Component Id duration: anyOf: - type: string - type: 'null' title: Duration logs: anyOf: - additionalProperties: true type: object - type: 'null' title: Logs messages: anyOf: - items: $ref: '#/components/schemas/ChatOutputResponse' type: array - type: 'null' title: Messages outputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs results: anyOf: - {} - type: 'null' title: Results timedelta: anyOf: - type: number - type: 'null' title: Timedelta token_usage: anyOf: - $ref: '#/components/schemas/Usage' - type: 'null' used_frozen_result: anyOf: - type: boolean - type: 'null' default: false title: Used Frozen Result title: ResultData type: object RoleAssignmentCreate: description: Payload for assigning a role to a user. properties: domain_id: anyOf: - format: uuid type: string - type: 'null' description: >- Required when ``domain_type`` is org/workspace/project; must be null for ``global``. title: Domain Id domain_type: default: global description: >- Domain scope of the assignment. ``global`` is unscoped (no ``domain_id``); ``org``/``workspace``/``project`` require a matching ``domain_id``. enum: - global - org - workspace - project title: Domain Type type: string role_id: format: uuid title: Role Id type: string user_id: format: uuid title: User Id type: string required: - user_id - role_id title: RoleAssignmentCreate type: object RoleAssignmentRead: description: Serialized authz_role_assignment row returned by the API. properties: assigned_at: format: date-time title: Assigned At type: string assigned_by: anyOf: - format: uuid type: string - type: 'null' title: Assigned By domain_id: anyOf: - format: uuid type: string - type: 'null' title: Domain Id domain_type: title: Domain Type type: string id: format: uuid title: Id type: string role_id: format: uuid title: Role Id type: string user_id: format: uuid title: User Id type: string required: - id - user_id - role_id - domain_type - domain_id - assigned_at - assigned_by title: RoleAssignmentRead type: object RoleCreate: description: Payload for creating an authz_role row. properties: description: anyOf: - type: string - type: 'null' title: Description name: maxLength: 255 minLength: 1 title: Name type: string parent_role_id: anyOf: - format: uuid type: string - type: 'null' title: Parent Role Id permissions: description: >- Permission slugs in the canonical ``:`` form — for example ``flow:read``, ``deployment:execute``, ``share:create``. Resources must be one of flow, deployment, project, knowledge_base, variable, file, share. Actions are constrained per-resource (see ``services/authorization/actions.py``): e.g. ``deploy`` is only valid on ``flow``, ``ingest`` only on ``knowledge_base``, ``update`` only on ``share``. ``*`` (all actions on that resource) is always accepted. A registered authorization plugin is responsible for compiling these into its policy format. items: type: string title: Permissions type: array required: - name title: RoleCreate type: object RoleRead: description: Serialized authz_role row returned by the API. properties: created_at: format: date-time title: Created At type: string created_by: anyOf: - format: uuid type: string - type: 'null' title: Created By description: anyOf: - type: string - type: 'null' title: Description id: format: uuid title: Id type: string is_system: title: Is System type: boolean name: title: Name type: string parent_role_id: anyOf: - format: uuid type: string - type: 'null' title: Parent Role Id permissions: items: type: string title: Permissions type: array updated_at: format: date-time title: Updated At type: string workspace_id: anyOf: - format: uuid type: string - type: 'null' title: Workspace Id required: - id - name - description - is_system - permissions - parent_role_id - workspace_id - created_at - updated_at - created_by title: RoleRead type: object RoleUpdate: description: >- Payload for updating an authz_role row (PATCH semantics — only set fields apply). properties: description: anyOf: - type: string - type: 'null' title: Description name: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' title: Name parent_role_id: anyOf: - format: uuid type: string - type: 'null' title: Parent Role Id permissions: anyOf: - items: type: string type: array - type: 'null' title: Permissions title: RoleUpdate type: object RunAgentRequest: description: Run agent request payload. properties: files: anyOf: - items: type: string type: array - type: 'null' title: Files input_value: anyOf: - type: string - type: 'null' title: Input Value type: default: chat title: Type type: string version: default: 1.0.0 title: Version type: string title: RunAgentRequest type: object RunAgentResponse: description: Run agent initial response. properties: flow_id: title: Flow Id type: string flow_name: title: Flow Name type: string message: title: Message type: string run_id: title: Run Id type: string status: title: Status type: string required: - run_id - flow_id - flow_name - status - message title: RunAgentResponse type: object RunFlowTargetCandidate: description: >- Approved deploy that can satisfy a Run Flow dependency on this target flow. properties: agent_id: title: Agent Id type: string approved_at: anyOf: - format: date-time type: string - type: 'null' title: Approved At created_at: format: date-time title: Created At type: string id: format: uuid title: Id type: string is_auto_synthetic: default: false title: Is Auto Synthetic type: boolean status: title: Status type: string version: title: Version type: string required: - id - agent_id - version - status - created_at title: RunFlowTargetCandidate type: object RunFlowTargetPreviewEntry: description: One Run Flow dependency the operator can resolve before publishing. properties: approved_candidates: items: $ref: '#/components/schemas/RunFlowTargetCandidate' title: Approved Candidates type: array auto_publish_agent_id_hint: anyOf: - type: string - type: 'null' title: Auto Publish Agent Id Hint default_candidate_id: anyOf: - format: uuid type: string - type: 'null' title: Default Candidate Id in_same_workspace: title: In Same Workspace type: boolean target_flow_exists: title: Target Flow Exists type: boolean target_flow_id: format: uuid title: Target Flow Id type: string target_flow_name: anyOf: - type: string - type: 'null' title: Target Flow Name would_auto_publish: default: false title: Would Auto Publish type: boolean required: - target_flow_id - target_flow_exists - in_same_workspace title: RunFlowTargetPreviewEntry type: object RunFlowTargetsPreviewResponse: properties: flow_id: format: uuid title: Flow Id type: string mode: title: Mode type: string targets: items: $ref: '#/components/schemas/RunFlowTargetPreviewEntry' title: Targets type: array required: - flow_id - mode title: RunFlowTargetsPreviewResponse type: object RunOutputs: properties: inputs: additionalProperties: true title: Inputs type: object outputs: items: anyOf: - $ref: '#/components/schemas/ResultData' - type: 'null' title: Outputs type: array title: RunOutputs type: object RunResponse: description: Run response schema. properties: outputs: anyOf: - items: $ref: '#/components/schemas/RunOutputs' type: array - type: 'null' default: [] title: Outputs session_id: anyOf: - type: string - type: 'null' title: Session Id title: RunResponse type: object RunStatusResponse: description: Run status polling response. properties: build_id: anyOf: - type: string - type: 'null' title: Build Id error: anyOf: - type: string - type: 'null' title: Error flow_id: title: Flow Id type: string flow_name: title: Flow Name type: string last_updated: anyOf: - type: string - type: 'null' title: Last Updated log_url: anyOf: - type: string - type: 'null' title: Log Url logs: anyOf: - items: type: string type: array - type: 'null' title: Logs operation_name: anyOf: - type: string - type: 'null' title: Operation Name output: anyOf: - type: string - type: 'null' title: Output result: anyOf: - additionalProperties: true type: object - type: 'null' title: Result run_id: title: Run Id type: string status: title: Status type: string version: title: Version type: string required: - run_id - status - flow_id - flow_name - version title: RunStatusResponse type: object RuntimeExecutionMode: enum: - graph - container title: RuntimeExecutionMode type: string RuntimeInvokeRequest: properties: agent_id: minLength: 1 title: Agent Id type: string auto_build: default: true title: Auto Build type: boolean execution_mode: $ref: '#/components/schemas/RuntimeExecutionMode' default: graph files: items: type: string title: Files type: array input: additionalProperties: true title: Input type: object tenant_id: format: uuid title: Tenant Id type: string version: minLength: 1 title: Version type: string required: - agent_id - version - tenant_id title: RuntimeInvokeRequest type: object RuntimeInvokeResponse: properties: run_id: format: uuid title: Run Id type: string required: - run_id title: RuntimeInvokeResponse type: object RuntimeRunCallbackRequest: properties: error_message: anyOf: - type: string - type: 'null' title: Error Message event_type: minLength: 1 title: Event Type type: string message: anyOf: - type: string - type: 'null' title: Message result_payload: anyOf: - additionalProperties: true type: object - type: 'null' title: Result Payload status: anyOf: - type: string - type: 'null' title: Status required: - event_type title: RuntimeRunCallbackRequest type: object RuntimeStatusResponse: properties: hot_status: anyOf: - type: string - type: 'null' title: Hot Status run_id: format: uuid title: Run Id type: string status: title: Status type: string required: - run_id - status title: RuntimeStatusResponse type: object ScheduleCreate: description: Payload for creating a schedule. properties: cron: anyOf: - maxLength: 128 type: string - type: 'null' description: Cron expression for flexible schedules title: Cron description: anyOf: - type: string - type: 'null' description: Optional description for the schedule title: Description enabled: default: true description: Whether this schedule is active title: Enabled type: boolean end_at: anyOf: - format: date-time type: string - type: 'null' description: Optional end time after which schedule is disabled title: End At flow_id: description: Flow that this schedule will run format: uuid title: Flow Id type: string input_type: anyOf: - maxLength: 32 type: string - type: 'null' description: Input type for the flow (text, chat, etc.) title: Input Type input_value: anyOf: - {} - type: 'null' description: Input value passed to the flow (serialized) title: Input Value interval_seconds: anyOf: - type: integer - type: 'null' description: Simple interval in seconds (alternative to cron) title: Interval Seconds last_run_at: anyOf: - format: date-time type: string - type: 'null' description: Timestamp of the last run (if any) title: Last Run At last_run_error: anyOf: - type: string - type: 'null' description: Optional error message from last failed run title: Last Run Error last_run_status: anyOf: - maxLength: 32 type: string - type: 'null' description: Status of the last run (success, failed, running, pending) title: Last Run Status name: description: Human friendly name for the schedule maxLength: 255 title: Name type: string output_component: anyOf: - maxLength: 255 type: string - type: 'null' description: Optional output component identifier title: Output Component output_type: anyOf: - maxLength: 32 type: string - type: 'null' description: Output type (any, debug, chat, etc.) title: Output Type start_at: anyOf: - format: date-time type: string - type: 'null' description: Optional start time for the schedule title: Start At tenant_id: anyOf: - format: uuid type: string - type: 'null' title: Tenant Id timezone: default: UTC description: IANA timezone identifier (e.g. Europe/Istanbul) maxLength: 64 title: Timezone type: string tweaks: anyOf: - additionalProperties: true type: object - type: 'null' description: Flow tweaks applied during scheduled run title: Tweaks workspace_id: anyOf: - format: uuid type: string - type: 'null' title: Workspace Id required: - name - flow_id title: ScheduleCreate type: object ScheduleRead: description: Response model for reading schedules. properties: created_at: format: date-time title: Created At type: string created_by: anyOf: - format: uuid type: string - type: 'null' title: Created By cron: anyOf: - maxLength: 128 type: string - type: 'null' description: Cron expression for flexible schedules title: Cron description: anyOf: - type: string - type: 'null' description: Optional description for the schedule title: Description enabled: default: true description: Whether this schedule is active title: Enabled type: boolean end_at: anyOf: - format: date-time type: string - type: 'null' description: Optional end time after which schedule is disabled title: End At flow_id: description: Flow that this schedule will run format: uuid title: Flow Id type: string id: format: uuid title: Id type: string input_type: anyOf: - maxLength: 32 type: string - type: 'null' description: Input type for the flow (text, chat, etc.) title: Input Type input_value: anyOf: - {} - type: 'null' description: Input value passed to the flow (serialized) title: Input Value interval_seconds: anyOf: - type: integer - type: 'null' description: Simple interval in seconds (alternative to cron) title: Interval Seconds last_run_at: anyOf: - format: date-time type: string - type: 'null' description: Timestamp of the last run (if any) title: Last Run At last_run_error: anyOf: - type: string - type: 'null' description: Optional error message from last failed run title: Last Run Error last_run_status: anyOf: - maxLength: 32 type: string - type: 'null' description: Status of the last run (success, failed, running, pending) title: Last Run Status name: description: Human friendly name for the schedule maxLength: 255 title: Name type: string output_component: anyOf: - maxLength: 255 type: string - type: 'null' description: Optional output component identifier title: Output Component output_type: anyOf: - maxLength: 32 type: string - type: 'null' description: Output type (any, debug, chat, etc.) title: Output Type start_at: anyOf: - format: date-time type: string - type: 'null' description: Optional start time for the schedule title: Start At tenant_id: anyOf: - format: uuid type: string - type: 'null' description: Tenant that owns this schedule title: Tenant Id timezone: default: UTC description: IANA timezone identifier (e.g. Europe/Istanbul) maxLength: 64 title: Timezone type: string tweaks: anyOf: - additionalProperties: true type: object - type: 'null' description: Flow tweaks applied during scheduled run title: Tweaks updated_at: format: date-time title: Updated At type: string workspace_id: anyOf: - format: uuid type: string - type: 'null' description: Workspace that owns this schedule (optional) title: Workspace Id required: - name - flow_id - id - created_at - updated_at title: ScheduleRead type: object ScheduleUpdate: description: Partial update payload for schedules. properties: cron: anyOf: - type: string - type: 'null' title: Cron description: anyOf: - type: string - type: 'null' title: Description enabled: anyOf: - type: boolean - type: 'null' title: Enabled end_at: anyOf: - format: date-time type: string - type: 'null' title: End At input_type: anyOf: - type: string - type: 'null' title: Input Type input_value: anyOf: - {} - type: 'null' title: Input Value interval_seconds: anyOf: - type: integer - type: 'null' title: Interval Seconds name: anyOf: - type: string - type: 'null' title: Name output_component: anyOf: - type: string - type: 'null' title: Output Component output_type: anyOf: - type: string - type: 'null' title: Output Type start_at: anyOf: - format: date-time type: string - type: 'null' title: Start At timezone: anyOf: - type: string - type: 'null' title: Timezone tweaks: anyOf: - additionalProperties: true type: object - type: 'null' title: Tweaks title: ScheduleUpdate type: object SendPublishedAgentMessageRequest: properties: auto_build: default: true title: Auto Build type: boolean execution_mode: $ref: '#/components/schemas/RuntimeExecutionMode' default: container files: items: type: string title: Files type: array input: additionalProperties: true title: Input type: object text: default: '' maxLength: 200000 title: Text type: string title: SendPublishedAgentMessageRequest type: object SendPublishedAgentMessageResponse: properties: run: $ref: '#/components/schemas/ProductionRunRead' run_id: format: uuid title: Run Id type: string user_message: $ref: '#/components/schemas/PublishedAgentMessageRead' required: - run_id - user_message - run title: SendPublishedAgentMessageResponse type: object SetPublishedAgentStatusRequest: properties: expected_status: anyOf: - type: string - type: 'null' description: 'Optional CAS: reject if current status differs' title: Expected Status reason: anyOf: - maxLength: 512 type: string - type: 'null' title: Reason status: maxLength: 32 minLength: 1 title: Status type: string required: - status title: SetPublishedAgentStatusRequest type: object SetPublishedAgentStatusResponse: properties: operation_id: title: Operation Id type: string previous_status: title: Previous Status type: string published_agent: $ref: '#/components/schemas/PublishedAgentRead' required: - published_agent - previous_status - operation_id title: SetPublishedAgentStatusResponse type: object ShareCreate: description: Payload for creating an authz_share row. properties: permission_level: default: read enum: - read - write - execute - admin title: Permission Level type: string resource_id: format: uuid title: Resource Id type: string resource_type: enum: - flow - deployment - project - knowledge_base - variable - file title: Resource Type type: string scope: enum: - private - team - user - public title: Scope type: string target_id: anyOf: - format: uuid type: string - type: 'null' title: Target Id required: - resource_type - resource_id - scope title: ShareCreate type: object ShareRead: description: Serialized authz_share row returned by the API. properties: created_at: format: date-time title: Created At type: string created_by: anyOf: - format: uuid type: string - type: 'null' title: Created By id: format: uuid title: Id type: string permission_level: enum: - read - write - execute - admin title: Permission Level type: string resource_id: format: uuid title: Resource Id type: string resource_type: enum: - flow - deployment - project - knowledge_base - variable - file title: Resource Type type: string scope: enum: - private - team - user - public title: Scope type: string target_id: anyOf: - format: uuid type: string - type: 'null' title: Target Id required: - id - resource_type - resource_id - scope - target_id - permission_level - created_by - created_at title: ShareRead type: object ShareUpdate: description: Payload for updating an authz_share permission level. properties: permission_level: enum: - read - write - execute - admin title: Permission Level type: string required: - permission_level title: ShareUpdate type: object SimplifiedAPIRequest: properties: input_type: anyOf: - enum: - chat - text - any type: string - type: 'null' default: chat description: The input type title: Input Type input_value: anyOf: - type: string - type: 'null' description: The input value title: Input Value output_component: anyOf: - type: string - type: 'null' default: '' description: >- If there are multiple output components, you can specify the component to get the output from. title: Output Component output_type: anyOf: - enum: - chat - text - any - debug type: string - type: 'null' default: chat description: The output type title: Output Type session_id: anyOf: - type: string - type: 'null' description: The session id title: Session Id tweaks: anyOf: - $ref: '#/components/schemas/Tweaks' - type: 'null' description: The tweaks user_id: anyOf: - type: string - type: 'null' description: >- Optional end-user identifier forwarded to tracing providers (e.g. Langfuse) as the trace's user_id. Does not affect authentication or authorization — the API key owner remains the effective Langflow user. title: User Id title: SimplifiedAPIRequest type: object Source: properties: display_name: anyOf: - type: string - type: 'null' description: The display name of the source component. title: Display Name id: anyOf: - type: string - type: 'null' description: The id of the source component. title: Id source: anyOf: - type: string - type: 'null' description: >- The source of the message. Normally used to display the model name (e.g. 'gpt-4o') title: Source title: Source type: object SpanReadResponse: description: |- Response model for a single span, with nested children. Serializes to camelCase JSON to match the frontend API contract. properties: children: items: $ref: '#/components/schemas/SpanReadResponse' title: Children type: array endTime: anyOf: - format: date-time type: string - type: 'null' title: Endtime error: anyOf: - type: string - type: 'null' title: Error id: format: uuid title: Id type: string inputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Inputs latencyMs: title: Latencyms type: integer modelName: anyOf: - type: string - type: 'null' title: Modelname name: title: Name type: string outputs: anyOf: - additionalProperties: true type: object - type: 'null' title: Outputs startTime: anyOf: - format: date-time type: string - type: 'null' title: Starttime status: $ref: '#/components/schemas/SpanStatus' tokenUsage: anyOf: - additionalProperties: true type: object - type: 'null' title: Tokenusage type: $ref: '#/components/schemas/SpanType' required: - id - name - type - status - startTime - endTime - latencyMs - inputs - outputs - error - modelName - tokenUsage title: SpanReadResponse type: object SpanStatus: description: |- OpenTelemetry status codes. - UNSET: Default status, span has not ended yet - OK: Span completed successfully - ERROR: Span completed with an error enum: - unset - ok - error title: SpanStatus type: string SpanType: description: Types of spans that can be recorded. enum: - chain - llm - tool - retriever - embedding - parser - agent title: SpanType type: string TeamCreate: description: Payload for creating an authz_team. properties: adom_name: description: >- Administrative-domain slug, unique across all teams (often the SSO group name). maxLength: 255 minLength: 1 title: Adom Name type: string description: anyOf: - type: string - type: 'null' title: Description is_active: default: true title: Is Active type: boolean team_name: maxLength: 255 minLength: 1 title: Team Name type: string required: - team_name - adom_name title: TeamCreate type: object TeamMemberCreate: description: Payload for adding a user to a team. properties: source: default: manual enum: - manual - sso title: Source type: string user_id: format: uuid title: User Id type: string required: - user_id title: TeamMemberCreate type: object TeamMemberRead: description: Serialized authz_team_member row. properties: created_at: format: date-time title: Created At type: string id: format: uuid title: Id type: string source: title: Source type: string team_id: format: uuid title: Team Id type: string user_id: format: uuid title: User Id type: string required: - id - team_id - user_id - source - created_at title: TeamMemberRead type: object TeamRead: description: Serialized authz_team row returned by the API. properties: adom_name: title: Adom Name type: string created_at: format: date-time title: Created At type: string description: anyOf: - type: string - type: 'null' title: Description id: format: uuid title: Id type: string is_active: title: Is Active type: boolean team_name: title: Team Name type: string updated_at: format: date-time title: Updated At type: string required: - id - team_name - adom_name - description - is_active - created_at - updated_at title: TeamRead type: object TeamUpdate: description: Payload for updating an authz_team (PATCH semantics). properties: adom_name: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' title: Adom Name description: anyOf: - type: string - type: 'null' title: Description is_active: anyOf: - type: boolean - type: 'null' title: Is Active team_name: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' title: Team Name title: TeamUpdate type: object TextContent-Input: description: Content type for simple text content. properties: duration: anyOf: - type: integer - type: 'null' title: Duration header: anyOf: - $ref: '#/components/schemas/HeaderDict' - type: 'null' text: title: Text type: string type: const: text default: text title: Type type: string required: - text title: TextContent type: object TextContent-Output: additionalProperties: true type: object ToolContent-Input: description: Content type for tool start content. properties: duration: anyOf: - type: integer - type: 'null' title: Duration error: anyOf: - {} - type: 'null' title: Error header: anyOf: - $ref: '#/components/schemas/HeaderDict' - type: 'null' input: additionalProperties: true title: Input type: object name: anyOf: - type: string - type: 'null' title: Name output: anyOf: - {} - type: 'null' title: Output type: const: tool_use default: tool_use title: Type type: string title: ToolContent type: object ToolContent-Output: additionalProperties: true type: object TraceListResponse: description: Paginated list response for traces. properties: pages: title: Pages type: integer total: title: Total type: integer traces: items: $ref: '#/components/schemas/TraceSummaryRead' title: Traces type: array required: - traces - total - pages title: TraceListResponse type: object TraceRead: description: |- Response model for a single trace with its hierarchical span tree. Serializes to camelCase JSON to match the frontend API contract. properties: endTime: anyOf: - format: date-time type: string - type: 'null' title: Endtime flowId: format: uuid title: Flowid type: string id: format: uuid title: Id type: string input: anyOf: - additionalProperties: true type: object - type: string - type: 'null' title: Input name: title: Name type: string output: anyOf: - additionalProperties: true type: object - type: string - type: 'null' title: Output sessionId: title: Sessionid type: string spans: items: $ref: '#/components/schemas/SpanReadResponse' title: Spans type: array startTime: anyOf: - format: date-time type: string - type: 'null' title: Starttime status: $ref: '#/components/schemas/SpanStatus' totalLatencyMs: title: Totallatencyms type: integer totalTokens: title: Totaltokens type: integer required: - id - name - status - startTime - endTime - totalLatencyMs - totalTokens - flowId - sessionId title: TraceRead type: object TraceSummaryRead: description: |- Lightweight trace model for list endpoint. Serializes to camelCase JSON to match the frontend API contract. properties: flowId: format: uuid title: Flowid type: string id: format: uuid title: Id type: string input: anyOf: - additionalProperties: true type: object - type: string - type: 'null' title: Input name: title: Name type: string output: anyOf: - additionalProperties: true type: object - type: string - type: 'null' title: Output sessionId: title: Sessionid type: string startTime: anyOf: - format: date-time type: string - type: 'null' title: Starttime status: $ref: '#/components/schemas/SpanStatus' totalLatencyMs: title: Totallatencyms type: integer totalTokens: title: Totaltokens type: integer required: - id - name - status - startTime - totalLatencyMs - totalTokens - flowId - sessionId title: TraceSummaryRead type: object TransactionLogsResponse: description: >- Transaction response model for logs view - excludes error and flow_id fields. properties: id: format: uuid title: Id type: string inputs: additionalProperties: true title: Inputs type: object outputs: additionalProperties: true title: Outputs type: object status: title: Status type: string target_id: anyOf: - type: string - type: 'null' title: Target Id timestamp: format: date-time title: Timestamp type: string vertex_id: title: Vertex Id type: string required: - id - vertex_id - status title: TransactionLogsResponse type: object Tweaks: additionalProperties: anyOf: - type: boolean - type: integer - type: number - type: string - additionalProperties: true type: object description: >- A dictionary of tweaks to adjust the flow's execution. Allows customizing flow behavior dynamically. All tweaks are overridden by the input values. examples: - Component Name: parameter_name: value component_id: parameter_name: value parameter_name: value stream: false temperature: 0.7 title: Tweaks type: object UnpublishedImageRead: description: >- A built flow image that has not been attached to a published artifact yet. properties: build_id: anyOf: - type: string - type: 'null' title: Build Id flow_id: title: Flow Id type: string flow_name: title: Flow Name type: string image_name: title: Image Name type: string log_url: anyOf: - type: string - type: 'null' title: Log Url source: default: prepublish title: Source type: string status: default: ready title: Status type: string version: title: Version type: string required: - flow_id - flow_name - version - image_name title: UnpublishedImageRead type: object UpdatePublishedAgentStatusRequest: properties: disable_previous_approved: default: true description: >- When approving, disable other approved published agents that share the same (tenant_id, agent_id). Default on. title: Disable Previous Approved type: boolean status: minLength: 1 title: Status type: string required: - status title: UpdatePublishedAgentStatusRequest type: object UpdatePublishedAgentStatusResponse: description: >- Approve/publish status response; keeps flat PublishedAgentRead fields for clients. properties: agent_id: title: Agent Id type: string agent_model_config: additionalProperties: true title: Agent Model Config type: object allowed_tools: items: {} title: Allowed Tools type: array approved_at: anyOf: - format: date-time type: string - type: 'null' title: Approved At approved_by: anyOf: - format: uuid type: string - type: 'null' title: Approved By batch_operation_id: anyOf: - type: string - type: 'null' title: Batch Operation Id capability_manifest: additionalProperties: true title: Capability Manifest type: object created_at: format: date-time title: Created At type: string created_by: anyOf: - format: uuid type: string - type: 'null' title: Created By flow_id: anyOf: - format: uuid type: string - type: 'null' title: Flow Id graph_payload_ref: title: Graph Payload Ref type: string id: format: uuid title: Id type: string latest_build_error: anyOf: - type: string - type: 'null' title: Latest Build Error latest_build_status: anyOf: - type: string - type: 'null' title: Latest Build Status latest_image_ref: anyOf: - type: string - type: 'null' title: Latest Image Ref max_runs_per_day: anyOf: - type: integer - type: 'null' title: Max Runs Per Day max_tokens_per_run: anyOf: - type: integer - type: 'null' title: Max Tokens Per Run previous_versions_disabled: items: $ref: '#/components/schemas/PreviousVersionDisableResult' title: Previous Versions Disabled type: array runflow_manifest: anyOf: - additionalProperties: true type: object - type: 'null' title: Runflow Manifest runflow_manifest_summary: anyOf: - additionalProperties: true type: object - type: 'null' title: Runflow Manifest Summary runtime_profile: title: Runtime Profile type: string status: title: Status type: string tenant_id: format: uuid title: Tenant Id type: string timeout_seconds: title: Timeout Seconds type: integer updated_at: format: date-time title: Updated At type: string version: title: Version type: string visibility: additionalProperties: true title: Visibility type: object required: - id - tenant_id - agent_id - version - flow_id - graph_payload_ref - runtime_profile - agent_model_config - allowed_tools - timeout_seconds - visibility - capability_manifest - status - created_by - approved_by - approved_at - created_at - updated_at title: UpdatePublishedAgentStatusResponse type: object Usage: description: Token usage information from LLM responses. properties: input_tokens: anyOf: - type: integer - type: 'null' title: Input Tokens output_tokens: anyOf: - type: integer - type: 'null' title: Output Tokens total_tokens: anyOf: - type: integer - type: 'null' title: Total Tokens title: Usage type: object UserAdminRead: description: Least-privilege user representation for administration lists. properties: create_at: format: date-time title: Create At type: string email: title: Email type: string id: format: uuid title: Id type: string is_active: title: Is Active type: boolean is_email_verified: title: Is Email Verified type: boolean is_superuser: title: Is Superuser type: boolean profile_image: anyOf: - type: string - type: 'null' title: Profile Image updated_at: format: date-time title: Updated At type: string username: title: Username type: string required: - id - username - email - profile_image - is_active - is_superuser - create_at - updated_at - is_email_verified title: UserAdminRead type: object UserCreate: properties: email: title: Email type: string is_active: anyOf: - type: boolean - type: 'null' title: Is Active is_superuser: anyOf: - type: boolean - type: 'null' title: Is Superuser optins: anyOf: - additionalProperties: true type: object - type: 'null' default: dialog_dismissed: false discord_clicked: false github_starred: false title: Optins password: title: Password type: string username: title: Username type: string required: - username - password - email title: UserCreate type: object UserRead: properties: create_at: format: date-time title: Create At type: string email_verified_at: anyOf: - format: date-time type: string - type: 'null' title: Email Verified At id: format: uuid title: Id type: string is_active: title: Is Active type: boolean is_email_verified: title: Is Email Verified type: boolean is_superuser: title: Is Superuser type: boolean last_login_at: anyOf: - format: date-time type: string - type: 'null' title: Last Login At last_logout_at: anyOf: - format: date-time type: string - type: 'null' title: Last Logout At optins: anyOf: - additionalProperties: true type: object - type: 'null' title: Optins profile_image: anyOf: - type: string - type: 'null' title: Profile Image store_api_key: anyOf: - type: string - type: 'null' title: Store Api Key updated_at: format: date-time title: Updated At type: string username: title: Username type: string required: - username - profile_image - store_api_key - is_active - is_superuser - create_at - updated_at - last_login_at - last_logout_at - is_email_verified - email_verified_at title: UserRead type: object UserUpdate: properties: email: anyOf: - type: string - type: 'null' title: Email is_active: anyOf: - type: boolean - type: 'null' title: Is Active is_superuser: anyOf: - type: boolean - type: 'null' title: Is Superuser last_login_at: anyOf: - format: date-time type: string - type: 'null' title: Last Login At last_logout_at: anyOf: - format: date-time type: string - type: 'null' title: Last Logout At optins: anyOf: - additionalProperties: true type: object - type: 'null' title: Optins password: anyOf: - type: string - type: 'null' title: Password profile_image: anyOf: - type: string - type: 'null' title: Profile Image username: anyOf: - type: string - type: 'null' title: Username title: UserUpdate type: object UsersResponse: properties: total_count: title: Total Count type: integer users: items: $ref: '#/components/schemas/UserAdminRead' title: Users type: array required: - total_count - users title: UsersResponse type: object ValidationError: properties: ctx: title: Context type: object input: title: Input loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object VerifyEmailRequest: description: Request model for email verification. properties: email: title: Email type: string otp_code: title: Otp Code type: string required: - email - otp_code title: VerifyEmailRequest type: object VerifyEmailResponse: description: Response model for email verification. properties: is_user_active: default: false title: Is User Active type: boolean message: title: Message type: string success: title: Success type: boolean required: - success - message title: VerifyEmailResponse type: object VertexBuildMapModel: properties: vertex_builds: additionalProperties: items: additionalProperties: true type: object type: array title: Vertex Builds type: object required: - vertex_builds title: VertexBuildMapModel type: object VibeAttachment: properties: extension: anyOf: - type: string - type: 'null' title: Extension id: title: Id type: string kind: default: file enum: - text - image - file title: Kind type: string mime_type: anyOf: - type: string - type: 'null' title: Mime Type name: title: Name type: string path: title: Path type: string size: title: Size type: integer required: - id - name - path - size title: VibeAttachment type: object VibeBuildRequest: description: Request model for Claude Agent SDK backed flow building. properties: approval_continuation: default: false title: Approval Continuation type: boolean approval_id: anyOf: - type: string - type: 'null' title: Approval Id approval_scope: default: once enum: - once - always title: Approval Scope type: string attachments: items: $ref: '#/components/schemas/VibeAttachment' maxItems: 10 title: Attachments type: array display_input_value: anyOf: - maxLength: 4000 type: string - type: 'null' title: Display Input Value flow_id: title: Flow Id type: string input_value: maxLength: 4000 minLength: 1 title: Input Value type: string max_iterations: default: 5 maximum: 10 minimum: 1 title: Max Iterations type: integer mode: default: draft enum: - draft - guarded - autopilot title: Mode type: string model_name: anyOf: - type: string - type: 'null' default: claude-sonnet-5 title: Model Name plan_mode: default: false title: Plan Mode type: boolean provider: anyOf: - type: string - type: 'null' default: Claude Code OAuth title: Provider session_id: anyOf: - type: string - type: 'null' title: Session Id user_message_id: anyOf: - maxLength: 64 type: string - type: 'null' title: User Message Id required: - flow_id - input_value title: VibeBuildRequest type: object ViewPort: properties: x: title: X type: number 'y': title: 'Y' type: number zoom: title: Zoom type: number required: - x - 'y' - zoom title: ViewPort type: object WorkflowExecutionRequest: additionalProperties: false description: Request schema for workflow execution. examples: - background: false flow_id: flow_67ccd2be17f0819081ff3bb2cf6508e60bb6a6b452d3795b globals: FILENAME: relatorio-final.pdf OWNER_NAME: Jose inputs: ChatInput-abc.input_value: Hello, how can you help me today? ChatInput-abc.session_id: session-123 LLM-xyz.max_tokens: 100 LLM-xyz.temperature: 0.7 OpenSearch-def.opensearch_url: https://opensearch:9200 stream: false - background: true flow_id: flow_67ccd2be17f0819081ff3bb2cf6508e60bb6a6b452d3795b inputs: ChatInput-abc.input_value: Process this in the background stream: false - background: false flow_id: flow_67ccd2be17f0819081ff3bb2cf6508e60bb6a6b452d3795b inputs: ChatInput-abc.input_value: Stream this conversation stream: true properties: background: default: false title: Background type: boolean flow_id: title: Flow Id type: string globals: additionalProperties: maxLength: 65536 type: string description: >- Request-level global variables made available to workflow components. Keys may use any printable string up to 256 chars; values are capped at 65536 chars. Body globals always win over the legacy ``X-LANGFLOW-GLOBAL-VAR-*`` headers. propertyNames: maxLength: 256 minLength: 1 title: Globals type: object inputs: anyOf: - additionalProperties: true type: object - type: 'null' description: >- Component-specific inputs in flat format: 'component_id.param_name': value title: Inputs stream: default: false title: Stream type: boolean required: - flow_id title: WorkflowExecutionRequest type: object WorkflowExecutionResponse: description: Synchronous workflow execution response. properties: created_timestamp: title: Created Timestamp type: string errors: default: [] items: $ref: '#/components/schemas/ErrorDetail' title: Errors type: array flow_id: title: Flow Id type: string globals: additionalProperties: maxLength: 65536 type: string propertyNames: maxLength: 256 minLength: 1 title: Globals type: object inputs: additionalProperties: true default: {} title: Inputs type: object job_id: anyOf: - type: string - format: uuid type: string - type: 'null' title: Job Id object: const: response default: response title: Object type: string outputs: additionalProperties: $ref: '#/components/schemas/ComponentOutput' default: {} title: Outputs type: object status: $ref: '#/components/schemas/JobStatus' required: - flow_id - status title: WorkflowExecutionResponse type: object WorkflowJobResponse: description: Background job response. properties: created_timestamp: title: Created Timestamp type: string errors: default: [] items: $ref: '#/components/schemas/ErrorDetail' title: Errors type: array flow_id: title: Flow Id type: string globals: additionalProperties: maxLength: 65536 type: string propertyNames: maxLength: 256 minLength: 1 title: Globals type: object job_id: anyOf: - type: string - format: uuid type: string title: Job Id links: additionalProperties: type: string title: Links type: object object: const: job default: job title: Object type: string status: $ref: '#/components/schemas/JobStatus' required: - job_id - flow_id - status title: WorkflowJobResponse type: object WorkflowStopRequest: description: Request schema for stopping workflow. properties: job_id: anyOf: - type: string - format: uuid type: string title: Job Id required: - job_id title: WorkflowStopRequest type: object WorkflowStopResponse: description: Response schema for stopping workflow. properties: job_id: anyOf: - type: string - format: uuid type: string title: Job Id message: anyOf: - type: string - type: 'null' title: Message required: - job_id title: WorkflowStopResponse type: object WorkflowStreamEvent: description: Streaming event response. properties: raw_event: additionalProperties: true title: Raw Event type: object run_id: title: Run Id type: string timestamp: title: Timestamp type: integer type: title: Type type: string required: - type - run_id - timestamp - raw_event title: WorkflowStreamEvent type: object _ClaudeOAuthCompleteRequest: properties: code: title: Code type: string state: title: State type: string required: - state - code title: _ClaudeOAuthCompleteRequest type: object _ClaudeOAuthStartRequest: properties: redirect_uri: anyOf: - type: string - type: 'null' title: Redirect Uri title: _ClaudeOAuthStartRequest type: object _ClaudeTokenRequest: properties: account_label: anyOf: - type: string - type: 'null' title: Account Label provider: title: Provider type: string secret: title: Secret type: string required: - provider - secret title: _ClaudeTokenRequest type: object _ForkSessionRequest: properties: edited_message_anchor: anyOf: - minimum: 0 type: integer - type: 'null' title: Edited Message Anchor edited_message_id: anyOf: - type: string - type: 'null' title: Edited Message Id flow_id: title: Flow Id type: string messages: anyOf: - items: {} type: array - type: 'null' title: Messages title: anyOf: - type: string - type: 'null' title: Title until_message_id: anyOf: - type: string - type: 'null' title: Until Message Id required: - flow_id title: _ForkSessionRequest type: object _MemoryCreateRequest: properties: confidence: default: 1 title: Confidence type: number content: title: Content type: string kind: default: convention title: Kind type: string title: title: Title type: string required: - title - content title: _MemoryCreateRequest type: object _MemoryUpdateRequest: properties: confidence: anyOf: - type: number - type: 'null' title: Confidence content: anyOf: - type: string - type: 'null' title: Content kind: anyOf: - type: string - type: 'null' title: Kind status: anyOf: - type: string - type: 'null' title: Status title: anyOf: - type: string - type: 'null' title: Title title: _MemoryUpdateRequest type: object _RewindRequest: description: Body for rewinding a session to a specific past user turn. properties: flow_id: title: Flow Id type: string user_message_id: maxLength: 64 title: User Message Id type: string required: - flow_id - user_message_id title: _RewindRequest type: object _RunActionRequest: properties: approval_id: anyOf: - type: string - type: 'null' title: Approval Id approval_scope: default: once enum: - once - always title: Approval Scope type: string input_value: anyOf: - type: string - type: 'null' title: Input Value title: _RunActionRequest type: object _SaveSessionRequest: description: Body for mirroring a rendered assistant conversation to the server. properties: flow_id: title: Flow Id type: string message_count: default: 0 title: Message Count type: integer messages: items: {} title: Messages type: array title: anyOf: - type: string - type: 'null' title: Title required: - flow_id - messages title: _SaveSessionRequest type: object langflow__api__schemas__UploadFileResponse: description: File upload response schema. properties: id: format: uuid title: Id type: string name: title: Name type: string path: title: Path type: string provider: anyOf: - type: string - type: 'null' title: Provider size: title: Size type: integer required: - id - name - path - size title: UploadFileResponse type: object langflow__api__v1__schemas__UploadFileResponse: description: Upload file response schema. properties: file_path: title: File Path type: string flowId: title: Flowid type: string required: - flowId - file_path title: UploadFileResponse type: object langflow__services__database__models__file__model__File: properties: created_at: format: date-time title: Created At type: string id: format: uuid title: Id type: string name: title: Name type: string path: title: Path type: string provider: anyOf: - type: string - type: 'null' title: Provider size: title: Size type: integer tenant_id: anyOf: - format: uuid type: string - type: 'null' title: Tenant Id updated_at: format: date-time title: Updated At type: string user_id: format: uuid title: User Id type: string workspace_id: anyOf: - format: uuid type: string - type: 'null' title: Workspace Id required: - user_id - name - path - size title: File type: object lfx__utils__schemas__File: description: File schema. properties: name: title: Name type: string path: title: Path type: string type: title: Type type: string required: - path - name - type title: File type: object securitySchemes: API key header: in: header name: x-api-key type: apiKey API key query: in: query name: x-api-key type: apiKey OAuth2PasswordBearer: flows: password: scopes: {} tokenUrl: api/v1/login type: oauth2 info: title: OrbisFlow IDE version: 1.10.0 openapi: 3.1.0 paths: /api/v1/agent-deploy/build-bundle/{flow_id}: post: description: >- Flow'dan agent bundle oluştur.

Bu endpoint flow'u bundle formatına çevirir:
- flow.json
- requirements.lock
- bundle.manifest.json operationId: build_bundle_api_v1_agent_deploy_build_bundle__flow_id__post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string - description: Bundle version in: query name: version required: false schema: default: 1.0.0 description: Bundle version title: Version type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BundleBuildResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Build Bundle tags: - Agent Deploy (Dev) /api/v1/agent-deploy/cloud-build-logs/{build_id}: get: description: Fetch Cloud Build log lines through Studio backend credentials. operationId: get_cloud_build_logs_api_v1_agent_deploy_cloud_build_logs__build_id__get parameters: - in: path name: build_id required: true schema: title: Build Id type: string - in: query name: limit required: false schema: default: 300 maximum: 1000 minimum: 1 title: Limit type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/CloudBuildLogsResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Cloud Build Logs tags: - Agent Deploy (Dev) /api/v1/agent-deploy/debug/deployments: get: description: 'Debug endpoint: Tüm deployment''ları listele.' operationId: debug_deployments_api_v1_agent_deploy_debug_deployments_get responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Debug Deployments Api V1 Agent Deploy Debug Deployments Get type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Debug Deployments tags: - Agent Deploy (Dev) /api/v1/agent-deploy/debug/test-background-task: post: description: 'Test endpoint: Background task''ın çalışıp çalışmadığını test et.' operationId: test_background_task_api_v1_agent_deploy_debug_test_background_task_post responses: '200': content: application/json: schema: additionalProperties: type: string title: >- Response Test Background Task Api V1 Agent Deploy Debug Test Background Task Post type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Test Background Task tags: - Agent Deploy (Dev) /api/v1/agent-deploy/deploy/{flow_id}: post: description: >- Agent'ı deploy et (bundle + container build) - development use only.

Bu endpoint arka planda çalışır:
1. Bundle oluşturur
2. Base runtime image build eder (yoksa)
3. Agent image build eder
4. Container'ı test eder operationId: deploy_agent_api_v1_agent_deploy_deploy__flow_id__post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DeployAgentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeployAgentResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Deploy Agent tags: - Agent Deploy (Dev) /api/v1/agent-deploy/deployment-status/{deployment_id}: get: description: Deployment durumunu sorgula. operationId: >- get_deployment_status_api_v1_agent_deploy_deployment_status__deployment_id__get parameters: - in: path name: deployment_id required: true schema: title: Deployment Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeploymentStatusResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Deployment Status tags: - Agent Deploy (Dev) /api/v1/agent-deploy/resolve-dependencies/{flow_id}: post: description: >- Flow'un dependency'lerini resolve et.

Bu endpoint flow'daki component'leri analiz edip gereken Python paketlerini bulur. operationId: >- resolve_dependencies_api_v1_agent_deploy_resolve_dependencies__flow_id__post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DependencyResolutionResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Resolve Dependencies tags: - Agent Deploy (Dev) /api/v1/agent-deploy/run-status/{run_id}: get: description: Poll the status of a single agent run. operationId: get_run_status_api_v1_agent_deploy_run_status__run_id__get parameters: - in: path name: run_id required: true schema: title: Run Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RunStatusResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Run Status tags: - Agent Deploy (Dev) /api/v1/agent-deploy/run/{flow_id}: post: description: >- Run the deployed agent container once with provided inputs (development use only).

This is mainly for local debugging from the UI. operationId: run_agent_api_v1_agent_deploy_run__flow_id__post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RunAgentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RunAgentResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Run Agent tags: - Agent Deploy (Dev) /api/v1/agent-deploy/unpublished-images/{flow_id}: get: description: >- List built pre-publish images for this flow that are not attached to an artifact. operationId: >- list_unpublished_images_api_v1_agent_deploy_unpublished_images__flow_id__get parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/UnpublishedImageRead' title: >- Response List Unpublished Images Api V1 Agent Deploy Unpublished Images Flow Id Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Unpublished Images tags: - Agent Deploy (Dev) /api/v1/agentic/check-config: get: description: >- Check if the Langflow Assistant is properly configured.

Returns available providers with their configured status and available models. operationId: check_assistant_config_api_v1_agentic_check_config_get responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Check Assistant Config Api V1 Agentic Check Config Get type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Check Assistant Config tags: - Agentic /api/v1/agentic/claude-connection: delete: description: Disconnect the caller's Claude account. operationId: delete_claude_connection_api_v1_agentic_claude_connection_delete responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Delete Claude Connection Api V1 Agentic Claude Connection Delete type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Claude Connection tags: - Agentic get: description: Return the caller's own Claude connection status (no secret material). operationId: get_claude_connection_status_api_v1_agentic_claude_connection_get responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Get Claude Connection Status Api V1 Agentic Claude Connection Get type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Claude Connection Status tags: - Agentic /api/v1/agentic/claude-connection/oauth/callback: get: description: >- Public OAuth redirect target for the automatic (no copy-paste) flow.

Secured by the single-use ``state`` (minted during an authenticated start), not
a session: Anthropic redirects the browser here with ``?code&state``; we
exchange and store, then the page signals the opener and closes itself. operationId: >- claude_oauth_callback_api_v1_agentic_claude_connection_oauth_callback_get parameters: - in: query name: code required: false schema: anyOf: - type: string - type: 'null' title: Code - in: query name: state required: false schema: anyOf: - type: string - type: 'null' title: State - in: query name: error required: false schema: anyOf: - type: string - type: 'null' title: Error responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Claude Oauth Callback tags: - Agentic /api/v1/agentic/claude-connection/oauth/complete: post: description: >- Exchange the pasted authorization code for a token and store it (user-scoped). operationId: >- complete_claude_oauth_api_v1_agentic_claude_connection_oauth_complete_post requestBody: content: application/json: schema: $ref: '#/components/schemas/_ClaudeOAuthCompleteRequest' required: true responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Complete Claude Oauth Api V1 Agentic Claude Connection Oauth Complete Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Complete Claude Oauth tags: - Agentic /api/v1/agentic/claude-connection/oauth/start: post: description: >- Begin the in-browser Connect-Claude PKCE flow; returns the authorize URL + state.

If the caller supplies a valid ``redirect_uri`` pointing at our own
``/oauth/callback`` (and Anthropic accepts it — i.e. the deployment is reachable
at a registered redirect such as a loopback/localhost address), the flow runs
fully automatically (no copy-paste). Otherwise it falls back to the manual
copy-paste page (``mode: "manual"``). operationId: start_claude_oauth_api_v1_agentic_claude_connection_oauth_start_post requestBody: content: application/json: schema: anyOf: - $ref: '#/components/schemas/_ClaudeOAuthStartRequest' - type: 'null' title: Request responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Start Claude Oauth Api V1 Agentic Claude Connection Oauth Start Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Start Claude Oauth tags: - Agentic /api/v1/agentic/claude-connection/oauth/start-loopback: post: description: >- Claude Code-style loopback start (ephemeral localhost listener, no copy-paste).

Only completes automatically when the browser can reach this backend at
``localhost`` (local / self-host); on cloud the caller should use the manual flow. operationId: >- start_claude_oauth_loopback_api_v1_agentic_claude_connection_oauth_start_loopback_post responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Start Claude Oauth Loopback Api V1 Agentic Claude Connection Oauth Start Loopback Post type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Start Claude Oauth Loopback tags: - Agentic /api/v1/agentic/claude-connection/test: post: description: Run a minimal real Claude query to verify the stored connection works. operationId: test_claude_connection_api_v1_agentic_claude_connection_test_post responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Test Claude Connection Api V1 Agentic Claude Connection Test Post type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Test Claude Connection tags: - Agentic /api/v1/agentic/claude-connection/token: post: description: >- Store a pasted credential: an Anthropic API key or a `setup-token` OAuth token. operationId: set_claude_connection_token_api_v1_agentic_claude_connection_token_post requestBody: content: application/json: schema: $ref: '#/components/schemas/_ClaudeTokenRequest' required: true responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Set Claude Connection Token Api V1 Agentic Claude Connection Token Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Set Claude Connection Token tags: - Agentic /api/v1/agentic/claude-connection/usage: get: description: >- Return the connected Claude subscription's usage windows (Claude Code `/usage`). operationId: get_claude_connection_usage_api_v1_agentic_claude_connection_usage_get responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Get Claude Connection Usage Api V1 Agentic Claude Connection Usage Get type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Claude Connection Usage tags: - Agentic /api/v1/agentic/execute/{flow_name}: post: description: >- Execute a named flow from the flows directory.

Named assistant flows embed an Agent that needs provider/model/api-key
context. Resolving it here (instead of running the raw file) turns a
silent 500 into a successful run, or a clear 4xx when no provider is set. operationId: execute_named_flow_api_v1_agentic_execute__flow_name__post parameters: - in: path name: flow_name required: true schema: title: Flow Name type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AssistantRequest' required: true responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Execute Named Flow Api V1 Agentic Execute Flow Name Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Execute Named Flow tags: - Agentic /api/v1/agentic/files: get: description: >- Return the contents of a sandboxed file as text (or as an attachment).

Raises:
HTTPException(400): The path shape is invalid (traversal, absolute,
null byte, etc.). No I/O is attempted.
HTTPException(404): The file does not exist in the requesting user's
sandbox. Same status for sandbox-internal "not found" and for
"path resolves outside the user namespace" — by design, to avoid
leaking namespace existence to another tenant.
HTTPException(413): The file is larger than ``MAX_FILE_SIZE_BYTES``.
HTTPException(415): The file is binary (null byte in the first 8 KiB). operationId: get_file_api_v1_agentic_files_get parameters: - in: query name: path required: true schema: maxLength: 1024 minLength: 1 title: Path type: string - in: query name: download required: false schema: default: false title: Download type: boolean responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get File tags: - Agentic /api/v1/agentic/memory: get: description: List the admin's tenant knowledge base (Company Knowledge panel). operationId: list_tenant_memory_api_v1_agentic_memory_get parameters: - in: query name: include_archived required: false schema: default: false title: Include Archived type: boolean responses: '200': content: application/json: schema: items: additionalProperties: true type: object title: Response List Tenant Memory Api V1 Agentic Memory Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Tenant Memory tags: - Agentic post: description: Create a curated tenant-memory entry (secret-scanned by the service). operationId: create_tenant_memory_api_v1_agentic_memory_post requestBody: content: application/json: schema: $ref: '#/components/schemas/_MemoryCreateRequest' required: true responses: '200': content: application/json: schema: additionalProperties: true title: Response Create Tenant Memory Api V1 Agentic Memory Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Tenant Memory tags: - Agentic /api/v1/agentic/memory/candidates/reject-all: post: description: >- Archive every pending reflection candidate for the admin's tenant in one shot. operationId: >- reject_all_tenant_memory_candidates_api_v1_agentic_memory_candidates_reject_all_post responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Reject All Tenant Memory Candidates Api V1 Agentic Memory Candidates Reject All Post type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Reject All Tenant Memory Candidates tags: - Agentic /api/v1/agentic/memory/reflect: post: description: >- Run the reflection sweep now, scoped to the admin's tenant (manual trigger).

Distills settled sessions into candidate entries for the review queue. Useful for
testing and on-demand curation without waiting for the periodic sweep. operationId: trigger_tenant_memory_reflection_api_v1_agentic_memory_reflect_post responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Trigger Tenant Memory Reflection Api V1 Agentic Memory Reflect Post type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Trigger Tenant Memory Reflection tags: - Agentic /api/v1/agentic/memory/reflect/baseline: post: description: >- Ignore all past sessions: mark them reflected without distilling (start fresh).

After this, reflection only learns from sessions that settle going forward — old
exploratory history is never mined into candidates. operationId: >- baseline_tenant_memory_reflection_api_v1_agentic_memory_reflect_baseline_post responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Baseline Tenant Memory Reflection Api V1 Agentic Memory Reflect Baseline Post type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Baseline Tenant Memory Reflection tags: - Agentic /api/v1/agentic/memory/{memory_id}: delete: description: Hard-delete a tenant-memory entry (tenant-scoped). operationId: delete_tenant_memory_api_v1_agentic_memory__memory_id__delete parameters: - in: path name: memory_id required: true schema: format: uuid title: Memory Id type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Delete Tenant Memory Api V1 Agentic Memory Memory Id Delete type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Tenant Memory tags: - Agentic put: description: Edit a tenant-memory entry. 404 unless it belongs to the admin's tenant. operationId: update_tenant_memory_api_v1_agentic_memory__memory_id__put parameters: - in: path name: memory_id required: true schema: format: uuid title: Memory Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/_MemoryUpdateRequest' required: true responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Update Tenant Memory Api V1 Agentic Memory Memory Id Put type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Tenant Memory tags: - Agentic /api/v1/agentic/memory/{memory_id}/approve: post: description: >- Approve a reflection candidate so it becomes active and starts being injected.

This is the privacy gate: nothing auto-distilled affects sessions until a tenant
admin approves it here. operationId: approve_tenant_memory_api_v1_agentic_memory__memory_id__approve_post parameters: - in: path name: memory_id required: true schema: format: uuid title: Memory Id type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Approve Tenant Memory Api V1 Agentic Memory Memory Id Approve Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Approve Tenant Memory tags: - Agentic /api/v1/agentic/memory/{memory_id}/archive: post: description: >- Archive an entry so it stops being injected, without deleting its history. operationId: archive_tenant_memory_api_v1_agentic_memory__memory_id__archive_post parameters: - in: path name: memory_id required: true schema: format: uuid title: Memory Id type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Archive Tenant Memory Api V1 Agentic Memory Memory Id Archive Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Archive Tenant Memory tags: - Agentic /api/v1/agentic/memory/{memory_id}/reject: post: description: Reject a reflection candidate (archive it) so it never becomes active. operationId: reject_tenant_memory_api_v1_agentic_memory__memory_id__reject_post parameters: - in: path name: memory_id required: true schema: format: uuid title: Memory Id type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Reject Tenant Memory Api V1 Agentic Memory Memory Id Reject Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Reject Tenant Memory tags: - Agentic /api/v1/agentic/sessions/reset: post: description: >- Drop the calling user's session-scoped state.

Wipes:
- conversation buffer for ``session_id`` (if provided).
- registered components under the user's FS sandbox.

The user id is sourced from the authenticated session — the
``session_id`` query parameter only addresses the conversation
buffer entry and is never trusted for path resolution.

Returns a small envelope describing what was cleared, sufficient
for ops/log correlation but stripped of anything sensitive:

```
{"status": "ok", "components_cleared": , "session_id": }
``` operationId: reset_session_api_v1_agentic_sessions_reset_post parameters: - in: query name: session_id required: false schema: anyOf: - maxLength: 128 type: string - type: 'null' title: Session Id responses: '200': content: application/json: schema: additionalProperties: true title: Response Reset Session Api V1 Agentic Sessions Reset Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Reset Session tags: - agentic /api/v1/agentic/vibe/attachments: post: description: >- Upload a chat-private Janus attachment to temp storage, not workspace Files. operationId: upload_vibe_attachment_api_v1_agentic_vibe_attachments_post parameters: - in: query name: session_id required: false schema: anyOf: - type: string - type: 'null' title: Session Id requestBody: content: multipart/form-data: schema: $ref: >- #/components/schemas/Body_upload_vibe_attachment_api_v1_agentic_vibe_attachments_post required: true responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Upload Vibe Attachment Api V1 Agentic Vibe Attachments Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Upload Vibe Attachment tags: - Agentic /api/v1/agentic/vibe/runs: post: description: Start a background Janus run or append input to the current active run. operationId: start_or_enqueue_vibe_run_api_v1_agentic_vibe_runs_post requestBody: content: application/json: schema: $ref: '#/components/schemas/VibeBuildRequest' required: true responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Start Or Enqueue Vibe Run Api V1 Agentic Vibe Runs Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Start Or Enqueue Vibe Run tags: - Agentic /api/v1/agentic/vibe/runs/active: get: description: >- Return the active Janus run for a flow/session so remounted UIs can reconnect.

When the provided session pointer is stale, fall back to the flow's newest
active run and return that run's real session id. When no run is active,
fall back to the newest recent run with a durable event log. The background
task persists the conversation to the event log (but not to the
frontend-owned transcript), so a UI returning to the flow can replay that log
to reconstruct a conversation that finished while the panel was unmounted
instead of showing a blank chat. operationId: get_active_vibe_run_api_v1_agentic_vibe_runs_active_get parameters: - in: query name: flow_id required: true schema: title: Flow Id type: string - in: query name: session_id required: false schema: anyOf: - type: string - type: 'null' title: Session Id responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Get Active Vibe Run Api V1 Agentic Vibe Runs Active Get type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Active Vibe Run tags: - Agentic /api/v1/agentic/vibe/runs/{run_id}/approve: post: description: Approve a paused run and atomically start its continuation. operationId: approve_vibe_run_api_v1_agentic_vibe_runs__run_id__approve_post parameters: - in: path name: run_id required: true schema: format: uuid title: Run Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/_RunActionRequest' required: true responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Approve Vibe Run Api V1 Agentic Vibe Runs Run Id Approve Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Approve Vibe Run tags: - Agentic /api/v1/agentic/vibe/runs/{run_id}/cancel: post: description: Explicitly cancel a background Janus run. operationId: cancel_vibe_run_api_v1_agentic_vibe_runs__run_id__cancel_post parameters: - in: path name: run_id required: true schema: format: uuid title: Run Id type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Cancel Vibe Run Api V1 Agentic Vibe Runs Run Id Cancel Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Cancel Vibe Run tags: - Agentic /api/v1/agentic/vibe/runs/{run_id}/events: get: description: Replay stored events after ``after_seq`` and then follow the live run. operationId: stream_vibe_run_events_api_v1_agentic_vibe_runs__run_id__events_get parameters: - in: path name: run_id required: true schema: format: uuid title: Run Id type: string - in: query name: after_seq required: false schema: default: 0 title: After Seq type: integer responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Stream Vibe Run Events tags: - Agentic /api/v1/agentic/vibe/runs/{run_id}/reject: post: operationId: reject_vibe_run_api_v1_agentic_vibe_runs__run_id__reject_post parameters: - in: path name: run_id required: true schema: format: uuid title: Run Id type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Reject Vibe Run Api V1 Agentic Vibe Runs Run Id Reject Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Reject Vibe Run tags: - Agentic /api/v1/agentic/vibe/runs/{run_id}/undo: post: operationId: undo_vibe_run_api_v1_agentic_vibe_runs__run_id__undo_post parameters: - in: path name: run_id required: true schema: format: uuid title: Run Id type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Undo Vibe Run Api V1 Agentic Vibe Runs Run Id Undo Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Undo Vibe Run tags: - Agentic /api/v1/agentic/vibe/sessions: get: description: >- List the current user's assistant sessions for a flow.

Server-authoritative and strictly per-user: a user never sees another user's
sessions, and history survives backend restarts / page reloads (Phase 0b).
HTTP 200 with ``[]`` means the query succeeded and there are no sessions.
Query failures must not look like that empty list, or the client would drop
local history. operationId: list_vibe_sessions_api_v1_agentic_vibe_sessions_get parameters: - in: query name: flow_id required: true schema: title: Flow Id type: string responses: '200': content: application/json: schema: items: additionalProperties: true type: object title: Response List Vibe Sessions Api V1 Agentic Vibe Sessions Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Vibe Sessions tags: - Agentic /api/v1/agentic/vibe/sessions/{session_id}: delete: description: Delete one of the current user's sessions and its durable transcript. operationId: delete_vibe_session_api_v1_agentic_vibe_sessions__session_id__delete parameters: - in: path name: session_id required: true schema: title: Session Id type: string - in: query name: flow_id required: true schema: title: Flow Id type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Delete Vibe Session Api V1 Agentic Vibe Sessions Session Id Delete type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Vibe Session tags: - Agentic get: description: Restore one session's saved conversation. 404 unless owned by the user. operationId: get_vibe_session_api_v1_agentic_vibe_sessions__session_id__get parameters: - in: path name: session_id required: true schema: title: Session Id type: string - in: query name: flow_id required: true schema: title: Flow Id type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Get Vibe Session Api V1 Agentic Vibe Sessions Session Id Get type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Vibe Session tags: - Agentic put: description: Mirror the current user's rendered conversation for a session to the DB. operationId: save_vibe_session_api_v1_agentic_vibe_sessions__session_id__put parameters: - in: path name: session_id required: true schema: title: Session Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/_SaveSessionRequest' required: true responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Save Vibe Session Api V1 Agentic Vibe Sessions Session Id Put type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Save Vibe Session tags: - Agentic /api/v1/agentic/vibe/sessions/{session_id}/fork: post: description: >- Create a private assistant-session branch without changing the source conversation.

Forks two things: the rendered message list (display history) and — when the
source session has a Claude transcript — the agent context itself, truncated
at the edited message's recorded anchor so the branch genuinely continues
the conversation instead of starting cold. operationId: fork_vibe_session_api_v1_agentic_vibe_sessions__session_id__fork_post parameters: - in: path name: session_id required: true schema: title: Session Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/_ForkSessionRequest' required: true responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Fork Vibe Session Api V1 Agentic Vibe Sessions Session Id Fork Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Fork Vibe Session tags: - Agentic /api/v1/agentic/vibe/sessions/{session_id}/rewind: post: description: >- Rewind flow + DB + transcript to before a chosen past user turn.

Unlike undo (which reverts the latest run), this targets any user message
that has a stored per-turn checkpoint, restoring all three axes to that
turn's pre-state. The frontend truncates the visible conversation after it. operationId: >- rewind_vibe_session_api_v1_agentic_vibe_sessions__session_id__rewind_post parameters: - in: path name: session_id required: true schema: title: Session Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/_RewindRequest' required: true responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Rewind Vibe Session Api V1 Agentic Vibe Sessions Session Id Rewind Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Rewind Vibe Session tags: - Agentic /api/v1/agentic/vibe/stream: post: description: Build or repair a flow with the Claude Agent SDK backed Vibe Builder. operationId: vibe_stream_api_v1_agentic_vibe_stream_post requestBody: content: application/json: schema: $ref: '#/components/schemas/VibeBuildRequest' required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Vibe Stream tags: - Agentic /api/v1/all: get: description: >- Retrieve all component types with compression for better performance.

Returns a compressed response containing all available component types,
with display_names translated to the locale indicated by Accept-Language.
Tenant component policy does not filter this catalog; run/build enforces it. operationId: get_all_api_v1_all_get parameters: - in: query name: force_refresh required: false schema: default: false title: Force Refresh type: boolean responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get All tags: - Base /api/v1/authz/audit: get: description: >- Return a paginated slice of the audit log filtered by the given query params.

Superuser only. The composite indexes on ``(user_id, timestamp)`` and
``(resource_type, resource_id)`` keep both "show me events for user X"
and "show me events on resource Y" fast at scale. operationId: list_audit_log_api_v1_authz_audit_get parameters: - description: Filter by acting user id. in: query name: user_id required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Filter by acting user id. title: User Id - description: Filter by resource type slug, e.g. ``flow`` or ``deployment``. in: query name: resource_type required: false schema: anyOf: - type: string - type: 'null' description: Filter by resource type slug, e.g. ``flow`` or ``deployment``. title: Resource Type - description: Filter by resource UUID. in: query name: resource_id required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Filter by resource UUID. title: Resource Id - description: Filter by action string, e.g. ``flow:read`` or ``share:create``. in: query name: action required: false schema: anyOf: - type: string - type: 'null' description: Filter by action string, e.g. ``flow:read`` or ``share:create``. title: Action - description: >- Filter by decision result (``allow`` / ``deny`` / ``owner_override``). in: query name: result required: false schema: anyOf: - type: string - type: 'null' description: >- Filter by decision result (``allow`` / ``deny`` / ``owner_override``). title: Result - description: Inclusive lower bound on ``timestamp``. in: query name: since required: false schema: anyOf: - format: date-time type: string - type: 'null' description: Inclusive lower bound on ``timestamp``. title: Since - description: Exclusive upper bound on ``timestamp``. in: query name: until required: false schema: anyOf: - format: date-time type: string - type: 'null' description: Exclusive upper bound on ``timestamp``. title: Until - in: query name: page required: false schema: default: 1 minimum: 1 title: Page type: integer - in: query name: size required: false schema: default: 50 maximum: 200 minimum: 1 title: Size type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthzAuditPage' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Audit Log tags: - Authorization /api/v1/authz/audit/: get: description: >- Return a paginated slice of the audit log filtered by the given query params.

Superuser only. The composite indexes on ``(user_id, timestamp)`` and
``(resource_type, resource_id)`` keep both "show me events for user X"
and "show me events on resource Y" fast at scale. operationId: list_audit_log_api_v1_authz_audit__get parameters: - description: Filter by acting user id. in: query name: user_id required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Filter by acting user id. title: User Id - description: Filter by resource type slug, e.g. ``flow`` or ``deployment``. in: query name: resource_type required: false schema: anyOf: - type: string - type: 'null' description: Filter by resource type slug, e.g. ``flow`` or ``deployment``. title: Resource Type - description: Filter by resource UUID. in: query name: resource_id required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Filter by resource UUID. title: Resource Id - description: Filter by action string, e.g. ``flow:read`` or ``share:create``. in: query name: action required: false schema: anyOf: - type: string - type: 'null' description: Filter by action string, e.g. ``flow:read`` or ``share:create``. title: Action - description: >- Filter by decision result (``allow`` / ``deny`` / ``owner_override``). in: query name: result required: false schema: anyOf: - type: string - type: 'null' description: >- Filter by decision result (``allow`` / ``deny`` / ``owner_override``). title: Result - description: Inclusive lower bound on ``timestamp``. in: query name: since required: false schema: anyOf: - format: date-time type: string - type: 'null' description: Inclusive lower bound on ``timestamp``. title: Since - description: Exclusive upper bound on ``timestamp``. in: query name: until required: false schema: anyOf: - format: date-time type: string - type: 'null' description: Exclusive upper bound on ``timestamp``. title: Until - in: query name: page required: false schema: default: 1 minimum: 1 title: Page type: integer - in: query name: size required: false schema: default: 50 maximum: 200 minimum: 1 title: Size type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthzAuditPage' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Audit Log tags: - Authorization /api/v1/authz/me/permissions: post: description: >- Return per-resource allowed actions for the current user.

Use this to render the UI permission gate (greyed-out buttons etc.) without
flooding the audit log with denied probes. Empty list for a resource_id
means the user cannot perform any of the requested actions on that resource. operationId: get_effective_permissions_api_v1_authz_me_permissions_post requestBody: content: application/json: schema: $ref: '#/components/schemas/EffectivePermissionsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EffectivePermissionsResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Effective Permissions tags: - Authorization /api/v1/authz/role-assignments: get: description: >- List role assignments scoped to one user.

* Omitting ``user_id`` defaults to the caller — no superuser needed.
* Passing ``user_id == self.id`` is the same as omitting it.
* Passing a different ``user_id`` requires superuser; otherwise 403.

Results are always filtered by the resolved ``user_id``. Admins who need
cross-user lookups make one call per user. Paginated via ``limit`` /
``offset`` (default 100, max 200). operationId: list_assignments_api_v1_authz_role_assignments_get parameters: - description: Filter by user in: query name: user_id required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Filter by user title: User Id - description: Filter by role in: query name: role_id required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Filter by role title: Role Id - in: query name: domain_type required: false schema: anyOf: - type: string - type: 'null' title: Domain Type - in: query name: domain_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Domain Id - in: query name: limit required: false schema: default: 100 maximum: 200 minimum: 1 title: Limit type: integer - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/RoleAssignmentRead' title: Response List Assignments Api V1 Authz Role Assignments Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Assignments tags: - Authorization post: description: Assign a role to a user. Superuser-only. operationId: create_assignment_api_v1_authz_role_assignments_post requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Assignment tags: - Authorization /api/v1/authz/role-assignments/: get: description: >- List role assignments scoped to one user.

* Omitting ``user_id`` defaults to the caller — no superuser needed.
* Passing ``user_id == self.id`` is the same as omitting it.
* Passing a different ``user_id`` requires superuser; otherwise 403.

Results are always filtered by the resolved ``user_id``. Admins who need
cross-user lookups make one call per user. Paginated via ``limit`` /
``offset`` (default 100, max 200). operationId: list_assignments_api_v1_authz_role_assignments__get parameters: - description: Filter by user in: query name: user_id required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Filter by user title: User Id - description: Filter by role in: query name: role_id required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Filter by role title: Role Id - in: query name: domain_type required: false schema: anyOf: - type: string - type: 'null' title: Domain Type - in: query name: domain_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Domain Id - in: query name: limit required: false schema: default: 100 maximum: 200 minimum: 1 title: Limit type: integer - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/RoleAssignmentRead' title: Response List Assignments Api V1 Authz Role Assignments Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Assignments tags: - Authorization post: description: Assign a role to a user. Superuser-only. operationId: create_assignment_api_v1_authz_role_assignments__post requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/RoleAssignmentRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Assignment tags: - Authorization /api/v1/authz/role-assignments/{assignment_id}: delete: description: Revoke a role assignment. Superuser-only. operationId: delete_assignment_api_v1_authz_role_assignments__assignment_id__delete parameters: - in: path name: assignment_id required: true schema: format: uuid title: Assignment Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Assignment tags: - Authorization /api/v1/authz/roles: get: description: >- List roles. Open to authenticated users so the UI can populate dropdowns.

Paginated via ``limit`` / ``offset`` so a single call cannot return the
entire catalog of roles + their permissions. Stable order is ``(name, id)``
so ``offset`` is deterministic across calls. operationId: list_roles_api_v1_authz_roles_get parameters: - description: Filter by is_system flag in: query name: is_system required: false schema: anyOf: - type: boolean - type: 'null' description: Filter by is_system flag title: Is System - description: Substring match on role name in: query name: name required: false schema: anyOf: - type: string - type: 'null' description: Substring match on role name title: Name - in: query name: limit required: false schema: default: 100 maximum: 200 minimum: 1 title: Limit type: integer - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/RoleRead' title: Response List Roles Api V1 Authz Roles Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Roles tags: - Authorization post: description: Create a custom (non-system) role. Superuser-only. operationId: create_role_api_v1_authz_roles_post requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/RoleRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Role tags: - Authorization /api/v1/authz/roles/: get: description: >- List roles. Open to authenticated users so the UI can populate dropdowns.

Paginated via ``limit`` / ``offset`` so a single call cannot return the
entire catalog of roles + their permissions. Stable order is ``(name, id)``
so ``offset`` is deterministic across calls. operationId: list_roles_api_v1_authz_roles__get parameters: - description: Filter by is_system flag in: query name: is_system required: false schema: anyOf: - type: boolean - type: 'null' description: Filter by is_system flag title: Is System - description: Substring match on role name in: query name: name required: false schema: anyOf: - type: string - type: 'null' description: Substring match on role name title: Name - in: query name: limit required: false schema: default: 100 maximum: 200 minimum: 1 title: Limit type: integer - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/RoleRead' title: Response List Roles Api V1 Authz Roles Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Roles tags: - Authorization post: description: Create a custom (non-system) role. Superuser-only. operationId: create_role_api_v1_authz_roles__post requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/RoleRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Role tags: - Authorization /api/v1/authz/roles/{role_id}: delete: description: >- Delete a custom role.

System roles cannot be deleted; roles with active assignments return 409
(delete the assignments first). operationId: delete_role_api_v1_authz_roles__role_id__delete parameters: - in: path name: role_id required: true schema: format: uuid title: Role Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Role tags: - Authorization get: operationId: read_role_api_v1_authz_roles__role_id__get parameters: - in: path name: role_id required: true schema: format: uuid title: Role Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RoleRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Read Role tags: - Authorization patch: description: Update fields on a custom role. System roles are read-only. operationId: update_role_api_v1_authz_roles__role_id__patch parameters: - in: path name: role_id required: true schema: format: uuid title: Role Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleUpdate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RoleRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Role tags: - Authorization /api/v1/authz/shares: get: description: List share rows visible to the caller (paginated, max 200). operationId: list_shares_api_v1_authz_shares_get parameters: - in: query name: resource_type required: false schema: anyOf: - type: string - type: 'null' title: Resource Type - in: query name: resource_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Resource Id - in: query name: target_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Target Id - in: query name: scope required: false schema: anyOf: - type: string - type: 'null' title: Scope - in: query name: limit required: false schema: default: 100 maximum: 200 minimum: 1 title: Limit type: integer - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ShareRead' title: Response List Shares Api V1 Authz Shares Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Shares tags: - Authorization post: description: Create an authz_share row for a resource. operationId: create_share_api_v1_authz_shares_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ShareCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ShareRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Share tags: - Authorization /api/v1/authz/shares/: get: description: List share rows visible to the caller (paginated, max 200). operationId: list_shares_api_v1_authz_shares__get parameters: - in: query name: resource_type required: false schema: anyOf: - type: string - type: 'null' title: Resource Type - in: query name: resource_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Resource Id - in: query name: target_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Target Id - in: query name: scope required: false schema: anyOf: - type: string - type: 'null' title: Scope - in: query name: limit required: false schema: default: 100 maximum: 200 minimum: 1 title: Limit type: integer - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ShareRead' title: Response List Shares Api V1 Authz Shares Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Shares tags: - Authorization post: description: Create an authz_share row for a resource. operationId: create_share_api_v1_authz_shares__post requestBody: content: application/json: schema: $ref: '#/components/schemas/ShareCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ShareRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Share tags: - Authorization /api/v1/authz/shares/{share_id}: delete: description: Revoke an existing share. operationId: delete_share_api_v1_authz_shares__share_id__delete parameters: - in: path name: share_id required: true schema: format: uuid title: Share Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Share tags: - Authorization get: description: Fetch a single share by id with the same visibility rules as list. operationId: get_share_api_v1_authz_shares__share_id__get parameters: - in: path name: share_id required: true schema: format: uuid title: Share Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShareRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Share tags: - Authorization patch: description: Update the permission level of an existing share. operationId: update_share_api_v1_authz_shares__share_id__patch parameters: - in: path name: share_id required: true schema: format: uuid title: Share Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ShareUpdate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShareRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Share tags: - Authorization /api/v1/authz/teams: get: description: >- List teams. Open to any authenticated user (for the share dialog's team picker).

Paginated via ``limit`` / ``offset`` so a single call cannot enumerate every
team. Stable order is ``(team_name, id)`` so ``offset`` is deterministic. operationId: list_teams_api_v1_authz_teams_get parameters: - description: Substring match on team_name or adom_name in: query name: search required: false schema: anyOf: - type: string - type: 'null' description: Substring match on team_name or adom_name title: Search - in: query name: is_active required: false schema: anyOf: - type: boolean - type: 'null' title: Is Active - in: query name: limit required: false schema: default: 100 maximum: 200 minimum: 1 title: Limit type: integer - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TeamRead' title: Response List Teams Api V1 Authz Teams Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Teams tags: - Authorization post: operationId: create_team_api_v1_authz_teams_post requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/TeamRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Team tags: - Authorization /api/v1/authz/teams/: get: description: >- List teams. Open to any authenticated user (for the share dialog's team picker).

Paginated via ``limit`` / ``offset`` so a single call cannot enumerate every
team. Stable order is ``(team_name, id)`` so ``offset`` is deterministic. operationId: list_teams_api_v1_authz_teams__get parameters: - description: Substring match on team_name or adom_name in: query name: search required: false schema: anyOf: - type: string - type: 'null' description: Substring match on team_name or adom_name title: Search - in: query name: is_active required: false schema: anyOf: - type: boolean - type: 'null' title: Is Active - in: query name: limit required: false schema: default: 100 maximum: 200 minimum: 1 title: Limit type: integer - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TeamRead' title: Response List Teams Api V1 Authz Teams Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Teams tags: - Authorization post: operationId: create_team_api_v1_authz_teams__post requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/TeamRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Team tags: - Authorization /api/v1/authz/teams/{team_id}: delete: operationId: delete_team_api_v1_authz_teams__team_id__delete parameters: - in: path name: team_id required: true schema: format: uuid title: Team Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Team tags: - Authorization get: operationId: read_team_api_v1_authz_teams__team_id__get parameters: - in: path name: team_id required: true schema: format: uuid title: Team Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TeamRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Read Team tags: - Authorization patch: operationId: update_team_api_v1_authz_teams__team_id__patch parameters: - in: path name: team_id required: true schema: format: uuid title: Team Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamUpdate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TeamRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Team tags: - Authorization /api/v1/authz/teams/{team_id}/members: get: description: >- List members of a team. Any authenticated user (so the UI can render team rosters).

Paginated via ``limit`` / ``offset`` so a single call cannot enumerate a
large team's full roster. Stable order is ``(created_at, user_id)``. operationId: list_members_api_v1_authz_teams__team_id__members_get parameters: - in: path name: team_id required: true schema: format: uuid title: Team Id type: string - in: query name: limit required: false schema: default: 100 maximum: 200 minimum: 1 title: Limit type: integer - in: query name: offset required: false schema: default: 0 minimum: 0 title: Offset type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TeamMemberRead' title: Response List Members Api V1 Authz Teams Team Id Members Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Members tags: - Authorization post: operationId: add_member_api_v1_authz_teams__team_id__members_post parameters: - in: path name: team_id required: true schema: format: uuid title: Team Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamMemberCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/TeamMemberRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Add Member tags: - Authorization /api/v1/authz/teams/{team_id}/members/{user_id}: delete: operationId: remove_member_api_v1_authz_teams__team_id__members__user_id__delete parameters: - in: path name: team_id required: true schema: format: uuid title: Team Id type: string - in: path name: user_id required: true schema: format: uuid title: User Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Remove Member tags: - Authorization /api/v1/build/{flow_id}/flow: post: description: >- Build and process a flow, returning a job ID for event polling.

This endpoint requires authentication through the CurrentActiveUser dependency.
For public flows that don't require authentication, use the /build_public_tmp/flow_id/flow endpoint.

Args:
request: Incoming HTTP request (RBAC context)
flow_id: UUID of the flow to build
background_tasks: Background tasks manager
inputs: Optional input values for the flow
data: Optional flow data
files: Optional files to include
stop_component_id: Optional ID of component to stop at
start_component_id: Optional ID of component to start from
log_builds: Whether to log the build process
current_user: The authenticated user
queue_service: Queue service for job management
flow_name: Optional name for the flow
event_delivery: Optional event delivery type - default is streaming

Returns:
Dict with job_id that can be used to poll for build status operationId: build_flow_api_v1_build__flow_id__flow_post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string - in: query name: stop_component_id required: false schema: anyOf: - type: string - type: 'null' title: Stop Component Id - in: query name: start_component_id required: false schema: anyOf: - type: string - type: 'null' title: Start Component Id - in: query name: log_builds required: false schema: default: true title: Log Builds type: boolean - in: query name: flow_name required: false schema: anyOf: - type: string - type: 'null' title: Flow Name - in: query name: event_delivery required: false schema: $ref: '#/components/schemas/EventDeliveryType' default: polling requestBody: content: application/json: schema: $ref: >- #/components/schemas/Body_build_flow_api_v1_build__flow_id__flow_post responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Build Flow tags: - Chat /api/v1/build/{job_id}/cancel: post: description: >- Cancel a specific build job.

Requires authentication and ownership verification to prevent a user from
aborting another user's running build (DoS via job cancellation).
Explicitly public jobs remain accessible to authenticated users. operationId: cancel_build_api_v1_build__job_id__cancel_post parameters: - in: path name: job_id required: true schema: title: Job Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CancelFlowResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Cancel Build tags: - Chat /api/v1/build/{job_id}/events: get: description: >- Get events for a specific build job.

Requires authentication and ownership verification. A job owner is registered
when build_flow is called; if a registered owner does not match the requesting
user the endpoint returns 404 to avoid leaking job existence.
Only jobs explicitly classified as public remain accessible to other users. operationId: get_build_events_api_v1_build__job_id__events_get parameters: - in: path name: job_id required: true schema: title: Job Id type: string - in: query name: event_delivery required: false schema: $ref: '#/components/schemas/EventDeliveryType' default: streaming responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Build Events tags: - Chat /api/v1/build_public_tmp/{flow_id}/flow: post: description: >- Build a public flow without requiring authentication.

This endpoint is specifically for public flows that don't require authentication.
It uses a client_id cookie to create a deterministic flow ID for tracking purposes.

Security Note:
- The 'data' parameter is NOT accepted to prevent flow definition tampering
- Public flows must execute the stored flow definition only
- The flow definition is always loaded from the database
- Caller-supplied 'inputs.session' is namespaced under the (client_id,
flow_id) virtual flow ID so an unauthenticated caller cannot address a
session that lives outside its own namespace (CVE-2026-33017)

The endpoint:
1. Verifies the requested flow is marked as public in the database
2. Creates a deterministic UUID based on client_id and flow_id
3. Uses the flow owner's permissions to build the flow
4. Always loads the flow definition from the database

Requirements:
- The flow must be marked as PUBLIC in the database
- The request must include a client_id cookie

Args:
flow_id: UUID of the public flow to build
background_tasks: Background tasks manager
inputs: Optional input values for the flow
files: Optional files to include
stop_component_id: Optional ID of component to stop at
start_component_id: Optional ID of component to start from
log_builds: Whether to log the build process
flow_name: Optional name for the flow
request: FastAPI request object (needed for cookie access)
queue_service: Queue service for job management
authenticated_user: Optional authenticated user (resolved from cookie/token if present)
event_delivery: Optional event delivery type - default is streaming

Returns:
Dict with job_id that can be used to poll for build status operationId: build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string - in: query name: stop_component_id required: false schema: anyOf: - type: string - type: 'null' title: Stop Component Id - in: query name: start_component_id required: false schema: anyOf: - type: string - type: 'null' title: Start Component Id - in: query name: log_builds required: false schema: anyOf: - type: boolean - type: 'null' default: true title: Log Builds - in: query name: flow_name required: false schema: anyOf: - type: string - type: 'null' title: Flow Name - in: query name: event_delivery required: false schema: $ref: '#/components/schemas/EventDeliveryType' default: polling requestBody: content: application/json: schema: $ref: >- #/components/schemas/Body_build_public_tmp_api_v1_build_public_tmp__flow_id__flow_post responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Build Public Tmp tags: - Chat /api/v1/build_public_tmp/{job_id}/cancel: post: description: >- Cancel a public flow build job.

This endpoint does not require authentication, matching the public build endpoint.
It is used by the shareable playground to cancel builds. operationId: cancel_build_public_api_v1_build_public_tmp__job_id__cancel_post parameters: - in: path name: job_id required: true schema: title: Job Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CancelFlowResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Cancel Build Public tags: - Chat /api/v1/build_public_tmp/{job_id}/events: get: description: >- Get events for a public flow build job.

This endpoint does not require authentication, matching the public build endpoint.
It is used by the shareable playground to consume build events. operationId: get_build_events_public_api_v1_build_public_tmp__job_id__events_get parameters: - in: path name: job_id required: true schema: title: Job Id type: string - in: query name: event_delivery required: false schema: $ref: '#/components/schemas/EventDeliveryType' default: streaming responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Build Events Public tags: - Chat /api/v1/config: get: description: >- Retrieve application configuration settings.

Returns different configuration based on authentication status:
- Authenticated users: Full ConfigResponse with all settings
- Unauthenticated users: PublicConfigResponse with limited, safe-to-expose settings

Args:
user: The authenticated user, or None if unauthenticated.

This endpoint is public and does not require authentication.
Configuration settings are not sensitive and needed for frontend initialization.

Returns:
ConfigResponse | PublicConfigResponse: Configuration settings appropriate for the user's auth status.

Raises:
HTTPException: If an error occurs while retrieving the configuration. operationId: get_config_api_v1_config_get responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/ConfigResponse' - $ref: '#/components/schemas/PublicConfigResponse' title: Response Get Config Api V1 Config Get description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Config tags: - Base /api/v1/directory/test-connection: post: operationId: check_directory_connection_api_v1_directory_test_connection_post requestBody: content: application/json: schema: $ref: '#/components/schemas/DirectoryConnectionTestRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DirectoryConnectionTestResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Check Directory Connection tags: - Directory /api/v1/extensions/events: get: description: >- Poll for extension lifecycle events the current user has triggered.

Events are scoped to the authenticated user via a server-derived keyspace
(``user:{user_id}``); there is no client-controllable keyspace, so an
authenticated user cannot read another user's flow-migration or
bundle-reload events. A client-supplied ``keyspace`` query parameter is
rejected with 422 so the contract is explicit -- previously the value was
silently dropped, which masked client bugs that assumed it had effect.

svc.since() uses blocking sqlite3; run in a thread pool so the asyncio
event loop is not held while waiting on disk I/O. operationId: get_extension_events_api_v1_extensions_events_get parameters: - description: UTC epoch timestamp; return events after this cursor in: query name: since required: false schema: default: 0 description: UTC epoch timestamp; return events after this cursor title: Since type: number responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExtensionEventsResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Extension Events tags: - Extensions /api/v1/extensions/{extension_id}/bundles/{bundle_name}/reload: post: description: >- Trigger an atomic-swap reload for a single Bundle.

Returns the typed :class:`~lfx.extension.reload.ReloadResult` body on
success. Per the typed-error contract, structural failures
(broken bundle, missing source path, name mismatch) surface as
``422 Unprocessable Entity`` with the first typed error in the body
so clients can surface fix hints inline; the full ``ReloadResult``
payload (with all errors and warnings) is returned via the FastAPI
``detail`` envelope. Concurrency-control collisions surface as
``409 Conflict`` (``reload-in-progress``). Non-2xx is the wire
contract for every error path -- the body still carries the typed
error so the client renders the same fix-hint envelope. operationId: >- reload_extension_bundle_api_v1_extensions__extension_id__bundles__bundle_name__reload_post parameters: - in: path name: extension_id required: true schema: title: Extension Id type: string - in: path name: bundle_name required: true schema: title: Bundle Name type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Reload Extension Bundle Api V1 Extensions Extension Id Bundles Bundle Name Reload Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Reload Extension Bundle tags: - Extensions /api/v1/files/delete/{flow_id}/{file_name}: delete: operationId: delete_file_api_v1_files_delete__flow_id___file_name__delete parameters: - in: path name: file_name required: true schema: title: File Name type: string - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete File tags: - Files /api/v1/files/download/{flow_id}/{file_name}: get: operationId: download_file_api_v1_files_download__flow_id___file_name__get parameters: - in: path name: file_name required: true schema: title: File Name type: string - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Download File tags: - Files /api/v1/files/images/{flow_id}/{file_name}: get: description: >- Download image from storage for browser rendering.

Authorization is handled by the get_flow dependency so only the flow
owner (or otherwise authorized caller) can fetch images. operationId: download_image_api_v1_files_images__flow_id___file_name__get parameters: - in: path name: file_name required: true schema: title: File Name type: string - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Download Image tags: - Files /api/v1/files/list/{flow_id}: get: operationId: list_files_api_v1_files_list__flow_id__get parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Files tags: - Files /api/v1/files/profile_pictures/list: get: description: >- List profile pictures from local filesystem.

Profile pictures are first looked up in config_dir/profile_pictures/,
then fallback to the package's bundled profile_pictures directory. operationId: list_profile_pictures_api_v1_files_profile_pictures_list_get responses: '200': content: application/json: schema: {} description: Successful Response summary: List Profile Pictures tags: - Files /api/v1/files/profile_pictures/{folder_name}/{file_name}: get: description: >- Read a contained config asset, then fall back to a contained package asset. operationId: >- download_profile_picture_api_v1_files_profile_pictures__folder_name___file_name__get parameters: - in: path name: folder_name required: true schema: title: Folder Name type: string - in: path name: file_name required: true schema: title: File Name type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Download Profile Picture tags: - Files /api/v1/files/upload/{flow_id}: post: operationId: upload_file_api_v1_files_upload__flow_id__post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: multipart/form-data: schema: $ref: >- #/components/schemas/Body_upload_file_api_v1_files_upload__flow_id__post required: true responses: '201': content: application/json: schema: $ref: >- #/components/schemas/langflow__api__v1__schemas__UploadFileResponse description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Upload File tags: - Files /api/v1/flows/: delete: description: Delete multiple flows by their IDs. operationId: delete_multiple_flows_api_v1_flows__delete requestBody: content: application/json: schema: items: format: uuid type: string title: Flow Ids type: array required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Multiple Flows tags: - Flows get: description: >- Retrieve a list of flows with pagination support.

Args:
current_user (User): The current authenticated user.
session (Session): The database session.
request (Request): The incoming request (used for RBAC context).
components_only (bool, optional): Whether to return only components. Defaults to False.
is_flow (bool, optional): Whether to return only flows (exclude components). Defaults to False.

get_all (bool, optional): Whether to return all flows without pagination. Defaults to True.
**This field must be True because of backward compatibility with the frontend - Release: 1.0.20**

folder_id (UUID, optional): The project ID. Defaults to None.
params (Params): Pagination parameters.
remove_example_flows (bool, optional): Whether to remove example flows. Defaults to False.
header_flows (bool, optional): Whether to return only specific headers of the flows. Defaults to False.
access_type (AccessTypeEnum, optional): Filter flows by access type.
workspace_id (UUID, optional): Filter flows by workspace id.
search (str, optional): Search term for flow name/description.

Returns:
list[FlowRead] | Page[FlowRead] | list[FlowHeader]
A list of flows or a paginated response containing the list of flows or a list of flow headers. operationId: read_flows_api_v1_flows__get parameters: - in: query name: remove_example_flows required: false schema: default: false title: Remove Example Flows type: boolean - in: query name: components_only required: false schema: default: false title: Components Only type: boolean - in: query name: is_flow required: false schema: default: false title: Is Flow type: boolean - in: query name: get_all required: false schema: default: true title: Get All type: boolean - in: query name: folder_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Folder Id - in: query name: header_flows required: false schema: default: false title: Header Flows type: boolean - in: query name: access_type required: false schema: anyOf: - $ref: '#/components/schemas/AccessTypeEnum' - type: 'null' title: Access Type - in: query name: workspace_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Workspace Id - in: query name: search required: false schema: default: '' title: Search type: string - in: query name: page required: false schema: default: 1 minimum: 1 title: Page type: integer - in: query name: size required: false schema: default: 50 maximum: 100 minimum: 1 title: Size type: integer responses: '200': content: application/json: schema: anyOf: - items: $ref: '#/components/schemas/FlowRead' type: array - $ref: '#/components/schemas/Page_FlowRead_' - items: $ref: '#/components/schemas/FlowHeader' type: array title: Response Read Flows Api V1 Flows Get description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Read Flows tags: - Flows post: operationId: create_flow_api_v1_flows__post requestBody: content: application/json: schema: $ref: '#/components/schemas/FlowCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FlowRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Flow tags: - Flows /api/v1/flows/basic_examples/: get: description: Retrieve a list of basic example flows. operationId: read_basic_examples_api_v1_flows_basic_examples__get responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/FlowRead' title: Response Read Basic Examples Api V1 Flows Basic Examples Get type: array description: Successful Response summary: Read Basic Examples tags: - Flows /api/v1/flows/batch/: post: description: Create multiple new flows. operationId: create_flows_api_v1_flows_batch__post requestBody: content: application/json: schema: $ref: '#/components/schemas/FlowListCreate' required: true responses: '201': content: application/json: schema: items: $ref: '#/components/schemas/FlowRead' title: Response Create Flows Api V1 Flows Batch Post type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Flows tags: - Flows /api/v1/flows/download/: post: description: Download all flows as a zip file. operationId: download_multiple_file_api_v1_flows_download__post requestBody: content: application/json: schema: items: format: uuid type: string title: Flow Ids type: array required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Download Multiple File tags: - Flows /api/v1/flows/public_flow/{flow_id}: get: description: Read a public flow. operationId: read_public_flow_api_v1_flows_public_flow__flow_id__get parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/FlowRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Read Public Flow tags: - Flows /api/v1/flows/shared-with-me: get: operationId: read_flows_shared_with_me_api_v1_flows_shared_with_me_get responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/FlowRead' title: >- Response Read Flows Shared With Me Api V1 Flows Shared With Me Get type: array description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Read Flows Shared With Me tags: - Flows /api/v1/flows/upload/: post: description: >- Upload flows from a JSON or ZIP file (upsert semantics for flows with stable IDs). operationId: upload_file_api_v1_flows_upload__post parameters: - in: query name: folder_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Folder Id requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_upload_file_api_v1_flows_upload__post' responses: '201': content: application/json: schema: items: $ref: '#/components/schemas/FlowRead' title: Response Upload File Api V1 Flows Upload Post type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Upload File tags: - Flows /api/v1/flows/{flow_id}: delete: description: Delete a flow. operationId: delete_flow_api_v1_flows__flow_id__delete parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Flow tags: - Flows get: description: Read a flow. operationId: read_flow_api_v1_flows__flow_id__get parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/FlowRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Read Flow tags: - Flows patch: description: Update a flow. operationId: update_flow_api_v1_flows__flow_id__patch parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlowUpdate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FlowRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Flow tags: - Flows put: description: >- Create or update a flow with a specific ID (upsert).

Returns 201 for creation, 200 for update. Returns 404 if owned by another user. operationId: upsert_flow_api_v1_flows__flow_id__put parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlowCreate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FlowRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Upsert Flow tags: - Flows /api/v1/flows/{flow_id}/copy-to-person: post: description: >- Copy a flow to another person (their personal workspace) within the same tenant.

Requires WORKSPACE_ADMIN (or tenant admin / superuser). operationId: copy_flow_to_person_api_v1_flows__flow_id__copy_to_person_post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlowCopyToPersonRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FlowRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Copy Flow To Person tags: - Flows /api/v1/flows/{flow_id}/copy-to-workspace: post: description: >- Copy a flow to another workspace within the same tenant.

Requires WORKSPACE_ADMIN (or tenant admin / superuser). operationId: copy_flow_to_workspace_api_v1_flows__flow_id__copy_to_workspace_post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlowCopyToWorkspaceRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FlowRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Copy Flow To Workspace tags: - Flows /api/v1/flows/{flow_id}/events: get: operationId: get_flow_events_api_v1_flows__flow_id__events_get parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string - description: UTC timestamp to get events after in: query name: since required: false schema: default: 0 description: UTC timestamp to get events after title: Since type: number responses: '200': content: application/json: schema: $ref: '#/components/schemas/FlowEventsResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Flow Events tags: - Flow Events post: description: Append an event to a flow's event queue. operationId: create_flow_event_api_v1_flows__flow_id__events_post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlowEventCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FlowEventResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Flow Event tags: - Flow Events /api/v1/flows/{flow_id}/note_translations: get: description: >- Return translated note node descriptions for the current locale.

Returns a mapping of node_id → translated markdown text. Only nodes
with a matching translation key are included; nodes without translations
are omitted so the caller can leave them unchanged.

A missing or inaccessible flow yields 404 (via the shared read guard),
consistent with the guarded ``GET /flows/{id}``; the sole frontend caller (NoteNode)
treats that as "no translations" and renders the original text. operationId: get_note_translations_api_v1_flows__flow_id__note_translations_get parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: additionalProperties: type: string title: >- Response Get Note Translations Api V1 Flows Flow Id Note Translations Get type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Note Translations tags: - Flows /api/v1/flows/{flow_id}/share: post: description: Share a flow with specific users and/or workspaces. operationId: share_flow_endpoint_api_v1_flows__flow_id__share_post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlowShareRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FlowShareResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Share Flow Endpoint tags: - Flows /api/v1/flows/{flow_id}/share-info: get: description: Retrieve sharing information for a flow. operationId: get_flow_share_info_api_v1_flows__flow_id__share_info_get parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/FlowShareInfo' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Flow Share Info tags: - Flows /api/v1/flows/{flow_id}/unshare: post: description: Remove user and/or workspace sharing from a flow. operationId: unshare_flow_endpoint_api_v1_flows__flow_id__unshare_post parameters: - in: path name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FlowUnshareRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FlowUnshareResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Unshare Flow Endpoint tags: - Flows /api/v1/hitl/requests/{hitl_id}: get: operationId: get_hitl_request_api_v1_hitl_requests__hitl_id__get parameters: - in: path name: hitl_id required: true schema: format: uuid title: Hitl Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HITLRequestPublic' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Hitl Request tags: - HITL /api/v1/hitl/requests/{hitl_id}/expire: post: operationId: expire_hitl_request_api_v1_hitl_requests__hitl_id__expire_post parameters: - in: path name: hitl_id required: true schema: format: uuid title: Hitl Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HITLRequestPublic' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Expire Hitl Request tags: - HITL /api/v1/hitl/requests/{token}/submit: post: description: >- Public submit by opaque token (magic link). Validates schema and actions, then resumes the graph. operationId: submit_hitl_request_api_v1_hitl_requests__token__submit_post parameters: - in: path name: token required: true schema: title: Token type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HITLSubmitBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/HITLRequestPublic' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Submit Hitl Request tags: - HITL /api/v1/hitl/runs/{workflow_run_id}/pending: get: operationId: list_pending_hitl_for_run_api_v1_hitl_runs__workflow_run_id__pending_get parameters: - in: path name: workflow_run_id required: true schema: format: uuid title: Workflow Run Id type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/HITLRequestPublic' title: >- Response List Pending Hitl For Run Api V1 Hitl Runs Workflow Run Id Pending Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Pending Hitl For Run tags: - HITL /api/v1/internal/lifecycle/capability: get: operationId: get_lifecycle_capability_api_v1_internal_lifecycle_capability_get parameters: - in: header name: authorization required: false schema: anyOf: - type: string - type: 'null' title: Authorization - in: header name: x-orbis-actor-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Actor-Id - in: header name: x-orbis-tenant-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Tenant-Id - in: header name: x-orbis-operation-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Operation-Id responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Get Lifecycle Capability Api V1 Internal Lifecycle Capability Get type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Lifecycle Capability tags: - Internal Lifecycle /api/v1/internal/lifecycle/published-agents/{published_agent_id}: delete: operationId: >- purge_published_agent_api_v1_internal_lifecycle_published_agents__published_agent_id__delete parameters: - in: path name: published_agent_id required: true schema: format: uuid title: Published Agent Id type: string - in: header name: X-Orbis-Expected-Status required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Expected-Status - in: header name: authorization required: false schema: anyOf: - type: string - type: 'null' title: Authorization - in: header name: x-orbis-actor-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Actor-Id - in: header name: x-orbis-tenant-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Tenant-Id - in: header name: x-orbis-operation-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Operation-Id responses: '200': content: application/json: schema: $ref: '#/components/schemas/PurgePublishedAgentResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Purge Published Agent tags: - Internal Lifecycle /api/v1/internal/lifecycle/published-agents/{published_agent_id}/remap-runflow-targets: post: description: >- Remap Run Flow invoke/peer targets on a published agent (no session migration). operationId: >- remap_runflow_targets_api_v1_internal_lifecycle_published_agents__published_agent_id__remap_runflow_targets_post parameters: - in: path name: published_agent_id required: true schema: format: uuid title: Published Agent Id type: string - in: header name: authorization required: false schema: anyOf: - type: string - type: 'null' title: Authorization - in: header name: x-orbis-actor-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Actor-Id - in: header name: x-orbis-tenant-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Tenant-Id - in: header name: x-orbis-operation-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Operation-Id requestBody: content: application/json: schema: $ref: '#/components/schemas/RemapRunflowTargetsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RemapRunflowTargetsResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Remap Runflow Targets tags: - Internal Lifecycle /api/v1/internal/lifecycle/published-agents/{published_agent_id}/status: post: operationId: >- set_published_agent_status_api_v1_internal_lifecycle_published_agents__published_agent_id__status_post parameters: - in: path name: published_agent_id required: true schema: format: uuid title: Published Agent Id type: string - in: header name: authorization required: false schema: anyOf: - type: string - type: 'null' title: Authorization - in: header name: x-orbis-actor-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Actor-Id - in: header name: x-orbis-tenant-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Tenant-Id - in: header name: x-orbis-operation-id required: false schema: anyOf: - type: string - type: 'null' title: X-Orbis-Operation-Id requestBody: content: application/json: schema: $ref: '#/components/schemas/SetPublishedAgentStatusRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SetPublishedAgentStatusResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Set Published Agent Status tags: - Internal Lifecycle /api/v1/logout: post: operationId: logout_api_v1_logout_post responses: '200': content: application/json: schema: {} description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Logout tags: - Login /api/v1/mcp/project/{project_id}: get: description: List project MCP tools. operationId: list_project_tools_api_v1_mcp_project__project_id__get parameters: - in: path name: project_id required: true schema: format: uuid title: Project Id type: string - in: query name: mcp_enabled required: false schema: default: true title: Mcp Enabled type: boolean responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Project Tools tags: - mcp_projects patch: description: >- Update the MCP settings of all flows in a project and project-level auth settings.

On MCP Composer failure, this endpoint should return with a 200 status code and an error message in
the body of the response to display to the user. operationId: update_project_mcp_settings_api_v1_mcp_project__project_id__patch parameters: - in: path name: project_id required: true schema: format: uuid title: Project Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MCPProjectUpdateRequest' required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Project Mcp Settings tags: - mcp_projects /api/v1/mcp/project/{project_id}/composer-url: get: description: >- Get the MCP Composer URL for a specific project.

On failure, this endpoint should return with a 200 status code and an error message in
the body of the response to display to the user. operationId: >- get_project_composer_url_api_v1_mcp_project__project_id__composer_url_get parameters: - in: path name: project_id required: true schema: format: uuid title: Project Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComposerUrlResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Project Composer Url tags: - mcp_projects /api/v1/mcp/project/{project_id}/install: post: description: Install MCP server configuration for Cursor, Windsurf, or Claude. operationId: install_mcp_config_api_v1_mcp_project__project_id__install_post parameters: - in: path name: project_id required: true schema: format: uuid title: Project Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MCPInstallRequest' required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Install Mcp Config tags: - mcp_projects /api/v1/mcp/project/{project_id}/installed: get: description: >- Check if MCP server configuration is installed for this project in Cursor, Windsurf, or Claude. operationId: >- check_installed_mcp_servers_api_v1_mcp_project__project_id__installed_get parameters: - in: path name: project_id required: true schema: format: uuid title: Project Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Check Installed Mcp Servers tags: - mcp_projects /api/v1/monitor/builds: delete: operationId: delete_vertex_builds_api_v1_monitor_builds_delete parameters: - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Vertex Builds tags: - Monitor get: operationId: get_vertex_builds_api_v1_monitor_builds_get parameters: - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/VertexBuildMapModel' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Vertex Builds tags: - Monitor /api/v1/monitor/job_queue: get: description: >- Return a snapshot of job-queue observability metrics.

For the in-memory backend this exposes only ``backend`` and ``active_jobs``.
For the Redis backend the snapshot also includes bridge counts, consumer
wrappers, cancel-dispatcher liveness, and the cancel-stats counters
(``published`` / ``marker_hit`` / ``dispatched_owned`` /
``dispatched_foreign`` / ``publish_errors`` / ``dispatcher_reconnects`` /
``polling_watchdog_kills`` / ``activity_touch_errors`` /
``activity_get_errors`` / ``activity_parse_errors`` /
``dispatcher_internal_errors``). ``dispatcher_reconnects`` tracks explicit
dispatcher-loop retries and redis-py transparent pubsub reconnect callbacks.

Restricted to superusers because the snapshot exposes process-wide tenant
activity (live job counts, cancel rates) — useful for ops, sensitive in
multi-tenant deployments. operationId: job_queue_metrics_api_v1_monitor_job_queue_get responses: '200': content: application/json: schema: additionalProperties: true title: Response Job Queue Metrics Api V1 Monitor Job Queue Get type: object description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Job Queue Metrics tags: - Monitor /api/v1/monitor/messages: delete: operationId: delete_messages_api_v1_monitor_messages_delete requestBody: content: application/json: schema: items: format: uuid type: string title: Message Ids type: array required: true responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Messages tags: - Monitor get: operationId: get_messages_api_v1_monitor_messages_get parameters: - in: query name: flow_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Flow Id - in: query name: session_id required: false schema: anyOf: - type: string - type: 'null' title: Session Id - in: query name: sender required: false schema: anyOf: - type: string - type: 'null' title: Sender - in: query name: sender_name required: false schema: anyOf: - type: string - type: 'null' title: Sender Name - in: query name: order_by required: false schema: anyOf: - type: string - type: 'null' default: timestamp title: Order By - in: query name: limit required: false schema: default: 500 maximum: 1000 minimum: 1 title: Limit type: integer responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/MessageResponse' title: Response Get Messages Api V1 Monitor Messages Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Messages tags: - Monitor /api/v1/monitor/messages/session/{old_session_id}: patch: operationId: update_session_id_api_v1_monitor_messages_session__old_session_id__patch parameters: - in: path name: old_session_id required: true schema: title: Old Session Id type: string - description: The new session ID to update to in: query name: new_session_id required: true schema: description: The new session ID to update to title: New Session Id type: string - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/MessageResponse' title: >- Response Update Session Id Api V1 Monitor Messages Session Old Session Id Patch type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Session Id tags: - Monitor /api/v1/monitor/messages/session/{session_id}: delete: operationId: >- delete_messages_session_api_v1_monitor_messages_session__session_id__delete parameters: - in: path name: session_id required: true schema: title: Session Id type: string - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Messages Session tags: - Monitor /api/v1/monitor/messages/sessions: delete: description: >- Bulk delete messages for multiple sessions at once.

Only deletes messages from sessions belonging to flows owned by the current user.

Args:
session_ids: List of session IDs to delete (max 500)
session: Database session
current_user: Current authenticated user

Returns:
Confirmation message with count of deleted sessions

Raises:
HTTPException: 400 if session_ids list exceeds 500 items
HTTPException: 500 if database operation fails operationId: delete_messages_sessions_api_v1_monitor_messages_sessions_delete requestBody: content: application/json: schema: items: type: string title: Session Ids type: array required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Messages Sessions tags: - Monitor get: operationId: get_message_sessions_api_v1_monitor_messages_sessions_get parameters: - in: query name: flow_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Flow Id responses: '200': content: application/json: schema: items: type: string title: >- Response Get Message Sessions Api V1 Monitor Messages Sessions Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Message Sessions tags: - Monitor /api/v1/monitor/messages/shared: get: description: >- Get messages for a shared/public flow, scoped to the authenticated user.

Uses a deterministic virtual flow_id derived from the user's ID and the
original flow ID. Only messages stored under this virtual flow_id are returned. operationId: get_shared_messages_api_v1_monitor_messages_shared_get parameters: - description: The original public flow ID in: query name: source_flow_id required: true schema: description: The original public flow ID format: uuid title: Source Flow Id type: string - in: query name: session_id required: false schema: anyOf: - type: string - type: 'null' title: Session Id - in: query name: order_by required: false schema: anyOf: - type: string - type: 'null' default: timestamp title: Order By responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/MessageResponse' title: >- Response Get Shared Messages Api V1 Monitor Messages Shared Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Shared Messages tags: - Monitor /api/v1/monitor/messages/shared/session/{old_session_id}: patch: description: >- Rename a session on a shared/public flow, scoped to the authenticated user. operationId: >- rename_shared_session_api_v1_monitor_messages_shared_session__old_session_id__patch parameters: - in: path name: old_session_id required: true schema: title: Old Session Id type: string - description: The new session ID in: query name: new_session_id required: true schema: description: The new session ID title: New Session Id type: string - description: The original public flow ID in: query name: source_flow_id required: true schema: description: The original public flow ID format: uuid title: Source Flow Id type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/MessageResponse' title: >- Response Rename Shared Session Api V1 Monitor Messages Shared Session Old Session Id Patch type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Rename Shared Session tags: - Monitor /api/v1/monitor/messages/shared/session/{session_id}: delete: description: >- Delete messages for a session on a shared/public flow, scoped to the authenticated user. operationId: >- delete_shared_messages_session_api_v1_monitor_messages_shared_session__session_id__delete parameters: - in: path name: session_id required: true schema: title: Session Id type: string - description: The original public flow ID in: query name: source_flow_id required: true schema: description: The original public flow ID format: uuid title: Source Flow Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Shared Messages Session tags: - Monitor /api/v1/monitor/messages/shared/sessions: get: description: >- Get session IDs for a shared/public flow, scoped to the authenticated user.

Uses a deterministic virtual flow_id derived from the user's ID and the
original flow ID. Only messages stored under this virtual flow_id are returned. operationId: get_shared_message_sessions_api_v1_monitor_messages_shared_sessions_get parameters: - description: The original public flow ID in: query name: source_flow_id required: true schema: description: The original public flow ID format: uuid title: Source Flow Id type: string responses: '200': content: application/json: schema: items: type: string title: >- Response Get Shared Message Sessions Api V1 Monitor Messages Shared Sessions Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Shared Message Sessions tags: - Monitor /api/v1/monitor/messages/shared/{message_id}: put: description: >- Update a message on a shared/public flow, scoped to the authenticated user. operationId: update_shared_message_api_v1_monitor_messages_shared__message_id__put parameters: - in: path name: message_id required: true schema: format: uuid title: Message Id type: string - description: The original public flow ID in: query name: source_flow_id required: true schema: description: The original public flow ID format: uuid title: Source Flow Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageUpdate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessageRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Shared Message tags: - Monitor /api/v1/monitor/messages/{message_id}: put: operationId: update_message_api_v1_monitor_messages__message_id__put parameters: - in: path name: message_id required: true schema: format: uuid title: Message Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageUpdate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessageRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Message tags: - Monitor /api/v1/monitor/public/messages: delete: description: >- Delete specific messages for a public (shareable) OrbisBox flow for the current client. operationId: delete_public_messages_api_v1_monitor_public_messages_delete parameters: - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string requestBody: content: application/json: schema: items: format: uuid type: string title: Message Ids type: array required: true responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Public Messages tags: - Monitor get: description: >- Return messages for a public (shareable) OrbisBox flow for the current client. operationId: get_public_messages_api_v1_monitor_public_messages_get parameters: - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string - in: query name: session_id required: false schema: anyOf: - type: string - type: 'null' title: Session Id - in: query name: sender required: false schema: anyOf: - type: string - type: 'null' title: Sender - in: query name: sender_name required: false schema: anyOf: - type: string - type: 'null' title: Sender Name - in: query name: order_by required: false schema: anyOf: - type: string - type: 'null' default: timestamp title: Order By responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/MessageResponse' title: >- Response Get Public Messages Api V1 Monitor Public Messages Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Public Messages tags: - Monitor /api/v1/monitor/public/messages/session/{old_session_id}: patch: description: >- Rename a chat session for a public (shareable) OrbisBox flow for the current client. operationId: >- update_public_session_id_api_v1_monitor_public_messages_session__old_session_id__patch parameters: - in: path name: old_session_id required: true schema: title: Old Session Id type: string - description: The new session ID to update to in: query name: new_session_id required: true schema: description: The new session ID to update to title: New Session Id type: string - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/MessageResponse' title: >- Response Update Public Session Id Api V1 Monitor Public Messages Session Old Session Id Patch type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Public Session Id tags: - Monitor /api/v1/monitor/public/messages/session/{session_id}: delete: description: >- Delete all messages for a given session of a public (shareable) OrbisBox flow for the current client. operationId: >- delete_public_messages_session_api_v1_monitor_public_messages_session__session_id__delete parameters: - in: path name: session_id required: true schema: title: Session Id type: string - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Public Messages Session tags: - Monitor /api/v1/monitor/public/messages/sessions: get: description: >- Return chat session IDs for a public (shareable) OrbisBox flow for the current client.

This endpoint:
- Verifies that the flow is PUBLIC and resolves a deterministic per-client flow_id
- Returns only sessions that belong to this (flow_id, client_id) pair operationId: get_public_message_sessions_api_v1_monitor_public_messages_sessions_get parameters: - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: items: type: string title: >- Response Get Public Message Sessions Api V1 Monitor Public Messages Sessions Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Public Message Sessions tags: - Monitor /api/v1/monitor/traces: delete: operationId: delete_traces_by_flow_api_v1_monitor_traces_delete parameters: - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Traces By Flow tags: - Traces get: operationId: get_traces_api_v1_monitor_traces_get parameters: - in: query name: flow_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Flow Id - in: query name: session_id required: false schema: anyOf: - type: string - type: 'null' title: Session Id - in: query name: status required: false schema: anyOf: - $ref: '#/components/schemas/SpanStatus' - type: 'null' title: Status - in: query name: query required: false schema: anyOf: - type: string - type: 'null' title: Query - in: query name: start_time required: false schema: anyOf: - format: date-time type: string - type: 'null' title: Start Time - in: query name: end_time required: false schema: anyOf: - format: date-time type: string - type: 'null' title: End Time - in: query name: page required: false schema: default: 1 minimum: 0 title: Page type: integer - in: query name: size required: false schema: default: 50 maximum: 200 minimum: 1 title: Size type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/TraceListResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Traces tags: - Traces /api/v1/monitor/traces/{trace_id}: delete: operationId: delete_trace_api_v1_monitor_traces__trace_id__delete parameters: - in: path name: trace_id required: true schema: format: uuid title: Trace Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Trace tags: - Traces get: operationId: get_trace_api_v1_monitor_traces__trace_id__get parameters: - in: path name: trace_id required: true schema: format: uuid title: Trace Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TraceRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Trace tags: - Traces /api/v1/monitor/transactions: get: operationId: get_transactions_api_v1_monitor_transactions_get parameters: - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string - description: Page number in: query name: page required: false schema: default: 1 description: Page number minimum: 1 title: Page type: integer - description: Page size in: query name: size required: false schema: default: 50 description: Page size maximum: 100 minimum: 1 title: Size type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/Page_TransactionLogsResponse_' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Transactions tags: - Monitor /api/v1/projects/: get: operationId: read_projects_api_v1_projects__get responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/FolderRead' title: Response Read Projects Api V1 Projects Get type: array description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Read Projects tags: - Projects post: operationId: create_project_api_v1_projects__post requestBody: content: application/json: schema: $ref: '#/components/schemas/FolderCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FolderRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Project tags: - Projects /api/v1/projects/download/{project_id}: get: description: Download all flows from project as a zip file. operationId: download_file_api_v1_projects_download__project_id__get parameters: - in: path name: project_id required: true schema: format: uuid title: Project Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Download File tags: - Projects /api/v1/projects/upload/: post: description: >- Upload flows from a file.

Accepts either a JSON file with project metadata (folder_name, folder_description, flows)
or a ZIP file containing individual flow JSON files (as produced by the download endpoint). operationId: upload_file_api_v1_projects_upload__post requestBody: content: multipart/form-data: schema: $ref: >- #/components/schemas/Body_upload_file_api_v1_projects_upload__post responses: '201': content: application/json: schema: items: $ref: '#/components/schemas/FlowRead' title: Response Upload File Api V1 Projects Upload Post type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Upload File tags: - Projects /api/v1/projects/{project_id}: delete: operationId: delete_project_api_v1_projects__project_id__delete parameters: - in: path name: project_id required: true schema: format: uuid title: Project Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Project tags: - Projects get: operationId: read_project_api_v1_projects__project_id__get parameters: - in: path name: project_id required: true schema: format: uuid title: Project Id type: string - in: query name: page required: false schema: anyOf: - type: integer - type: 'null' title: Page - in: query name: size required: false schema: anyOf: - type: integer - type: 'null' title: Size - in: query name: is_component required: false schema: default: false title: Is Component type: boolean - in: query name: is_flow required: false schema: default: false title: Is Flow type: boolean - in: query name: search required: false schema: default: '' title: Search type: string responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/FolderWithPaginatedFlows' - $ref: '#/components/schemas/FolderReadWithFlows' title: Response Read Project Api V1 Projects Project Id Get description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Read Project tags: - Projects patch: operationId: update_project_api_v1_projects__project_id__patch parameters: - in: path name: project_id required: true schema: format: uuid title: Project Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FolderUpdate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FolderRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Project tags: - Projects /api/v1/publish/agents: get: operationId: list_published_agents_api_v1_publish_agents_get parameters: - in: query name: status required: false schema: anyOf: - type: string - type: 'null' title: Status responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/PublishedAgentRead' title: Response List Published Agents Api V1 Publish Agents Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Published Agents tags: - Publish post: operationId: publish_agent_api_v1_publish_agents_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PublishAgentRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/PublishedAgentRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Publish Agent tags: - Publish /api/v1/publish/agents/runflow-targets/preview: get: description: >- Surface the Run Flow dependencies of a flow so the UI can offer a per-target choice.

For each ``target_flow_id`` referenced by a RunFlow vertex, returns:
- ``approved_candidates``: existing approved deploys the operator can reuse;
- ``default_candidate_id``: the candidate ``publish_agent`` would pick on ``auto``;
- ``would_auto_publish``: ``True`` when no approved deploy exists yet (a publish without
override would auto-create a fresh one);
- ``auto_publish_agent_id_hint``: the synthetic ``agent_id`` that auto-publish would use.

The frontend feeds the user's per-target picks back through ``runflow_target_overrides`` on
``POST /publish/agents``. operationId: >- preview_runflow_targets_api_v1_publish_agents_runflow_targets_preview_get parameters: - in: query name: flow_id required: true schema: format: uuid title: Flow Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RunFlowTargetsPreviewResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Preview Runflow Targets tags: - Publish /api/v1/publish/agents/{published_agent_id}/status: post: operationId: >- update_published_agent_status_api_v1_publish_agents__published_agent_id__status_post parameters: - in: path name: published_agent_id required: true schema: format: uuid title: Published Agent Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePublishedAgentStatusRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdatePublishedAgentStatusResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Published Agent Status tags: - Publish /api/v1/published-agents: get: operationId: list_catalog_published_agents_api_v1_published_agents_get parameters: - in: query name: tenant_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Tenant Id - in: query name: include_all required: false schema: default: false title: Include All type: boolean responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/PublishedAgentCatalogItem' title: >- Response List Catalog Published Agents Api V1 Published Agents Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Catalog Published Agents tags: - Published Agents /api/v1/published-agents/sessions/{session_id}: get: operationId: >- get_published_agent_session_api_v1_published_agents_sessions__session_id__get parameters: - in: path name: session_id required: true schema: format: uuid title: Session Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublishedAgentSessionRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Published Agent Session tags: - Published Agents /api/v1/published-agents/sessions/{session_id}/messages: get: operationId: >- list_published_agent_messages_api_v1_published_agents_sessions__session_id__messages_get parameters: - in: path name: session_id required: true schema: format: uuid title: Session Id type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/PublishedAgentMessageRead' title: >- Response List Published Agent Messages Api V1 Published Agents Sessions Session Id Messages Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Published Agent Messages tags: - Published Agents post: operationId: >- send_published_agent_message_api_v1_published_agents_sessions__session_id__messages_post parameters: - in: path name: session_id required: true schema: format: uuid title: Session Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SendPublishedAgentMessageRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SendPublishedAgentMessageResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Send Published Agent Message tags: - Published Agents /api/v1/published-agents/{published_agent_id}: get: operationId: >- get_catalog_published_agent_api_v1_published_agents__published_agent_id__get parameters: - in: path name: published_agent_id required: true schema: format: uuid title: Published Agent Id type: string - in: query name: include_runflow_manifest required: false schema: default: false title: Include Runflow Manifest type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublishedAgentCatalogItem' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Catalog Published Agent tags: - Published Agents /api/v1/published-agents/{published_agent_id}/sessions: get: operationId: >- list_published_agent_sessions_api_v1_published_agents__published_agent_id__sessions_get parameters: - in: path name: published_agent_id required: true schema: format: uuid title: Published Agent Id type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/PublishedAgentSessionRead' title: >- Response List Published Agent Sessions Api V1 Published Agents Published Agent Id Sessions Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Published Agent Sessions tags: - Published Agents post: operationId: >- create_published_agent_session_api_v1_published_agents__published_agent_id__sessions_post parameters: - in: path name: published_agent_id required: true schema: format: uuid title: Published Agent Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePublishedAgentSessionRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/PublishedAgentSessionRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Published Agent Session tags: - Published Agents /api/v1/responses: post: description: >- Create a response using OpenAI Responses API format.

This endpoint accepts a flow_id in the model parameter and processes
the input through the specified Langflow flow.

Args:
request: OpenAI Responses API request with model (flow_id) and input
background_tasks: FastAPI background task manager
api_key_user: Authenticated user from API key
http_request: The incoming HTTP request
telemetry_service: Telemetry service for logging

Returns:
OpenAI-compatible response or streaming response

Raises:
HTTPException: For validation errors or flow execution issues operationId: create_response_api_v1_responses_post requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenAIResponsesRequest' required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - API key query: [] - API key header: [] summary: Create Response tags: - OpenAI Responses API /api/v1/run/advanced/{flow_id_or_name}: post: description: >- Executes a specified flow by ID with optional input values, output selection, tweaks, and streaming capability.

This endpoint supports running flows with caching to enhance performance and efficiency.

### Parameters:
- `flow` (Flow): The flow object to be executed, resolved via dependency injection.
- `inputs` (List[InputValueRequest], optional): A list of inputs specifying the input values and components
for the flow. Each input can target specific components and provide custom values.
- `outputs` (List[str], optional): A list of output names to retrieve from the executed flow.
If not provided, all outputs are returned.
- `tweaks` (Optional[Tweaks], optional): A dictionary of tweaks to customize the flow execution.
The tweaks can be used to modify the flow's parameters and components.
Tweaks can be overridden by the input values.
- `stream` (bool, optional): Specifies whether the results should be streamed. Defaults to False.
- `session_id` (Union[None, str], optional): An optional session ID to utilize existing session data for the flow
execution.
- `api_key_user` (User): The user associated with the current API key. Automatically resolved from the API key.

### Returns:
A `RunResponse` object containing the selected outputs (or all if not specified) of the executed flow
and the session ID.
The structure of the response accommodates multiple inputs, providing a nested list of outputs for each input.

### Raises:
HTTPException: Indicates issues with finding the specified flow, invalid input formats, or internal errors during
flow execution.

### Example usage:
```json
POST /run/flow_id
x-api-key: YOUR_API_KEY
Payload:
{
"inputs": [
{"components": ["component1"], "input_value": "value1"},
{"components": ["component3"], "input_value": "value2"}
],
"outputs": ["Component Name", "component_id"],
"tweaks": {"parameter_name": "value", "Component Name": {"parameter_name": "value"}, "component_id": {"parameter_name": "value"}}
"stream": false
}
```

This endpoint facilitates complex flow executions with customized inputs, outputs, and configurations,
catering to diverse application requirements. operationId: experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post parameters: - in: path name: flow_id_or_name required: true schema: title: Flow Id Or Name type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/Body_experimental_run_flow_api_v1_run_advanced__flow_id_or_name__post responses: '200': content: application/json: schema: $ref: '#/components/schemas/RunResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - API key query: [] - API key header: [] summary: Experimental Run Flow tags: - Base /api/v1/run/{flow_id_or_name}: post: description: >- Executes a specified flow by ID with support for streaming and telemetry (API key auth).

This endpoint executes a flow identified by ID or name, with options for streaming the response
and tracking execution metrics. It handles both streaming and non-streaming execution modes.
This endpoint uses API key authentication (Bearer token).

Args:
session (DbSession): Database session for RBAC permission checks
background_tasks (BackgroundTasks): FastAPI background task manager
flow (FlowRead | None): The flow to execute, loaded via dependency
input_request (SimplifiedAPIRequest | None): Input parameters for the flow
stream (bool): Whether to stream the response
api_key_user (UserRead): Authenticated user from API key
context (dict | None): Optional context to pass to the flow
http_request (Request): The incoming HTTP request for extracting global variables

Returns:
Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results
or a RunResponse with the complete execution results

Raises:
HTTPException: For flow not found (404) or invalid input (400)
APIException: For internal execution errors (500)

Notes:
- Supports both streaming and non-streaming execution modes
- Tracks execution time and success/failure via telemetry
- Handles graceful client disconnection in streaming mode
- Provides detailed error handling with appropriate HTTP status codes
- Extracts global variables from HTTP headers with prefix X-LANGFLOW-GLOBAL-VAR-*
- Merges extracted variables with the context parameter as "request_variables"
- In streaming mode, uses EventManager to handle events:
- "add_message": New messages during execution
- "token": Individual tokens during streaming
- "end": Final execution result
- Authentication: Requires API key (Bearer token) operationId: simplified_run_flow_api_v1_run__flow_id_or_name__post parameters: - in: path name: flow_id_or_name required: true schema: title: Flow Id Or Name type: string - in: query name: stream required: false schema: default: false title: Stream type: boolean requestBody: content: application/json: schema: $ref: >- #/components/schemas/Body_simplified_run_flow_api_v1_run__flow_id_or_name__post responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - API key query: [] - API key header: [] summary: Simplified Run Flow tags: - Base /api/v1/runtime/invoke: post: operationId: runtime_invoke_api_v1_runtime_invoke_post requestBody: content: application/json: schema: $ref: '#/components/schemas/RuntimeInvokeRequest' required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/RuntimeInvokeResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Runtime Invoke tags: - Runtime /api/v1/runtime/run/{run_id}: get: operationId: get_run_api_v1_runtime_run__run_id__get parameters: - in: path name: run_id required: true schema: format: uuid title: Run Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProductionRunRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Run tags: - Runtime /api/v1/runtime/run/{run_id}/callback: post: operationId: runtime_run_callback_api_v1_runtime_run__run_id__callback_post parameters: - in: path name: run_id required: true schema: format: uuid title: Run Id type: string - in: header name: x-run-callback-token required: false schema: anyOf: - type: string - type: 'null' title: X-Run-Callback-Token requestBody: content: application/json: schema: $ref: '#/components/schemas/RuntimeRunCallbackRequest' required: true responses: '202': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Runtime Run Callback tags: - Runtime /api/v1/runtime/run/{run_id}/status: get: operationId: get_run_status_endpoint_api_v1_runtime_run__run_id__status_get parameters: - in: path name: run_id required: true schema: format: uuid title: Run Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RuntimeStatusResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Run Status Endpoint tags: - Runtime /api/v1/schedules/: get: description: >- List schedules filtered by tenant/workspace/flow.

If tenant_id/workspace_id are not provided, they default to the current RBAC context. operationId: list_schedules_route_api_v1_schedules__get parameters: - in: query name: tenant_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Tenant Id - in: query name: workspace_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Workspace Id - in: query name: flow_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Flow Id responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ScheduleRead' title: Response List Schedules Route Api V1 Schedules Get type: array description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Schedules Route tags: - Schedules post: description: >- Create a new schedule for a flow.

The tenant_id and workspace_id can be omitted in the payload and will be inferred
from the current RBAC context when available. operationId: create_schedule_route_api_v1_schedules__post requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ScheduleRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create Schedule Route tags: - Schedules /api/v1/schedules/{schedule_id}: delete: description: Delete a schedule. operationId: delete_schedule_route_api_v1_schedules__schedule_id__delete parameters: - in: path name: schedule_id required: true schema: format: uuid title: Schedule Id type: string responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Delete Schedule Route Api V1 Schedules Schedule Id Delete type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Schedule Route tags: - Schedules get: description: Get a single schedule by ID. operationId: get_schedule_route_api_v1_schedules__schedule_id__get parameters: - in: path name: schedule_id required: true schema: format: uuid title: Schedule Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScheduleRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Schedule Route tags: - Schedules patch: description: Update an existing schedule. operationId: update_schedule_route_api_v1_schedules__schedule_id__patch parameters: - in: path name: schedule_id required: true schema: format: uuid title: Schedule Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleUpdate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScheduleRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Schedule Route tags: - Schedules /api/v1/starter-projects/: get: description: Get a list of starter projects. operationId: get_starter_projects_api_v1_starter_projects__get responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/GraphDumpResponse' title: Response Get Starter Projects Api V1 Starter Projects Get type: array description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Starter Projects tags: - Flows /api/v1/users/: get: description: List users (superuser and tenant admin only). operationId: read_all_users_api_v1_users__get parameters: - in: query name: skip required: false schema: default: 0 title: Skip type: integer - in: query name: limit required: false schema: default: 10 title: Limit type: integer - in: query name: search required: false schema: anyOf: - type: string - type: 'null' title: Search responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsersResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Read All Users tags: - Users post: description: Create a new user (self-signup + OTP email verification). operationId: add_user_api_v1_users__post requestBody: content: application/json: schema: $ref: '#/components/schemas/UserCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Add User tags: - Users /api/v1/users/forgot-password: post: description: Start password reset by sending an OTP code to the user's email. operationId: forgot_password_api_v1_users_forgot_password_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ForgotPasswordRequest' required: true responses: '200': content: application/json: schema: additionalProperties: type: string title: Response Forgot Password Api V1 Users Forgot Password Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Forgot Password tags: - Users /api/v1/users/resend-otp: post: description: Resend OTP to user's email. operationId: resend_otp_api_v1_users_resend_otp_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ResendOTPRequest' required: true responses: '200': content: application/json: schema: additionalProperties: type: string title: Response Resend Otp Api V1 Users Resend Otp Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Resend Otp tags: - Users /api/v1/users/reset-password: post: description: Complete password reset using the OTP code that was emailed to the user. operationId: reset_password_with_otp_api_v1_users_reset_password_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ResetPasswordRequest' required: true responses: '200': content: application/json: schema: additionalProperties: type: string title: >- Response Reset Password With Otp Api V1 Users Reset Password Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Reset Password With Otp tags: - Users /api/v1/users/verify-email: post: description: Verify user email with OTP. operationId: verify_email_api_v1_users_verify_email_post requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyEmailRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerifyEmailResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Verify Email tags: - Users /api/v1/users/whoami: get: description: Get current user information. operationId: read_current_user_api_v1_users_whoami_get responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserRead' description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Read Current User tags: - Users /api/v1/users/{user_id}: delete: description: >- Delete a user (superuser only).

Also removes user from all tenant and workspace memberships,
and cleans up related data. operationId: delete_user_api_v1_users__user_id__delete parameters: - in: path name: user_id required: true schema: format: uuid title: User Id type: string responses: '200': content: application/json: schema: additionalProperties: type: string title: Response Delete User Api V1 Users User Id Delete type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete User tags: - Users patch: description: >- Update an existing user.

Allowed for:
- Superusers: can update any user
- Tenant admins: can update users in their tenant
- Regular users: can only update themselves operationId: patch_user_api_v1_users__user_id__patch parameters: - in: path name: user_id required: true schema: format: uuid title: User Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserUpdate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserAdminRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Patch User tags: - Users /api/v1/users/{user_id}/reset-password: patch: description: >- Reset user password. Superusers can reset any user's password; regular users can only reset their own. operationId: reset_password_api_v1_users__user_id__reset_password_patch parameters: - in: path name: user_id required: true schema: format: uuid title: User Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserUpdate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserRead' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Reset Password tags: - Users /api/v1/version: get: operationId: get_version_api_v1_version_get responses: '200': content: application/json: schema: {} description: Successful Response summary: Get Version tags: - Base /api/v1/webhook/{flow_id_or_name}: post: description: >- Run a flow using a webhook request.

Args:
auth: Resolved webhook user and flow, scoped to the authenticated caller.
request: The incoming HTTP request.

Returns:
A dictionary containing the status of the task.

Raises:
HTTPException: If the flow is not found or if there is an error processing the request. operationId: webhook_run_flow_api_v1_webhook__flow_id_or_name__post parameters: - in: path name: flow_id_or_name required: true schema: title: Flow Id Or Name type: string responses: '202': content: application/json: schema: additionalProperties: true title: >- Response Webhook Run Flow Api V1 Webhook Flow Id Or Name Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Webhook Run Flow tags: - Base /api/v1/webhooks/whatsapp/{flow_id_or_name}: get: description: Handle WhatsApp webhook verification (GET request from Facebook) operationId: whatsapp_webhook_verify_api_v1_webhooks_whatsapp__flow_id_or_name__get parameters: - in: path name: flow_id_or_name required: true schema: title: Flow Id Or Name type: string - in: query name: hub.mode required: true schema: title: Hub.Mode type: string - in: query name: hub.challenge required: true schema: title: Hub.Challenge type: string - in: query name: hub.verify_token required: true schema: title: Hub.Verify Token type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Whatsapp Webhook Verify tags: - webhooks post: description: Handle WhatsApp webhook events (POST request from Facebook) operationId: whatsapp_webhook_receive_api_v1_webhooks_whatsapp__flow_id_or_name__post parameters: - in: path name: flow_id_or_name required: true schema: title: Flow Id Or Name type: string - in: query name: echo required: false schema: default: 0 title: Echo type: integer responses: '200': content: application/json: schema: additionalProperties: true title: >- Response Whatsapp Webhook Receive Api V1 Webhooks Whatsapp Flow Id Or Name Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Whatsapp Webhook Receive tags: - webhooks /api/v1/webhooks/whatsapp/{flow_id_or_name}/test: post: description: Test WhatsApp webhook with a sample message operationId: >- test_whatsapp_webhook_api_v1_webhooks_whatsapp__flow_id_or_name__test_post parameters: - in: path name: flow_id_or_name required: true schema: title: Flow Id Or Name type: string - in: query name: test_message required: false schema: default: Hello from test! title: Test Message type: string responses: '200': content: application/json: schema: additionalProperties: type: string title: >- Response Test Whatsapp Webhook Api V1 Webhooks Whatsapp Flow Id Or Name Test Post type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Test Whatsapp Webhook tags: - webhooks /api/v2/files: delete: operationId: delete_all_files_api_v2_files_delete responses: '200': content: application/json: schema: {} description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete All Files tags: - Files get: operationId: list_files_api_v2_files_get responses: '200': content: application/json: schema: items: $ref: >- #/components/schemas/langflow__services__database__models__file__model__File title: Response List Files Api V2 Files Get type: array description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Files tags: - Files post: description: >- Upload a file with RBAC + hierarchical storage, keeping new-code robustness. operationId: upload_user_file_api_v2_files_post parameters: - in: query name: append required: false schema: default: false title: Append type: boolean - in: query name: ephemeral required: false schema: default: false title: Ephemeral type: boolean - in: query name: folder_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Folder Id requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_upload_user_file_api_v2_files_post' required: true responses: '201': content: application/json: schema: $ref: >- #/components/schemas/langflow__api__schemas__UploadFileResponse description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Upload User File tags: - Files /api/v2/files/: delete: operationId: delete_all_files_api_v2_files__delete responses: '200': content: application/json: schema: {} description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete All Files tags: - Files get: operationId: list_files_api_v2_files__get responses: '200': content: application/json: schema: items: $ref: >- #/components/schemas/langflow__services__database__models__file__model__File title: Response List Files Api V2 Files Get type: array description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: List Files tags: - Files post: description: >- Upload a file with RBAC + hierarchical storage, keeping new-code robustness. operationId: upload_user_file_api_v2_files__post parameters: - in: query name: append required: false schema: default: false title: Append type: boolean - in: query name: ephemeral required: false schema: default: false title: Ephemeral type: boolean - in: query name: folder_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Folder Id requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_upload_user_file_api_v2_files__post' required: true responses: '201': content: application/json: schema: $ref: >- #/components/schemas/langflow__api__schemas__UploadFileResponse description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Upload User File tags: - Files /api/v2/files/batch/: delete: description: >- Delete multiple files by IDs (RBAC + hierarchical storage + permanent/transient handling). operationId: delete_files_batch_api_v2_files_batch__delete requestBody: content: application/json: schema: items: format: uuid type: string title: File Ids type: array required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Files Batch tags: - Files post: description: Download multiple files as zip (RBAC + hierarchical storage). operationId: download_files_batch_api_v2_files_batch__post requestBody: content: application/json: schema: items: format: uuid type: string title: File Ids type: array required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Download Files Batch tags: - Files /api/v2/files/folders: post: operationId: create_api_v2_files_folders_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFileFolder' required: true responses: '201': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Create tags: - File folders /api/v2/files/folders/contents: get: operationId: contents_api_v2_files_folders_contents_get parameters: - in: query name: folder_id required: false schema: anyOf: - format: uuid type: string - type: 'null' title: Folder Id responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Contents tags: - File folders /api/v2/files/folders/{folder_id}: delete: operationId: delete_api_v2_files_folders__folder_id__delete parameters: - in: path name: folder_id required: true schema: format: uuid title: Folder Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete tags: - File folders patch: operationId: rename_api_v2_files_folders__folder_id__patch parameters: - in: path name: folder_id required: true schema: format: uuid title: Folder Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RenameFileFolder' required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Rename tags: - File folders /api/v2/files/folders/{folder_id}/sync: post: operationId: sync_api_v2_files_folders__folder_id__sync_post parameters: - in: path name: folder_id required: true schema: format: uuid title: Folder Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Sync tags: - File folders /api/v2/files/{file_id}: delete: description: Delete a file with RBAC permission check + permanent/transient handling. operationId: delete_file_api_v2_files__file_id__delete parameters: - in: path name: file_id required: true schema: format: uuid title: File Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete File tags: - Files get: description: >- Download a file with RBAC permission check + early storage existence check. operationId: download_file_api_v2_files__file_id__get parameters: - in: path name: file_id required: true schema: format: uuid title: File Id type: string - in: query name: return_content required: false schema: default: false title: Return Content type: boolean responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Download File tags: - Files put: description: Rename only files the authenticated caller may mutate in their context. operationId: edit_file_name_api_v2_files__file_id__put parameters: - in: path name: file_id required: true schema: format: uuid title: File Id type: string - in: query name: name required: true schema: title: Name type: string responses: '200': content: application/json: schema: $ref: >- #/components/schemas/langflow__api__schemas__UploadFileResponse description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Edit File Name tags: - Files /api/v2/files/{file_id}/image: get: description: View a file as image (inline) with RBAC permission check. operationId: view_file_image_api_v2_files__file_id__image_get parameters: - in: path name: file_id required: true schema: format: uuid title: File Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: View File Image tags: - Files /api/v2/mcp/servers: get: description: Get the list of available servers. operationId: get_servers_api_v2_mcp_servers_get parameters: - in: query name: action_count required: false schema: anyOf: - type: boolean - type: 'null' title: Action Count responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Servers tags: - MCP /api/v2/mcp/servers/{server_name}: delete: operationId: delete_server_api_v2_mcp_servers__server_name__delete parameters: - in: path name: server_name required: true schema: title: Server Name type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Delete Server tags: - MCP get: description: Get a specific server. operationId: get_server_endpoint_api_v2_mcp_servers__server_name__get parameters: - in: path name: server_name required: true schema: title: Server Name type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Get Server Endpoint tags: - MCP patch: operationId: update_server_endpoint_api_v2_mcp_servers__server_name__patch parameters: - in: path name: server_name required: true schema: title: Server Name type: string requestBody: content: application/json: schema: additionalProperties: true title: Server Config type: object required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Update Server Endpoint tags: - MCP post: operationId: add_server_api_v2_mcp_servers__server_name__post parameters: - in: path name: server_name required: true schema: title: Server Name type: string requestBody: content: application/json: schema: additionalProperties: true title: Server Config type: object required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Add Server tags: - MCP /api/v2/workflows: get: description: Get status of workflow job by job ID operationId: get_workflow_status_api_v2_workflows_get parameters: - description: Job ID to query in: query name: job_id required: false schema: anyOf: - type: string - format: uuid type: string - type: 'null' description: Job ID to query title: Job Id responses: '200': content: application/json: schema: description: Synchronous workflow execution response. properties: created_timestamp: title: Created Timestamp type: string errors: default: [] items: $ref: '#/components/schemas/ErrorDetail' title: Errors type: array flow_id: title: Flow Id type: string globals: additionalProperties: maxLength: 65536 type: string propertyNames: maxLength: 256 minLength: 1 title: Globals type: object inputs: additionalProperties: true default: {} title: Inputs type: object job_id: anyOf: - type: string - format: uuid type: string - type: 'null' title: Job Id object: const: response default: response title: Object type: string outputs: additionalProperties: $ref: '#/components/schemas/ComponentOutput' default: {} title: Outputs type: object status: $ref: '#/components/schemas/JobStatus' required: - flow_id - status title: WorkflowExecutionResponse type: object text/event-stream: description: Server-sent events for streaming status schema: description: Streaming event response. properties: raw_event: additionalProperties: true title: Raw Event type: object run_id: title: Run Id type: string timestamp: title: Timestamp type: integer type: title: Type type: string required: - type - run_id - timestamp - raw_event title: WorkflowStreamEvent type: object description: Workflow status response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - API key query: [] - API key header: [] summary: Get Workflow Status tags: - Workflow post: description: Execute a workflow with support for sync, stream, and background modes operationId: execute_workflow_api_v2_workflows_post requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowExecutionRequest' required: true responses: '200': content: application/json: schema: discriminator: mapping: job: '#/components/schemas/WorkflowJobResponse' response: '#/components/schemas/WorkflowExecutionResponse' propertyName: object oneOf: - description: Synchronous workflow execution response. properties: created_timestamp: title: Created Timestamp type: string errors: default: [] items: $ref: '#/components/schemas/ErrorDetail' title: Errors type: array flow_id: title: Flow Id type: string globals: additionalProperties: maxLength: 65536 type: string propertyNames: maxLength: 256 minLength: 1 title: Globals type: object inputs: additionalProperties: true default: {} title: Inputs type: object job_id: anyOf: - type: string - format: uuid type: string - type: 'null' title: Job Id object: const: response default: response title: Object type: string outputs: additionalProperties: $ref: '#/components/schemas/ComponentOutput' default: {} title: Outputs type: object status: $ref: '#/components/schemas/JobStatus' required: - flow_id - status title: WorkflowExecutionResponse type: object - description: Background job response. properties: created_timestamp: title: Created Timestamp type: string errors: default: [] items: $ref: '#/components/schemas/ErrorDetail' title: Errors type: array flow_id: title: Flow Id type: string globals: additionalProperties: maxLength: 65536 type: string propertyNames: maxLength: 256 minLength: 1 title: Globals type: object job_id: anyOf: - type: string - format: uuid type: string title: Job Id links: additionalProperties: type: string title: Links type: object object: const: job default: job title: Object type: string status: $ref: '#/components/schemas/JobStatus' required: - job_id - flow_id - status title: WorkflowJobResponse type: object text/event-stream: description: Server-sent events for streaming execution schema: description: Streaming event response. properties: raw_event: additionalProperties: true title: Raw Event type: object run_id: title: Run Id type: string timestamp: title: Timestamp type: integer type: title: Type type: string required: - type - run_id - timestamp - raw_event title: WorkflowStreamEvent type: object description: Workflow execution response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - API key query: [] - API key header: [] summary: Execute Workflow tags: - Workflow /api/v2/workflows/stop: post: description: Stop a running workflow execution operationId: stop_workflow_api_v2_workflows_stop_post requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowStopRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkflowStopResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - API key query: [] - API key header: [] summary: Stop Workflow tags: - Workflow /health: get: operationId: health_health_get responses: '200': content: application/json: schema: {} description: Successful Response summary: Health tags: - Health Check /health_check: get: operationId: health_check_health_check_get responses: '200': content: application/json: schema: $ref: '#/components/schemas/HealthResponse' description: Successful Response summary: Health Check tags: - Health Check /logs: get: description: >- Retrieve application logs with authentication required.

SECURITY: Logs may contain sensitive information and require authentication. operationId: logs_logs_get parameters: - description: The number of logs before the timestamp or the last log in: query name: lines_before required: false schema: default: 0 description: The number of logs before the timestamp or the last log title: Lines Before type: integer - description: The number of logs after the timestamp in: query name: lines_after required: false schema: default: 0 description: The number of logs after the timestamp title: Lines After type: integer - description: The timestamp to start getting logs from in: query name: timestamp required: false schema: default: 0 description: The timestamp to start getting logs from title: Timestamp type: integer responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Logs tags: - Log /logs-stream: get: description: >- HTTP/2 Server-Sent-Event (SSE) endpoint for streaming logs.

Requires authentication to prevent exposure of sensitive log data.
It establishes a long-lived connection to the server and receives log messages in real-time.
The client should use the header "Accept: text/event-stream". operationId: stream_logs_logs_stream_get responses: '200': content: application/json: schema: {} description: Successful Response security: - OAuth2PasswordBearer: [] - API key query: [] - API key header: [] summary: Stream Logs tags: - Log