Flows
Flows represent specific AI-powered capabilities — on-brand photo generation, UGC video generation, static ads generation, and more. Use these endpoints to discover available flows and inspect their required inputs and expected outputs. Flows are always described at their last saved version; Studio autosave drafts are never exposed here.
Discover flows and inspect their input requirements and output types.
List available flows with filtering options.
This endpoint returns a paginated list of flows that can generate various types of content including images, videos, text, and other creative assets.
Each flow is described at its last saved version. A flow that has never been saved in Studio — autosave keeps it as a private draft — is still listed, but with an empty inputs array and an estimated_cost of 0; it cannot be fetched or run until someone saves it. Treat an empty inputs as "not saved yet", not as "takes no input".
Filtering Options:
tags: Only flows carrying every given tag slug, case-insensitive (can be provided multiple times; all must match)visibility: Only flows with one of these visibilities (can be provided multiple times). Values are lowercase:private: your organization's flows, visible only inside itshared: your organization's flows shared by linkpublic: flows published to everyone, from any organization, including Pletor's catalog By default, onlyprivateandsharedflows are returned.
search: Case- and accent-insensitive substring match on the flow name
Pagination Parameters:
limit: Maximum number of items to return (default: 20, min: 1, max: 100)cursor:next_cursorfrom the previous page (optional)
Response:
data: List of flow summaries with basic information including expected inputshas_more: Indicates if there are more results availablenext_cursor: Cursor for the next page of results;nullon the last page
Error Codes:
422: A parameter is out of range or not a valid value (e.g. an unknownvisibility)
Use Case: This is typically the first endpoint called to discover available flows before getting detailed information or executing them.
API key for authentication
Only flows carrying every given tag slug (case-insensitive); repeat to require several
Case- and accent-insensitive substring of the flow name
Maximum number of items to return
20Cursor for pagination (from next_cursor)
Active organization ID for multi-org support
Successful Response
Validation error (validation_error)
GET /api/public/v1/flows/ HTTP/1.1
Host: api.pletor.ai
X-Api-Key: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"tags": [
"text"
],
"estimated_cost": 1,
"visibility": "public",
"inputs": [
{
"id": "text",
"type": "text_input",
"description": "text",
"required": true
}
],
"has_human_review": false
}
],
"has_more": true,
"next_cursor": "text"
}Get detailed information about a specific flow.
Everything below describes the flow's last saved version, not the draft you are editing in Studio. Save the flow again to expose newer edits here and to POST /runs.
This endpoint retrieves comprehensive information about a flow, including:
Flow metadata (name, description, tags)
Input requirements with types
Output specifications and formats
Cost estimate, and whether the flow pauses for human review
Input Information: Each flow defines specific inputs it requires:
id: Node identifier used when executing the flowtype: Input type —text_inputtakes text;image_input,video_input,audio_inputandfile_inputtake uploaded asset IDsdescription: Generated from the input's Studio labelrequired: WhetherPOST /runsrejects a run that omits it
Brand context is not an input: a flow's brand is fixed in the flow and is never listed here or accepted by POST /runs.
Output Information: Each flow specifies what types of content it generates:
id: Node identifier for the output, matchingidin run resultstype: Output type (text, images, videos, audio, data)description: Generated from the output type
Cost and Review:
estimated_cost: Credit cost estimation for running this flowhas_human_review:truewhen runs pause for a human review, resolved viaPOST /runs/{run_id}/reviews/{review_id}
Use Case: Call this endpoint to understand what inputs a flow needs and what outputs it will generate before creating a generation request.
Error Codes:
404: Flow not found or not accessible422: Flow has never been saved in Studio, so it has no version to describe, orflow_idis not a UUID
API key for authentication
Active organization ID for multi-org support
Successful Response
Complete representation of a flow with its inputs, outputs, and cost.
Unique flow identifier
Flow display name
Flow description and purpose; empty when none is set
Tag slugs; filter on them with tags on GET /flows/
Estimated credit cost per execution; 0 when not estimated
True when this flow includes a human review step that will pause execution until resolved via POST /runs/{run_id}/reviews/{review_id}. Poll GET /runs/{run_id} for awaiting_human_review while the run is in progress.
falseValidation error (validation_error)
GET /api/public/v1/flows/{flow_id} HTTP/1.1
Host: api.pletor.ai
X-Api-Key: YOUR_API_KEY
Accept: */*
{
"description": "Generate marketing banners from a text prompt and logo",
"estimated_cost": 50,
"has_human_review": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"inputs": [
{
"description": "Input for Product description",
"id": "uuid-1",
"required": true,
"type": "text_input"
},
{
"description": "Input for Company logo",
"id": "uuid-2",
"required": false,
"type": "image_input"
}
],
"name": "Marketing Banner Generator",
"outputs": [
{
"description": "Generated images",
"id": "uuid-3",
"type": "images"
}
],
"tags": [
"marketing",
"image"
]
}Last updated