Developer Documentation

POST https://data.oktagonapp.com/api/chat-enhanced

Content-Type: application/json

{
  "messages": [
    {
      "role": "user",
      "content": "I need a navy blue suit for a business meeting. What do you recommend?"
    }
  ],
  "model": "gpt-4o",
  "temperature": 0.2,
  "systemPrompt": "You are a helpful clothing store assistant. Help customers find the right clothing items.",
  "max_tokens": 1000,
  "top_p": 1,
  "user_id": "[userId]",
  "agent_id": "[agentId]",
  "sessionId": "store-session-123",
  "enableActions": true
}

{
  "messages": [
    {
      "role": "user",
      "content": "Review John Doe's vitals and suggest next steps."
    }
  ],
  "user_id": "patient-123",
  "agent_id": "health-agent-1"
}

{
  "choices": [
    {
      "delta": {
        "content": "I don't have that information in my knowledge base. However, I can suggest using available tools or resources to find recommendations for a navy blue suit suitable for a business meeting."
      }
    }
  ],
  "ragEnabled": true,
  "actionsEnabled": true
}

GET https://data.oktagonapp.com/api/actions?agentId=[agentId]&userId=[userId]

GET https://data.oktagonapp.com/api/actions?agentId=[agentId]&userId=[userId]&actionId=clothing-recommendations

POST https://data.oktagonapp.com/api/actions

{
  "actionId": "clothing-recommendations",
  "name": "Get Clothing Recommendations",
  "description": "Get personalized clothing recommendations based on customer preferences and style",
  "whenToUse": "Use this action when customers ask for clothing recommendations, style advice, outfit suggestions, or want to find specific clothing items.",
  "inputs": [
    {
      "name": "category",
      "type": "string",
      "description": "Clothing category (suits, shirts, pants, jackets, shoes, accessories)",
      "required": true
    },
    {
      "name": "color",
      "type": "string",
      "description": "Preferred color",
      "required": false
    },
    {
      "name": "size",
      "type": "string",
      "description": "Size preference",
      "required": false
    },
    {
      "name": "occasion",
      "type": "string",
      "description": "Occasion (business, casual, formal, weekend)",
      "required": false
    },
    {
      "name": "maxPrice",
      "type": "number",
      "description": "Maximum price budget",
      "required": false
    }
  ],
  "apiRequest": {
    "method": "POST",
    "url": "https://data.oktagonapp.com/api/inventory",
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "category": "{{category}}",
      "color": "{{color}}",
      "size": "{{size}}",
      "occasion": "{{occasion}}",
      "maxPrice": "{{maxPrice}}"
    }
  },
  "dataAccess": "limited",
  "enabled": true,
  "agentId": "[agentId]",
  "userId": "[userId]"
}

{
  "actionId": "clothing-recommendations",
  "agentId": "[agentId]",
  "userId": "[userId]",
  "sessionId": "store-session-123",
  "inputs": {
    "category": "suits",
    "color": "navy"
  }
}

{
  "actions": [
    {
      "id": "weather-api",
      "name": "Get Weather",
      "description": "Get current weather information for any city",
      "whenToUse": "Use this action when users ask about weather conditions, temperature, or weather forecasts for specific cities or locations.",
      "inputs": [
        {
          "name": "city",
          "type": "string",
          "description": "The city name to get weather for",
          "required": true
        }
      ],
      "apiRequest": {
        "method": "GET",
        "url": "https://wttr.in/{{city}}?format=j1",
        "headers": {
          "User-Agent": "Oktagon-AI-Agent"
        }
      },
      "dataAccess": "full",
      "enabled": true,
      "createdAt": "[timestamp]",
      "updatedAt": "[timestamp]"
    }
  ]
}

PUT https://data.oktagonapp.com/api/actions

DELETE https://data.oktagonapp.com/api/actions

{
  "error": "Internal server error",
  "message": "Action test-weather-api not found"
}

POST https://data.oktagonapp.com/api/crawl

{
  "url": "https://example.com",
  "includePaths": "/products/*,/blog/*",
  "excludePaths": "/admin/*,/private/*",
  "slowScraping": false,
  "maxDepth": 2,
  "maxPages": 10
}

{
  "success": true,
  "data": {
    "pages": [
      {
        "url": "https://example.com",
        "title": "Example Domain",
        "content": "Example Domain This domain is for use in illustrative examples in documents. You may use this domain in literature without prior coordination or asking for permission. More information...",
        "products": []
      }
    ],
    "products": [],
    "links": [],
    "totalPages": 1,
    "totalProducts": 0,
    "totalLinks": 0,
    "crawledAt": "[timestamp]"
  }
}

GET https://data.oktagonapp.com/api/agents/[agentId]

{
  "agent": {
    "id": "[agentId]",
    "name": "Clothing Store Assistant",
    "description": "AI assistant for clothing store customer service",
    "status": "active",
    "chatWidth": "360px",
    "theme": "light",
    "initialMessage": "Hi there!",
    "messagePlaceholder": "Type your message...",
    "suggestedMessages": [
      "Do you have navy suits?",
      "What sizes are available?"
    ],
    "createdAt": "[timestamp]",
    "updatedAt": "[timestamp]"
  }
}

Authorization: Bearer <Your-API-Key>

npm install @oktagon/sdk

import { OktagonClient } from '@oktagon/sdk';

const client = new OktagonClient({
  apiKey: 'your-api-key',
  baseUrl: 'https://data.oktagonapp.com'
});

// Send a message
const response = await client.chat.sendMessage({
  message: 'Hello!',
  agentId: 'your-agent-id',
  userId: 'user-123'
});

console.log(response.message);

<script src="https://data.oktagonapp.com/embed.js"></script>
<script>
  Oktagon.init({
    agentId: 'your-agent-id',
    userId: 'user-123',
    theme: 'light'
  });
</script>