API Documentation
Complete reference for the FlowApp Studio REST API. Everything you need to authenticate, make requests, and handle responses.
Authentication
All API requests require a Bearer token. Generate your API key from the FlowApp Studio dashboard under Settings → API Keys.
// Pass your API key as a Bearer token
const response = await fetch('https://api.flowappstudio.com/v1/flows', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
})Base URL
All requests are made over HTTPS to the following base URL. Include your API version in each request path.
https://api.flowappstudio.com
// Versioned paths
GET /v1/flows
POST /v1/sessions
GET /v1/eventsCore Endpoints
The FlowApp Studio API is organized around REST. Each resource follows standard CRUD patterns.
/v1/flowsList all flows in your account/v1/flowsCreate a new flow/v1/flows/:idRetrieve a specific flow/v1/sessionsStart a new user session/v1/sessions/:idGet session details and state/v1/eventsList all events for your accountRate Limits
Requests are limited per API key. Exceeded limits return a 429 response with a Retry-After header.
Standard
1,000 requests / minute
Burst
Up to 5,000 requests / minute for short bursts
Error Codes
The API returns standard HTTP status codes. All errors include a machine-readable code and a human-readable message.
Bad Request
Missing or invalid request parameters
Unauthorized
Invalid or missing API key
Forbidden
Insufficient permissions for this resource
Not Found
The requested resource does not exist
Rate Limited
Too many requests — slow down and retry
Server Error
Something went wrong on our end
// Success
{
"id": "flow_01J9XK...",
"name": "Customer Support",
"status": "published",
"created_at": "2024-01-15T10:30:00Z"
}
// Error
{
"error": {
"code": "unauthorized",
"message": "Invalid API key provided."
}
}