Postman Collection

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

Download

Download Postman Collection

Importing the Collection

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 Variables

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)
   • flow_id: A flow ID for testing (optional)
   • run_id: A run ID for testing (optional)
   • queue_id: A queued run ID (optional)
   • agent_id: An agent ID for testing (optional)
   • session_id: An agent session ID (optional)

Available Endpoints

Authentication

• Validate Authentication - Verify your API key

Flows

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

Runs

• List Runs - Get all runs across all flows
• Trigger Run - Start a new flow execution
• Get Run - Get details of a specific run
• Cancel Run - Cancel a running flow
• Stream Run - Stream real-time updates (SSE)

Queue

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

Agents

• List Agents / Get Agent - Discovery metadata
• Start Agent Session - Create a chat session
• Send Agent Message - Wait for the full reply
• Stream Agent Message - SSE text-delta events
• Resume Agent Session Stream - Reconnect with lastEventId

See also the API Reference and Agents API.

Usage Tips

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 this variable when testing flow-specific endpoints
4. Run ID: Use this variable when testing run-specific endpoints
5. Query Parameters: Many endpoints have optional query parameters that are disabled by default. Enable them as needed.

Environment Variables

You can also create Postman environments for different stages:

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