> ## Documentation Index > Fetch the complete documentation index at: https://docs.findable.net/llms.txt > Use this file to discover all available pages before exploring further. # Partial update a flow > Merges provided fields. Supports promoting personal to shared but NOT demoting shared to personal. ## OpenAPI ````yaml /api-reference/openapi.json patch /flows/{id} openapi: 3.0.3 info: title: Findable API version: 3.2.38 description: > REST API for the Findable AI Assistant platform. ## Authentication All endpoints (except `/server/setup` and `/server/bootstrap`) require a valid **Azure AD / Entra ID Bearer token**. ### Obtaining a token 1. Register (or reuse) an **App Registration** in Azure Entra ID for your client. 2. Under **API Permissions**, add a delegated permission for the Findable server app: `api:///User.Read` 3. Acquire a token using MSAL (or any OAuth 2.0 library) with the following parameters: | Parameter | Value | |-----------|-------| | Authority | `https://login.microsoftonline.com/` | | Client ID | Your client app registration ID | | Scope | `api:///User.Read` | | Grant type | Authorization Code (interactive) or Client Credentials (daemon) | ### Example (MSAL Node.js) ```javascript const { ConfidentialClientApplication } = require("@azure/msal-node"); const cca = new ConfidentialClientApplication({ auth: { clientId: "", authority: "https://login.microsoftonline.com/", clientSecret: "", }, }); const result = await cca.acquireTokenByClientCredential({ scopes: ["api:///.default"], }); // Use result.accessToken in the Authorization header ``` ### Using the token Include the token in every request: ``` Authorization: Bearer ``` ### Roles Access is determined by Azure AD group membership configured in the application settings: - **Admin (Owner)**: Full access to all endpoints including admin operations - **Contributor**: Can create and manage chats, files, and content - **User**: Read access to entitled chats and resources contact: name: Findable Support license: name: Proprietary servers: - url: /server description: Application server (relative) security: - BearerAuth: [] tags: - name: AI description: Chat completion and AI generation endpoints - name: Chats description: Chat configuration CRUD with ACL enforcement - name: Settings description: Application settings and health - name: Files description: Blob storage file operations - name: Search description: Azure AI Search resource management - name: User description: User profile, feedback, chat logs, and preferences - name: Flows description: FlowEngine flow designer operations - name: Prompts description: Prompt template management - name: Pages description: Navigation page management - name: Admin description: Administrative operations (admin-only) - name: Bootstrap description: Bootstrap seed data operations (admin-only) - name: Setup description: Initial application setup (pre-auth) - name: Cosmos description: Generic Cosmos DB CRUD operations - name: Tools description: Tool providers, web search, and utility tools - name: MCP description: Model Context Protocol server management - name: Telemetry description: Version, health, and API permission checks - name: SharePoint description: SharePoint entitlement management - name: Data Platform description: Data platform connection management - name: Vector Stores description: Vector store provider operations - name: OneDrive description: OneDrive personal file storage operations - name: Jobs description: Background job and scheduler management - name: Memory description: User and organizational memory operations - name: Slack description: >- Slack bot interactions and webhooks (public, uses Slack signature verification) - name: Teams description: Microsoft Teams bot webhooks and interactions - name: Human Input description: Human-in-the-loop input requests for flow executions - name: Datasources description: Datasource catalog CRUD with ACL enforcement - name: Assignments description: >- Assignment lifecycle: inbox, sent, create, launch, complete, delegate, reject, reassign, remind, and recurring schedules. Experimental feature — requires experimental flag enabled. paths: /flows/{id}: patch: tags: - Flows summary: Partial update a flow description: >- Merges provided fields. Supports promoting personal to shared but NOT demoting shared to personal. parameters: - in: path name: id required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Flow' responses: '200': description: Flow patched content: application/json: schema: $ref: '#/components/schemas/Flow' '400': description: Invalid scope change '403': description: Access denied components: schemas: Flow: type: object properties: scope: description: Access control model type: string enum: - personal - shared createdBy: description: UPN of the creator type: string isPublic: description: Allow public read access type: boolean owners: type: array items: type: object properties: id: type: string minLength: 1 type: type: string enum: - group - user displayName: type: string mail: type: string securityEnabled: type: boolean mailEnabled: type: boolean groupTypes: nullable: true type: array items: type: string groupType: type: string userPrincipalName: type: string jobTitle: type: string department: type: string officeLocation: type: string required: - id - type additionalProperties: {} contributors: type: array items: type: object properties: id: type: string minLength: 1 type: type: string enum: - group - user displayName: type: string mail: type: string securityEnabled: type: boolean mailEnabled: type: boolean groupTypes: nullable: true type: array items: type: string groupType: type: string userPrincipalName: type: string jobTitle: type: string department: type: string officeLocation: type: string required: - id - type additionalProperties: {} users: type: array items: type: object properties: id: type: string minLength: 1 type: type: string enum: - group - user displayName: type: string mail: type: string securityEnabled: type: boolean mailEnabled: type: boolean groupTypes: nullable: true type: array items: type: string groupType: type: string userPrincipalName: type: string jobTitle: type: string department: type: string officeLocation: type: string required: - id - type additionalProperties: {} inheritEntitlements: anyOf: - type: boolean - type: object properties: owners: type: boolean contributors: type: boolean users: type: boolean additionalProperties: false hideFromCatalog: description: >- Hide entity from user-facing recommendations and catalog/search surfaces (still accessible to owners/contributors/admins) type: boolean createdAt: description: ISO-8601 creation timestamp type: string updatedBy: type: string updatedAt: description: ISO-8601 update timestamp type: string id: type: string description: Flow ID (UUID) name: type: string description: type: string parentId: description: FK to parent flow group (undefined = root) type: string nodes: type: array items: type: object properties: id: type: string type: type: string enum: - agent - llm - tool - mcpServer - conditional - start - end - human - memory - retriever - prompt - formPrompt - message - content description: >- FLOWDESIGNER_NODE_TYPE — determines which config shape data.config holds position: type: object properties: x: type: number 'y': type: number required: - x - 'y' additionalProperties: false description: Canvas position data: type: object properties: label: type: string description: type: string config: description: >- Node-type-specific configuration (ILLMConfig, IAgentConfig, IToolConfig, ... per type) type: object additionalProperties: {} isConfigured: type: boolean errors: type: array items: type: string required: - label additionalProperties: false required: - id - type - position - data additionalProperties: false title: FlowNode description: A single node in a Flow Designer graph (React Flow node shape) edges: type: array items: type: object properties: id: type: string source: type: string description: Source node ID target: type: string description: Target node ID sourceHandle: nullable: true type: string targetHandle: nullable: true type: string data: type: object properties: condition: description: Branch condition (for conditional nodes) type: string label: type: string additionalProperties: false required: - id - source - target additionalProperties: false title: FlowEdge description: A directed edge in a Flow Designer graph version: type: string status: type: string enum: - published - archived description: FLOW_STATUS isEnabled: description: 'Whether this flow is enabled (default: true)' type: boolean tags: type: array items: type: string isFeatured: type: boolean flowType: description: >- FLOW_TYPE — 'general' (default) or 'retriever' (headless, for RAG pipeline) type: string enum: - general - retriever metadata: type: object additionalProperties: {} origin: description: builtIn = bootstrapped (not deletable), admin = user-created type: string enum: - builtIn - admin executionConfig: description: Execution settings type: object properties: timeout: type: integer retryPolicy: type: object properties: maxRetries: type: integer retryDelay: type: integer required: - maxRetries - retryDelay additionalProperties: false errorHandling: type: string enum: - stop - continue - fallback maxParallelism: type: integer maxIterations: description: 'Recursion limit for loops (default: 50)' type: integer enableCheckpointing: description: Persist execution state after each node for crash recovery type: boolean checkpointTtlSeconds: type: integer enableParallelFanOut: type: boolean nodeTimeoutMs: type: integer errorRecovery: description: Error-recovery buttons surfaced to the user on failure type: object properties: allowContinue: type: boolean allowRestart: type: boolean additionalProperties: false additionalProperties: false userId: description: Cosmos DB partition key type: string _ts: description: Cosmos DB last-modified timestamp (epoch seconds) type: integer required: - id - name - nodes - edges - version - status additionalProperties: false title: Flow description: >- Complete Flow Designer flow definition (graph + execution settings + ACL) securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: Azure AD access token obtained via MSAL ````