Skip to main content

API Configuration

Configure your workflow to have API input and output connections.

Updated over 5 months ago

The API Configuration system in Enhanced.ai's FluxPrompt platform provides comprehensive tools for integrating your workflows with external systems through RESTful API endpoints. This powerful feature enables you to trigger workflows programmatically and receive results through various delivery methods.

Understanding the API Config

The API Config is a configuration interface that provides access to your FluxPrompt workflow's API settings. Located in the External category of the Node Toolbar, it displays the automatically generated endpoints and authentication details for external integration.

Accessing API Configuration

  1. Generate API Key: First, navigate to Profile Settings and generate your personal API key

  2. Open API Config: Click on "API Config" in the External category of the Node Toolbar

  3. Review Configuration: The API Config dialog displays your workflow's API settings and your generated API key

  4. Copy Details: Use the generated API endpoint and your personal API key for external integration

Generating Your API Key

Profile Settings Configuration

Before you can use API functionality, you must generate your personal API key:

  1. Access Profile Settings: Click on your profile in the top navigation and select "Profile Settings"

  2. Locate API Key Section: Find the API Key field in your Personal Information section

  3. Generate API Key: Click the "Show" button or generate a new API key if one doesn't exist

  4. Copy Your Key: Once generated, your API key will be available for use across all workflows

API Key Display

Once your API key is generated in Profile Settings, it will automatically appear in:

  • API Config Interface: When viewing API configuration for any workflow

  • Flow Global Node: In the API Calling section of workflow settings

  • Profile Dashboard: Always accessible in your Profile Settings for reference

API Endpoint Configuration

The system automatically creates a unique API endpoint for your workflow:

https://api.fluxprompt.ai/flux/api-v2?flowId=YOUR_WORKFLOW_ID

This URL serves as the entry point for all external API calls to your specific workflow.

API Authentication

Your personal API key provides secure access to all your workflows:

api-key: YOUR_API_KEY

This key must be included in the header of all API requests to authenticate and authorize access to your workflows. The API key is unique to your user account and can be used across all your workflows.

Generated API URL

Data Input Configuration

Input Node Setup

Configure your Data Input nodes to receive external data:

Data Section

  • Purpose: Defines the core input parameters for API calls

  • Configuration: Each input field becomes a parameter in your API request

  • Identification: Each Data Input node receives a unique identifier for API mapping

File Section

  • External File Integration: Accept file URLs as input parameters

  • Link Processing: Enter "Link goes here" placeholder for file URL inputs

  • File Handling: Process external files referenced by URLs in API calls

Uploaded Files Section

  • Direct File Access: Reference files uploaded directly to the FluxPrompt platform

  • File Management: Access previously uploaded files within API-triggered workflows

  • Unique Identifiers: Each uploaded file receives a specific ID for API reference

Variable Input Structure

The API automatically generates a JSON structure for your workflow inputs:

{
"variableInputs": [
{
"inputId": "INPUT_NODE_ID_1",
"inputText": "Example 1 Text For Input"
},
{
"inputId": "INPUT_NODE_ID_2",
"inputText": "Example 2 Text For Input"
}
]
}Data Output Configuration

Output Display

The Data Output node provides multiple delivery methods for workflow results:

Primary Output Section

  • Display Area: Large preview area showing "Your output will be displayed here"

  • Result Presentation: Formatted display of workflow completion results

  • Real-time Updates: Live updates as the workflow processes

Callback URL Integration

  • External System Integration: Send results to specified endpoints

  • URL Configuration: Enter destination URLs in the "Url" field

  • Automated Delivery: Automatic POST requests with results upon workflow completion

Email Delivery

  • Send to Email Section: Expandable configuration for email delivery

  • Automated Notifications: Send workflow results via email

  • Flexible Configuration: Multiple email delivery options

Flow Global Configuration - API Settings

API Calling Configuration

Access API-specific settings through the Flow Global Node:

API Calling

  • Turn on API Calling: Enable REST API access for your workflow

  • API Endpoint Display: View your workflow's unique API URL

  • Authentication: Your personal API key is displayed here for reference

  • JSON Body Example: Copy the example JSON structure for making API calls

  • Integration Ready: Once enabled, your workflow can receive external API requests

Implementation Examples

Making API Calls

Basic API Request

curl -X POST \
-H "Content-Type: application/json" \
-H "api-key: YOUR_API_KEY" \
-d '{
"variableInputs": [
{
"inputId": "YOUR_INPUT_NODE_ID",
"inputText": "Your input text here"
}
]
}' \
https://api.fluxprompt.ai/flux/api-v2?flowId=YOUR_WORKFLOW_IDResponse Handling
  • Success Response: JSON object containing workflow results

  • Error Handling: Detailed error messages for troubleshooting

  • Status Codes: Standard HTTP status codes for response handling

Integration Patterns

External Application Integration

  1. Setup: Configure API endpoints and authentication

  2. Input Mapping: Map application data to workflow input parameters

  3. Execution: Trigger workflow via API call

  4. Result Processing: Handle returned data in your application

Webhook Automation

  1. Webhook Registration: Configure external services to call your workflow

  2. Automatic Processing: Workflows execute immediately upon webhook receipt

  3. Response Delivery: Results sent back via callback URLs or email

Security and Best Practices

API Key Management

  • Single Key for All Workflows: Use your personal API key across all your FluxPrompt workflows

  • Profile Settings Access: Always available in your Profile Settings for reference and regeneration

  • Secure Storage: Store your API key securely in your application

  • Access Control: Keep your API key private and limit access to authorized personnel only

  • Key Regeneration: Generate a new API key in Profile Settings if needed (this will invalidate the previous key)

Error Handling

  • Connection Timeouts: Implement appropriate timeout handling

  • Rate Limiting: Respect API rate limits and implement backoff strategies

  • Validation: Validate input data before sending API requests

Testing and Monitoring

  • Flow Logs: Monitor execution history and performance

  • Test Calls: Use manual "Run Flow" for testing before automation

  • Error Tracking: Review error logs for troubleshooting

The API Configuration system in FluxPrompt provides enterprise-grade integration capabilities, enabling seamless connection between your AI workflows and external systems. With comprehensive authentication, flexible input/output handling, and multiple trigger methods, you can build robust automated solutions that scale with your business needs.

Did this answer your question?