​
Tool Configuration

While the AI Tool Creator can automatically generate tool configurations, you may want to manually configure or fine-tune your tools. This guide explains the different configuration options available for Popcorn AI tools.

​
Basic Configuration

Every tool in Popcorn requires the following basic configuration:

FieldDescription
NameA descriptive name for your tool
DescriptionA clear explanation of what the tool does
HTTP MethodThe HTTP method to use (GET, POST, PUT, DELETE, etc.)
URLThe endpoint URL for the API call

​
Request Configuration

​
Headers

Headers are key-value pairs sent with the API request. Common headers include:

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_KEY"
}

To add a header:

  1. Click “Add Header”
  2. Enter the header key (e.g., “Content-Type”)
  3. Enter the header value (e.g., “application/json”)

​
Query Parameters

Query parameters are appended to the URL in the format ?param1=value1&param2=value2. For each query parameter, you can configure:

  • Name: The parameter name
  • Type: The data type (string, number, boolean, etc.)
  • Required: Whether the parameter is required
  • Description: What the parameter does

​
Body Parameters

Body parameters are sent in the request body for methods like POST, PUT, and PATCH. Popcorn supports nested parameter structures for complex APIs.

For each body parameter, you can configure:

  • Name: The parameter name
  • Type: The data type (string, number, boolean, object, array)
  • Required: Whether the parameter is required
  • Description: What the parameter does

For nested parameters (objects and arrays), you can add child parameters by clicking “Add Child Parameter”.

​
Advanced Configuration

​
Path Parameters

Path parameters are parts of the URL path that can change, such as IDs. They are specified in the URL using curly braces:

https://api.example.com/users/{userId}/posts/{postId}

Popcorn automatically detects path parameters from the URL pattern and adds them to the parameter list.

​
Authentication

For APIs that require authentication, you can add the necessary authentication headers:

  • API Key: Add an “Authorization” header with your API key
  • OAuth: Add a “Bearer” token in the Authorization header
  • Basic Auth: Add a base64-encoded username:password in the Authorization header

​
Best Practices

  • Clear Descriptions: Write clear descriptions for your tool and its parameters
  • Parameter Validation: Set appropriate types and required flags for parameters
  • Error Handling: Test your tool with various inputs to ensure it handles errors gracefully
  • Security: Never hardcode sensitive information like API keys in the tool configuration

​
Next Steps

After configuring your tool: