Custom API Integration allows you to connect SleekFlow AI modules, such as AgentFlow, with external systems using API documentation files.

With this setup, your AI agent can retrieve external data, trigger actions, or update records during customer conversations. This enables more dynamic workflows that go beyond static Knowledge Base responses.

For example, you can:

• Create payment links through your internal system
• Retrieve customer or membership details from a CRM
• Search products and generate booking links
• Trigger backend workflows based on customer requests

This is useful when your agent needs to interact with real-time data or business systems during a conversation.

How Custom API Integration works

Custom API Integration defines the API schema that AgentFlow can use.

This includes:

• Inputs: data sent to the API
• Outputs: data returned from the API
• Descriptions: what each field means
• Sources: where input values come from

Custom API integration settings and AgentFlow playbook configuration serve different roles.

Custom API integration settings define the API structure and details, such as endpoints, inputs, outputs, field descriptions, data sources, and authentication.

The AgentFlow playbook defines how the agent uses the API during a conversation, including when to call the API, what information to collect from the customer, and how to use the API response.

You can follow the steps below to set up your Custom API:

Step 1: Start a new Custom API integration

1. Click on the  icon on the left navigation bar to go to the SleekFlow AI page
2. In the SleekFlow AI page, click on “Integrations” on the top navigation bar
   
3. You will be redirected to the “Integrations” tab
4. Click “Add integration” at the top right corner
   

This opens the setup flow for connecting an external API.

Step 2: Configure the integration using the conversational setup

Use the conversational setup window on the left to define your integration.

Instead of filling out a form, you guide the setup by describing your API and how it should be used.

What you should provide

To get a useful schema, include:

• Your API documentation file (JSON or Swagger), or paste relevant sections
• A short description of what the API does
• The main action you want the agent to perform

For example:

• “This API creates a payment link using customer email and amount”
• “This API retrieves membership details based on customer phone number”
• “This API searches products and returns product name, price, and availability”

What to focus on when describing the API

Be specific about:

• What inputs are required (e.g. email, date, product ID)
• What the API returns (e.g. payment link, membership tier, product list)
• What the API is mainly used for in a conversation

This helps the system generate a more accurate schema.

What happens next

• The system reads your API documentation and instructions
• It generates a structured schema
• The schema appears in the right-side panel

This reduces the need to manually define every field.

Review the Playbook command name

After the schema is generated, review the Playbook command name for each endpoint in the right-side panel.

The Playbook command name is used when configuring this API in AgentFlow. Use a clear, recognizable name that describes the action the endpoint performs, such as:

• /create_payment_link
• /get_membership_details
• /search_products.

Use action-based names so it is easy to identify the right command when setting up the AgentFlow playbook later.

Step 3: Review and refine the schema

After the schema is generated, review the fields in the right-side panel before saving the integration.

For each endpoint, check the following sections:

Clear field descriptions help the agent understand how to use the API correctly during a conversation.

Step 4: Define how input values are provided

In the Inputs section, use the Data Source column to choose how each input value should be provided.

In the “Inputs” section, use the Data Source column to choose how each input value should be provided. You can choose “Collect from chat” or “Static value”.

Collect from chat

Select “Collect from chat” when the value should come from the customer during the conversation.

Use this for information that may be different for each customer or request, such as email, booking date, product preference, or order number.

When you use “Collect from Chat”:

1. Make sure the field description clearly explains what information is needed.
2. Update the AgentFlow playbook so the agent knows when to ask the customer for this information.
3. Test the agent to confirm the collected value is mapped to the correct API field.

Static value

Select “Static value” when the same value should be sent every time the API is called.

Use this for fixed values such as a default system parameter, region code, internal flag, or channel identifier.

When you use “Static value”:

1. Enter the fixed value in the “Value” field.
2. Check that the value matches the format required by your API.
3. Save your changes before testing the integration in AgentFlow.

Step 5: Save and publish the integration

Before saving, review the integration details to make sure they are accurate.

Check that:

• the endpoint schema is correct
• each input has the right description and data source
• static values are entered correctly, if used
• output descriptions are clear
• only the right output fields are exposed to AI

When you are ready, click “Save”.

After saving, the Custom API integration becomes available for supported SleekFlow AI modules, such as AgentFlow.

Managing your Custom API integration

You can manage your Custom API integration once it’s added to SleekFlow.

Follow the steps below to manage your Custom API integrations:

1. Click on the  icon on the left navigation bar to go to the SleekFlow AI page
2. In the SleekFlow AI page, click on “Integrations” on the top navigation bar
3. You will be redirected to the “Custom API integration” page, where you will find the Custom API added to your SleekFlow’s workspace
   

Editing Custom API

After creating a Custom API integration, you can update its configuration at any time. This allows you to refine inputs, adjust outputs, or update authentication as your API or use case evolves.

To edit a Custom API:

1. In the Custom API integration dashboard, locate the Custom API you would like to edit
2. Click on the Custom API
3. You will be redirected to the Custom API details page

Updating the Integration name

You can rename your Custom API integration to better reflect its purpose. Use a clear and descriptive name so it is easy to identify when selecting the integration in AgentFlow.

Updating authentication settings

In the “Authentication” section, you can configure or update your API credentials.

• Click “Update key” to modify your API key or bearer token
• Make sure the authentication method matches your API requirements

Changes here affect how all API requests are authorized.

Edit endpoint schema

In the “Endpoint schema section”, you can review the endpoints included in the Custom API integration.

Each endpoint shows the request method, endpoint path, and a short description of what the endpoint does. You can expand an endpoint to review its configuration.

Click “Add / Edit endpoints” to update the endpoint schema, add endpoints, or remove endpoints if your API setup changes.

Update playbook command name

Each endpoint has a Playbook command name.

This is the command name used when configuring the integration in AgentFlow. Use a clear, recognizable name that describes the action, such as /get_available_slots or /create_booking.

If you rename a command that is already used by an agent, review the related AgentFlow setup to make sure the agent still references the correct command.

Edit inputs

In the Inputs section, review the fields that the API needs to receive.

For each input, you can:

• update the description
• choose the “Data source”
• enter a value if the data source is set to Static value

Input descriptions should clearly explain what value is needed. This helps the agent map collected information to the correct API field.

Edit outputs

In the Outputs section, review the fields returned by the API.

For each output, you can:

• update the description
• turn Expose to AI on or off

Turn on Expose to AI for fields the agent should be able to use in customer replies. Turn it off for fields that are not useful for the conversation or should not be shown to the agent.

Review assigned agents

At the bottom of the page, check Assigned agents to see which agents are currently using this integration.

If an agent is listed, you can manage how the integration is used from the agent setup.

Save your changes

After making updates, click “Save changes” at the bottom of the page.

Your updates will apply to the Custom API integration. After saving, review and test any AgentFlow setups that use this integration, especially if you changed command names, inputs, outputs, or exposed fields.

Deleting Custom API

To delete a Custom API:

1. In the Custom API integration dashboard, locate the Custom API you would like to delete
2. Click on the icon next to the Custom API
3. Select “Delete” 
   
4. A warning message will appear. Click “Delete” to confirm the action