Implementation:FlowiseAI Flowise Swagger API Specification

Knowledge Sources	FlowiseAI Flowise
Domains	API, Documentation
Last Updated	2026-02-12 07:00 GMT

Overview

This YAML file defines the complete OpenAPI/Swagger specification for the Flowise REST API, documenting all public endpoints, request/response schemas, and authentication requirements.

Description

The specification covers 15 API resource tags including assistants, chatflows, chatmessage, prediction, tools, variables, document-store, feedback, leads, attachments, vector, upsert-history, ping, and apikey. It defines comprehensive schemas for entities such as ChatMessage, Assistant, Chatflow, DocumentStore, ChatMessageFeedback, and CreateAttachmentResponse. The API uses Bearer JWT authentication via the bearerAuth security scheme.

Usage

Use this specification file to generate API documentation, client SDKs, or for importing into API testing tools like Swagger UI or Postman. It serves as the authoritative contract for integrating with the Flowise REST API.

Code Reference

Source Location

• Repository: FlowiseAI Flowise
• File: packages/api-documentation/src/yml/swagger.yml
• Lines: 1-2664

Signature

tags:
    - name: assistants
    - name: attachments
    - name: chatmessage
    - name: chatflows
    - name: document-store
    - name: feedback
    - name: leads
    - name: ping
    - name: prediction
    - name: tools
    - name: upsert-history
    - name: variables
    - name: vector

paths:
    /chatmessage/{id}:
    /assistants:
    /assistants/{id}:
    /attachments/{chatflowId}/{chatId}:
    /chatflows:
    /chatflows/{id}:
    /chatflows/apikey/{apikey}:
    /document-store/store:
    /document-store/store/{id}:
    /document-store/upsert/{id}:
    /document-store/refresh/{id}:
    /document-store/vectorstore/query:
    /document-store/loader/{storeId}/{loaderId}:
    /document-store/vectorstore/{id}:
    /document-store/chunks/{storeId}/{loaderId}/{pageNo}:
    /document-store/chunks/{storeId}/{loaderId}/{chunkId}:
    /feedback:
    /feedback/{id}:
    /leads:
    /leads/{id}:
    /ping:
    /prediction/{id}:
    /tools:
    /tools/{id}:
    /upsert-history/{id}:
    /variables:
    /variables/{id}:
    /vector/upsert/{id}:

Import

# Reference this file in your Swagger UI or API documentation setup:
# swagger-ui path: packages/api-documentation/src/yml/swagger.yml

I/O Contract

Inputs

Name	Type	Required	Description
bearerAuth	JWT token	Yes	Bearer token for authenticating API requests
id	string (path)	Varies	Resource identifier used in path parameters
chatType	string (query)	No	Filter by INTERNAL or EXTERNAL chat type
order	string (query)	No	Sort order: ASC or DESC
chatId	string (query)	No	Filter by specific chat session ID
startDate	date-time (query)	No	Filter results by start date
endDate	date-time (query)	No	Filter results by end date

Outputs

Name	Type	Description
ChatMessage	object	Chat message entity with id, role, content, chatflowid, and timestamps
Assistant	object	Assistant entity with configuration details
Chatflow	object	Chatflow definition with flowData and settings
DocumentStore	object	Document store entity with loaders and status
ChatMessageFeedback	object	Feedback entity with rating (THUMBS_UP/THUMBS_DOWN) and content
CreateAttachmentResponse	object	File attachment with name, mimeType, size, and content

Usage Examples

Basic Usage

# Example: List all chat messages for a chatflow
# GET /chatmessage/{chatflowId}?chatType=EXTERNAL&order=DESC
# Headers: Authorization: Bearer <your-jwt-token>

# Example: Create a prediction
# POST /prediction/{chatflowId}
# Body: { "question": "What is Flowise?", "overrideConfig": {} }
# Headers: Authorization: Bearer <your-jwt-token>

Related Pages

• Principle:FlowiseAI_Flowise_API_Documentation