Skip to main content
GET
/
api
/
v1
/
chatflows
/
{id}
Get Chatflow
curl --request GET \
  --url https://api.example.com/api/v1/chatflows/{id}
{
  "401": {},
  "403": {},
  "404": {},
  "412": {},
  "500": {},
  "id": "<string>",
  "name": "<string>",
  "flowData": "<string>",
  "deployed": true,
  "isPublic": true,
  "apikeyid": "<string>",
  "chatbotConfig": "<string>",
  "apiConfig": "<string>",
  "analytic": "<string>",
  "speechToText": "<string>",
  "textToSpeech": "<string>",
  "followUpPrompts": "<string>",
  "type": "<string>",
  "category": "<string>",
  "workspaceId": "<string>",
  "createdDate": "<string>",
  "updatedDate": "<string>"
}

​
Authentication

This endpoint requires authentication. You must include your API key in the request headers or be authenticated via session.
Required permissions: chatflows:view, chatflows:update, chatflows:delete, agentflows:view, agentflows:update, or agentflows:delete

​
Path Parameters

​
id
string
required
The unique identifier (UUID) of the chatflow to retrieve

​
Response

​
id
string
Unique identifier (UUID) for the chatflow
​
name
string
Name of the chatflow
​
flowData
string
JSON string containing the complete flow configuration, including all nodes and edges that define the chatflow logic
​
deployed
boolean
Whether the chatflow is currently deployed and available for use
​
isPublic
boolean
Whether the chatflow is publicly accessible without authentication
​
apikeyid
string
Associated API key ID for accessing this chatflow
​
chatbotConfig
string
JSON string containing chatbot configuration including:
  • Welcome messages
  • UI customization
  • Allowed origins for CORS
  • Post-processing settings
​
apiConfig
string
JSON string containing API-specific configuration settings
​
analytic
string
JSON string containing analytics configuration
​
speechToText
string
JSON string containing speech-to-text configuration
​
textToSpeech
string
JSON string containing text-to-speech configuration
​
followUpPrompts
string
JSON string containing follow-up prompt suggestions
​
type
string
Type of the chatflow: CHATFLOW, AGENTFLOW, MULTIAGENT, or ASSISTANT
​
category
string
Category classification for organizing chatflows
​
workspaceId
string
ID of the workspace that owns this chatflow
​
createdDate
string
ISO 8601 timestamp when the chatflow was created
​
updatedDate
string
ISO 8601 timestamp when the chatflow was last updated

​
Example Request

cURL
curl -X GET "https://your-flowise-instance.com/api/v1/chatflows/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer YOUR_API_KEY"
JavaScript
const chatflowId = '123e4567-e89b-12d3-a456-426614174000';
const response = await fetch(`https://your-flowise-instance.com/api/v1/chatflows/${chatflowId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const chatflow = await response.json();
Python
import requests

chatflow_id = '123e4567-e89b-12d3-a456-426614174000'
response = requests.get(
    f'https://your-flowise-instance.com/api/v1/chatflows/{chatflow_id}',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
chatflow = response.json()

​
Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Customer Support Bot",
  "flowData": "{\"nodes\":[{\"id\":\"node1\",\"type\":\"chatOpenAI\",\"data\":{}}],\"edges\":[]}",
  "deployed": true,
  "isPublic": false,
  "apikeyid": "abc123",
  "chatbotConfig": "{\"welcomeMessage\":\"Hello! How can I help you today?\",\"allowedOrigins\":[\"https://example.com\"]}",
  "apiConfig": null,
  "analytic": null,
  "speechToText": null,
  "textToSpeech": null,
  "followUpPrompts": null,
  "type": "CHATFLOW",
  "category": "Support",
  "workspaceId": "workspace-123",
  "createdDate": "2024-01-15T10:30:00.000Z",
  "updatedDate": "2024-01-20T14:45:00.000Z"
}

​
Error Responses

​
401
error
Unauthorized - Invalid or missing API key
​
403
error
Forbidden - Insufficient permissions to view this chatflow
​
404
error
Not Found - Chatflow with the specified ID does not exist or you don’t have access to it
{
  "message": "Chatflow not found"
}
​
412
error
Precondition Failed - ID parameter was not provided
​
500
error
Internal Server Error - An error occurred while fetching the chatflow
The chatflow must belong to your active workspace. You cannot retrieve chatflows from other workspaces.

Build docs developers (and LLMs) love

Get started for freeTalk to us