External Api Connector

📸 Screenshots

Here are visual examples of this section:

External Api Connector - Worker Configuration Interface

The External API Connector transforms any HTTP endpoint into an agent-callable tool with full schema validation, authentication, and error handling. It supports multiple authentication methods, rate limiting, and automatic retries for robust API integration. This worker is deprecated but still functional for existing workflows.

2. Configuration Parameters

toolName: Name of the tool that agents will use to call this API (defaults to "external_api")
toolDescription: Description of what this API tool does for agent context
endpoint: The HTTP endpoint URL to call, supports path parameters with {paramName} syntax
method: HTTP method to use (GET, POST, PUT, PATCH, DELETE)
params: Static JSON parameters to include with every request
paramsSchema: JSON array defining the parameter schema for agent tool calls
headers: JSON object of HTTP headers to include with requests
timeout: Request timeout in milliseconds (default: 10000)
authType: Authentication method (none, basic, bearer, api_key, oauth2_client_credentials)
username: Username for basic authentication
selectedKeyName: Name of the stored API key to use for authentication
oauth2TokenUrl: Token endpoint URL for OAuth 2.0 client credentials flow
oauth2ClientId: Client ID for OAuth 2.0 authentication
oauth2Scope: OAuth 2.0 scope string (optional)
rateLimitPerMinute: Maximum requests per minute (default: 60)
maxRetries: Number of retry attempts for failed requests (0-5, default: 2)

3. Input/Output Handles

tool: Input handle - accepts tool configuration for agent use
response: Output handle - returns successful API response data
error: Output handle - returns error messages when requests fail

4. Usage Examples with Code

// Example parameter schema for a weather API tool
[
  {
    "name": "city",
    "type": "string", 
    "description": "City name to get weather for",
    "required": true
  },
  {
    "name": "units",
    "type": "string",
    "description": "Temperature units (metric or imperial)",
    "required": false
  }
]

// Endpoint with path parameter
// https://api.weather.com/v1/weather/{city}

5. Integration Examples

This worker enables agents to interact with any REST API by converting endpoints into structured tools. It's commonly used for integrating CRM systems, data APIs, and third-party services into agent workflows.

6. Best Practices

Define clear parameter schemas to help agents understand required vs optional fields
Use appropriate rate limiting to respect API quotas and avoid being blocked
Set reasonable timeouts based on the API's typical response times
Store sensitive credentials using the key management system rather than hardcoding

7. Troubleshooting Tips

Check that the endpoint URL is accessible and returns expected status codes
Verify authentication credentials are correctly stored and referenced by key name
Monitor rate limit settings if receiving 429 Too Many Requests errors
Review parameter schema format if agents aren't calling the tool correctly