> ## Documentation Index > Fetch the complete documentation index at: https://docs.flowra.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get workflow detail > Returns full configuration of a workflow: name, tools, prompt, model, and connection settings. Use this to inspect or edit a workflow. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/workflow/manager/detail/{id} openapi: 3.0.0 info: title: Flowra API (API Key Endpoints) description: >- **Flowra** is an AI-powered platform for building agents, workflows, and integrations. ### Capabilities - **Tools & Toolkits** – Define and group tools for agents and workflows. - **Workflows** – Orchestrate steps and automate processes. - **Triggers** – Schedule or event-based execution. - **Auth & Connections** – OAuth, API keys, and connected accounts. - **MCP** – Model Context Protocol server integration. - **Knowledge / RAG** – Add files and URLs for retrieval-augmented generation. ### Authentication Use the **x-api-key** header with a project API key to access endpoints that support API Key auth. Create and manage API keys in the dashboard under your project settings. Only endpoints that support API Key authentication via the @ApiKeyEnabled() decorator. Send x-api-key (required). On multi-tenant endpoints, optionally send x-username to act as an external user. version: '1.0' contact: name: Flowra url: https://flowra.dev servers: - url: https://flowra.dev description: Flowra API security: [] tags: - name: Users description: User profile - name: External Users description: End-user identities inside a project (x-username) - name: Auth Configs description: OAuth and API key configs for toolkits - name: Connected Accounts description: OAuth connected accounts and link creation - name: Toolkits description: List and search toolkits - name: Tools description: List, execute, and manage tools - name: Skills description: Browse, create, import, and install skills - name: Workflow & Agent description: Create, run, and inspect workflows and agents - name: Triggers description: Schedule and event-based trigger instances - name: Chat description: Threads and streaming agent runs - name: File description: Upload, list, and download files - name: Knowledge description: RAG knowledge collections - name: Table description: Collections and documents - name: Sandbox description: Ephemeral and durable code sandboxes - name: Browser description: Live browser sessions and view - name: LLM description: List AI models and generate completions - name: MCP description: MCP server management - name: usage description: Credit balance and usage ledger for the project API key paths: /api/v1/workflow/manager/detail/{id}: get: tags: - Workflow & Agent summary: Get workflow detail description: >- Returns full configuration of a workflow: name, tools, prompt, model, and connection settings. Use this to inspect or edit a workflow. operationId: WorkflowManagerController_detail parameters: - name: id required: true in: path description: Workflow (agent) ID schema: example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: string - name: x-username in: header required: false description: >- External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context. schema: type: string default: (project default user) example: customer_alice responses: '200': description: Workflow detail retrieved successfully content: application/json: schema: $ref: '#/components/schemas/WorkflowResponseDtoSuccessResponse' example: success: true message: Operation completed successfully data: id: '' name: '' description: '' projectId: '' agent: prompt: '' modelSettings: {} capabilities: {} behavior: {} identity: {} skillIds: - '' subAgentIds: - '' knowledgeCollectionIds: - '' databaseCollectionIds: - '' databaseAccessPolicies: {} starterPrompts: - '' avatarUrl: '' tools: mode: NORMAL discoveryWhitelist: true pinnedSlugs: - '' externalMcpConfigs: - '' connectionCallbackUrl: '' visitorOwnerConnections: enabled: true toolkits: [] inputSchema: {} outputSchema: {} graph: nodes: - id: '' type: action toolSlug: '' inputMapping: {} code: '' agent: {} outputSchema: {} edges: - from: '' to: '' condition: '' inputSchema: {} outputSchema: {} provenance: createdByAgent: true productCreationDepth: 0 createdFromWorkflowId: '' hideFromAgentPicker: true marketplaceClone: sourceWorkflowId: '' clonedAt: '' skillIdMap: {} knowledgeIdMap: {} databaseIdMap: {} subAgentIdMap: {} avatarFileIdMap: {} setupState: answers: {} completedStepIds: - '' triggers: - kind: manual expression: '' timezone: '' toolSlug: '' triggerToolInput: {} triggerId: '' toolkitName: '' toolkitLogo: '' workflowType: static isActive: true lifecycle: draft isPublic: true version: '' clonedFromWorkflowId: '' clonedFromVersion: '' executionCount: 0 successfulExecutionCount: 0 failedExecutionCount: 0 lastExecutedAt: '' connections: - id: '' connectionId: '' toolkitSlug: '' displayName: '' label: '' createdAt: '' updatedAt: '' tools: - toolSlug: '' toolName: '' toolkitName: '' toolkitLogo: '' subAgents: - '' createdAt: '2024-01-01T00:00:00.000Z' updatedAt: '2024-01-01T00:00:00.000Z' sourceVersionLatest: 1.0.2 toolkitAuthConfigs: - toolkitSlug: '' authConfigId: '' name: '' authScheme: '' status: '' toolkitConnections: - toolkitSlug: '' connectedAccountId: '' displayName: '' label: '' status: '' authConfigId: '' marketplaceCategory: '' marketplaceAudience: '' marketplaceTagline: '' marketplaceSetupGuide: '' marketplaceSetupSpec: {} marketplaceSetupSkillId: '' marketplaceSetupSkillSlug: '' marketplaceHighlights: - '' marketplaceIsListed: true marketplaceCapabilities: hasSkills: true skillCount: 0 hasKnowledge: true hasDatabase: true hasCron: true requiresAuth: true toolkitCount: 0 subAgentCount: 0 toolCount: 0 security: - x-api-key: [] - x-api-key: [] x-username: [] components: schemas: WorkflowResponseDtoSuccessResponse: type: object properties: success: type: boolean description: Success status example: true message: type: string description: Success message example: Operation completed successfully data: type: object properties: id: type: string name: type: string description: type: string projectId: type: string agent: type: object properties: prompt: type: string modelSettings: type: object capabilities: type: object behavior: type: object identity: type: object skillIds: type: array items: type: string subAgentIds: type: array items: type: string knowledgeCollectionIds: type: array items: type: string databaseCollectionIds: type: array items: type: string databaseAccessPolicies: type: object starterPrompts: type: array items: type: string avatarUrl: type: string tools: type: object properties: mode: enum: - NORMAL - META type: string discoveryWhitelist: type: boolean pinnedSlugs: type: array items: type: string externalMcpConfigs: type: array items: type: string connectionCallbackUrl: type: string nullable: true visitorOwnerConnections: $ref: >- #/components/schemas/AgentVisitorOwnerConnectionsResponseDto required: - mode inputSchema: type: object outputSchema: type: object required: - prompt - tools graph: type: object properties: nodes: type: array items: type: object properties: id: type: string type: type: string enum: - action - code - llm_agent - start - end - human_wait toolSlug: type: string inputMapping: type: object code: type: string agent: $ref: '#/components/schemas/GraphNodeAgentResponseDto' outputSchema: type: object required: - id - type edges: type: array items: type: object properties: from: type: string to: type: string condition: type: string required: - from - to inputSchema: type: object outputSchema: type: object required: - nodes - edges provenance: type: object properties: createdByAgent: type: boolean productCreationDepth: type: number createdFromWorkflowId: type: string hideFromAgentPicker: type: boolean marketplaceClone: type: object properties: sourceWorkflowId: type: string clonedAt: type: string skillIdMap: type: object knowledgeIdMap: type: object databaseIdMap: type: object subAgentIdMap: type: object avatarFileIdMap: type: object setupState: type: object properties: answers: type: object completedStepIds: type: array items: type: string required: - marketplaceClone triggers: type: array items: type: object properties: kind: type: string enum: - manual - cron - trigger_tool expression: type: string timezone: type: string toolSlug: type: string triggerToolInput: type: object triggerId: type: string toolkitName: type: string toolkitLogo: type: string required: - kind workflowType: type: string enum: - static - agent isActive: type: boolean lifecycle: type: string enum: - draft - ready description: >- Completeness lifecycle. draft = incomplete build (cannot activate); ready = may set isActive true. isPublic: type: boolean description: >- Whether this workflow (agent) is public for select in other projects version: type: string description: >- Version in form 1.0.x; incremented on each update (for marketplace update check) clonedFromWorkflowId: type: string nullable: true description: 'If cloned from marketplace: source workflow id' clonedFromVersion: type: string nullable: true description: Source workflow version at clone time (e.g. 1.0.1) executionCount: type: number successfulExecutionCount: type: number description: Number of executions that finished with status completed failedExecutionCount: type: number description: Number of executions that finished with status failed or timeout lastExecutedAt: type: string connections: type: array items: type: object properties: id: type: string connectionId: type: string toolkitSlug: type: string displayName: type: string nullable: true description: User-defined label from connected_accounts.displayName label: type: string nullable: true description: >- Human label (displayName, else toolkit name). Never a UUID. createdAt: type: string updatedAt: type: string required: - id - connectionId - toolkitSlug - createdAt - updatedAt tools: description: Pinned tools from workflow_tools join (enriched). type: array items: type: object properties: toolSlug: type: string toolName: type: string toolkitName: type: string toolkitLogo: type: string required: - toolSlug - toolName - toolkitName subAgents: description: Resolved child specialists (hidden from the agent list). type: array items: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string sourceVersionLatest: type: string description: >- When workflow is cloned from marketplace: latest version of source (for "update available" UI). example: 1.0.2 toolkitAuthConfigs: description: 'Agent-only: toolkitSlug → AuthConfig bindings.' type: array items: type: object properties: toolkitSlug: type: string authConfigId: type: string name: type: string nullable: true authScheme: type: string nullable: true status: type: string nullable: true required: - toolkitSlug - authConfigId toolkitConnections: description: >- Static + cron agents: preferred ConnectedAccount binds (chat/trigger do not use these). type: array items: type: object properties: toolkitSlug: type: string connectedAccountId: type: string displayName: type: string nullable: true label: type: string nullable: true description: >- Human label (displayName or provider identity). Never a UUID. status: type: string nullable: true authConfigId: type: string nullable: true required: - toolkitSlug - connectedAccountId marketplaceCategory: type: string nullable: true description: Marketplace listing category marketplaceAudience: type: string nullable: true description: 'Marketplace audience: for_you | for_your_users | both' marketplaceTagline: type: string nullable: true marketplaceSetupGuide: type: string nullable: true marketplaceSetupSpec: type: object nullable: true marketplaceSetupSkillId: type: string nullable: true marketplaceSetupSkillSlug: type: string nullable: true marketplaceHighlights: nullable: true type: array items: type: string marketplaceIsListed: type: boolean description: When false, listing is hidden from the public catalog marketplaceCapabilities: type: object properties: hasSkills: type: boolean skillCount: type: number hasKnowledge: type: boolean hasDatabase: type: boolean hasCron: type: boolean requiresAuth: type: boolean toolkitCount: type: number subAgentCount: type: number toolCount: type: number required: - id - name - projectId - triggers - workflowType - isActive - lifecycle - isPublic - version - executionCount - successfulExecutionCount - failedExecutionCount - connections - tools - createdAt - updatedAt - marketplaceCapabilities example: id: '' name: '' description: '' projectId: '' agent: prompt: '' modelSettings: {} capabilities: {} behavior: {} identity: {} skillIds: - '' subAgentIds: - '' knowledgeCollectionIds: - '' databaseCollectionIds: - '' databaseAccessPolicies: {} starterPrompts: - '' avatarUrl: '' tools: mode: NORMAL discoveryWhitelist: true pinnedSlugs: - '' externalMcpConfigs: - '' connectionCallbackUrl: '' visitorOwnerConnections: enabled: true toolkits: [] inputSchema: {} outputSchema: {} graph: nodes: - id: '' type: action toolSlug: '' inputMapping: {} code: '' agent: {} outputSchema: {} edges: - from: '' to: '' condition: '' inputSchema: {} outputSchema: {} provenance: createdByAgent: true productCreationDepth: 0 createdFromWorkflowId: '' hideFromAgentPicker: true marketplaceClone: sourceWorkflowId: '' clonedAt: '' skillIdMap: {} knowledgeIdMap: {} databaseIdMap: {} subAgentIdMap: {} avatarFileIdMap: {} setupState: answers: {} completedStepIds: - '' triggers: - kind: manual expression: '' timezone: '' toolSlug: '' triggerToolInput: {} triggerId: '' toolkitName: '' toolkitLogo: '' workflowType: static isActive: true lifecycle: draft isPublic: true version: '' clonedFromWorkflowId: '' clonedFromVersion: '' executionCount: 0 successfulExecutionCount: 0 failedExecutionCount: 0 lastExecutedAt: '' connections: - id: '' connectionId: '' toolkitSlug: '' displayName: '' label: '' createdAt: '' updatedAt: '' tools: - toolSlug: '' toolName: '' toolkitName: '' toolkitLogo: '' subAgents: - '' createdAt: '2024-01-01T00:00:00.000Z' updatedAt: '2024-01-01T00:00:00.000Z' sourceVersionLatest: 1.0.2 toolkitAuthConfigs: - toolkitSlug: '' authConfigId: '' name: '' authScheme: '' status: '' toolkitConnections: - toolkitSlug: '' connectedAccountId: '' displayName: '' label: '' status: '' authConfigId: '' marketplaceCategory: '' marketplaceAudience: '' marketplaceTagline: '' marketplaceSetupGuide: '' marketplaceSetupSpec: {} marketplaceSetupSkillId: '' marketplaceSetupSkillSlug: '' marketplaceHighlights: - '' marketplaceIsListed: true marketplaceCapabilities: hasSkills: true skillCount: 0 hasKnowledge: true hasDatabase: true hasCron: true requiresAuth: true toolkitCount: 0 subAgentCount: 0 toolCount: 0 required: - success - message - data AgentVisitorOwnerConnectionsResponseDto: type: object properties: enabled: type: boolean toolkits: type: array items: $ref: '#/components/schemas/AgentVisitorOwnerToolkitGrantResponseDto' required: - enabled - toolkits GraphNodeAgentResponseDto: type: object properties: prompt: type: string modelSettings: type: object toolSlugs: type: array items: type: string knowledgeCollectionIds: type: array items: type: string databaseCollectionIds: type: array items: type: string databaseAccessPolicies: type: object required: - prompt AgentVisitorOwnerToolkitGrantResponseDto: type: object properties: toolkitSlug: type: string toolSlugs: type: array items: type: string required: - toolkitSlug securitySchemes: x-api-key: type: apiKey in: header name: x-api-key description: >- Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key: x-username: type: apiKey in: header name: x-username description: >- Optional. External user username. If omitted, Flowra uses the project’s default external user. Send as header: x-username: ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.