Overview

Sigma Domain allows you to import external API integrations (tools) that extend the platform's capabilities. Once imported, these tools become available as functions you can call from the chat.

How Tool Import Works

Tools in Sigma Domain are backed by API endpoints. When you import a tool:

1. The system crawls the API documentation
2. It discovers available endpoints and their parameters
3. Each endpoint becomes a callable function in the platform
4. You can then use these functions through natural language or direct execution

Step-by-Step: Import a Tool

Method 1: Ask the AI

1. Type in chat: "Import the [service name] API" (e.g., "Import the Twilio API")
2. The AI will search for the API documentation
3. It will present the discovered endpoints for confirmation
4. Click Confirm to import the tool

Method 2: Provide an API Documentation URL

1. Type: "Import this API: [documentation URL]"
2. The system will crawl the provided URL
3. Discovered endpoints will be shown for review
4. Confirm to complete the import

Method 3: Use the Jobs System

1. Start a new job by saying "Create a job to import the [service] API"
2. The job will handle the full import process including:
   • API discovery
   • Endpoint extraction
   • Parameter mapping
   • Authentication setup

What Happens During Import

API Crawling

• The system reads the API documentation page
• It identifies REST endpoints (GET, POST, PUT, DELETE)
• It extracts parameter definitions, types, and descriptions
• It maps authentication requirements

Function Creation

• Each API endpoint becomes a function with:
  • A descriptive name (e.g., "twilio-createmessage")
  • Parameter definitions with types and descriptions
  • Required vs. optional parameter marking
  • Authentication configuration

Bundle Organization

• Related endpoints are grouped into a bundle (e.g., all Twilio endpoints)
• The bundle appears as a single tool with sub-functions
• You can browse sub-functions to see specific capabilities

Authentication Setup

After importing a tool, you may need to configure authentication:

API Key Authentication

1. Go to the tool's settings
2. Enter your API key in the designated field
3. The key is stored securely and used for all requests to that API

OAuth2 Authentication

1. Click Connect on the tool
2. You'll be redirected to the service's authorization page
3. Grant permissions and you'll be redirected back
4. The OAuth token is stored and refreshed automatically

Bearer Token

1. Enter your bearer token in the tool's auth settings
2. The token is included in the Authorization header for requests

After Import: Using Your Tools

Once imported, tools are available immediately:

• Natural language: "Send a Twilio SMS to 555-1234 saying Hello"
• Function selection: The AI will suggest relevant tools when it detects your intent
• Direct execution: Browse your imported tools in the tools panel

Managing Imported Tools

View Imported Tools

• Ask: "What tools do I have imported?"
• Or browse the function catalog in the sidebar

Update a Tool

• Re-import to pick up new endpoints
• Authentication credentials are preserved

Remove a Tool

• Ask: "Remove the [tool name] integration"
• This deletes all associated functions and stored credentials

Troubleshooting

Import Fails

• Check that the API documentation URL is accessible
• Ensure the API docs are in a standard format (OpenAPI/Swagger preferred)
• Try providing a more specific documentation URL

Authentication Errors

• Verify your API key or token is correct
• Check that the key has the necessary permissions/scopes
• For OAuth, try disconnecting and reconnecting

Function Not Working

• Check the tool's execution history for error details
• Verify required parameters are being provided
• Ensure your API account is active and has available quota