Postman CollectionCopy Anchor Link

Download the ActionFlows API Postman collection to quickly test and explore our API endpoints.

DownloadCopy Anchor Link

Download Postman Collection

Importing the CollectionCopy Anchor Link

1. Open Postman
2. Click Import button
3. Select the downloaded ActionFlows-API.postman_collection.json file
4. The collection will be imported with all endpoints

Setting Up VariablesCopy Anchor Link

After importing, configure the collection variables:

1. Click on the collection name

2. Go to the Variables tab

3. Set the following variables:

   • base_url: https://api.actionflows.ai (or your custom API URL)
   • api_key: Your ActionFlows API key (get it from organization settings)
   • organization_id: Your organization ID (optional, for testing)
   • action_flow_id: A flow ID for testing (optional)
   • run_id: A run ID for testing (optional). Must start with run_.
   • queue_id: A queued run ID (optional)
   • action_agent_id: An agent ID for testing (optional)
   • session_id: An agent session ID (optional)

Available EndpointsCopy Anchor Link

AuthenticationCopy Anchor Link

• Validate Authentication - Verify your API key

FlowsCopy Anchor Link

• List Flows - List flow metadata for your organization
• Get Flow - Get flow metadata (no graph)
• List Flow Runs - Get run history for a specific flow

RunsCopy Anchor Link

• List Runs - Get public run objects across all flows
• Trigger Run - Enqueue a flow run (inputs + optional trigger)
• Get Run - Get a public run object
• Cancel Run - Cancel a running flow
• Stream Run - Stream public run updates (SSE)

QueueCopy Anchor Link

• List Queued Runs - List waiting queue items
• Get Queued Run - Get a queue item
• Cancel Queued Run - Cancel a waiting queue item

AgentsCopy Anchor Link

• List Agents / Get Agent - Discovery metadata
• Create Chat Completion - OpenAI-compatible chat (model is the agent id; send X-ActionFlows-Session-Id to continue a session)

See also the API Reference and Agents API.

Usage TipsCopy Anchor Link

1. API Key: Set your API key in the collection variables to use it across all requests
2. Organization ID: Some endpoints require or work better with an organization ID
3. Flow ID: Use action_flow_id when testing flow-specific endpoints
4. Run ID: Use run_id when testing run-specific endpoints. It must start with run_.
5. Query Parameters: Many endpoints have optional query parameters that are disabled by default. Enable them as needed.

Environment VariablesCopy Anchor Link

You can also create Postman environments for different stages:

• Production: https://api.actionflows.ai
• Development: Your local or staging API URL