API Docs

Authorization: YOUR_API_KEY

{
  "messages": "Hello, I have a question about my order",
  "thread_id": "thread_123456",  // Optional
  "callback_url": "https://your-domain.com/webhook"  // Optional
}

{
  "messages": {
    "role": "user",
    "content": "Hello, I have a question about my order"
  },
  "thread_id": "thread_123456",  // Optional
  "callback_url": "https://your-domain.com/webhook"  // Optional
}

{
  "messages": [
    {
      "role": "user",
      "content": "Hello, I have a question about my order"
    }
  ],
  "thread_id": "thread_123456",  // Optional
  "callback_url": "https://your-domain.com/webhook"  // Optional
}

{
  "statusCode": 200,
  "body": {
    "agent_id": "agent_123abc",
    "conversation_history": [
      {
        "role": "user",
        "content": "Hello, I have a question about my order"
      },
      {
        "role": "assistant",
        "content": "I'd be happy to help with your order. Could you please provide your order number?"
      }
    ],
    "metadata": {
      "id": "meta_xyz789",
      "model": "gpt-4",
      "timestamp": "2024-03-21T14:30:00Z",
      "tool_calls": {},
      "execution_time": 2500,
      "used_credits": 1,
      "thread_id": "thread_123456"
    }
  }
}

{
  "statusCode": 402,
  "body": {
    "agent_id": "agent_123abc",
    "message": "No credits available",
    "error": "No credits available"
  }
}

{
  "statusCode": 503,
  "body": {
    "agent_id": "agent_123abc",
    "message": "Service temporarily unavailable",
    "error": "AI provider is currently experiencing high traffic"
  }
}

{
  "statusCode": 500,
  "body": {
    "error": "An unexpected error occurred while processing your request"
  }
}

{
  "message": "Request accepted and being processed asynchronously",
  "status": "processing"
}

Authorization: YOUR_API_KEY

// Default (last 7 days)
GET /api/public/agent/66a72b17-cb03-4397-ab2a-1eef13847737/usage

// Custom date range (both dates)
GET /api/public/agent/66a72b17-cb03-4397-ab2a-1eef13847737/usage?start_date=2025-05-20&end_date=2025-05-26

// Start date only (end_date will be yesterday)
GET /api/public/agent/66a72b17-cb03-4397-ab2a-1eef13847737/usage?start_date=2025-05-20

{
  "agent_id": "66a72b17-cb03-4397-ab2a-1eef13847737",
  "time_range": {
    "start": "2025-05-20T00:00:00.000Z",
    "end": "2025-05-26T23:59:59.999Z"
  },
  "usage": {
    "total_credits_used": 3,
    "daily_breakdown": [
      {
        "date": "2025-05-26",
        "credits_used": 1
      },
      {
        "date": "2025-05-25",
        "credits_used": 0
      },
      {
        "date": "2025-05-24",
        "credits_used": 2
      },
      {
        "date": "2025-05-23",
        "credits_used": 0
      },
      {
        "date": "2025-05-22",
        "credits_used": 0
      },
      {
        "date": "2025-05-21",
        "credits_used": 0
      },
      {
        "date": "2025-05-20",
        "credits_used": 0
      }
    ]
  },
  "note": "Endpoint active from 28 May 2025 onwards"
}

// Missing API Key (401)
{
  "error": "API key is required",
  "message": "Please provide an API key in the Authorization header"
}

// Invalid API Key (401)
{
  "error": "Invalid API key",
  "message": "The provided API key is not valid"
}

// Access Denied (403)
{
  "error": "Access denied",
  "message": "This agent does not belong to your organisation"
}

// Invalid Agent ID (400)
{
  "error": "agent_id is required and must be a non-empty string"
}

// Missing Start Date When End Date Provided (400)
{
  "error": "Invalid date range",
  "message": "start_date is required when end_date is provided (format: YYYY-MM-DD)"
}

// Invalid Date Format (400)
{
  "error": "Invalid date format",
  "message": "Dates must be in YYYY-MM-DD format"
}

// Invalid Dates (400)
{
  "error": "Invalid dates",
  "message": "Provided dates are not valid"
}

// Start Date After End Date (400)
{
  "error": "Invalid date range",
  "message": "start_date must not be after end_date"
}

// End Date Too Recent (400)
{
  "error": "Invalid end date",
  "message": "end_date cannot be today or in the future. Data is only available up to yesterday."
}

// Date Range Too Large (400)
{
  "error": "Date range too large",
  "message": "Date range cannot exceed 31 days"
}

// Internal Server Error (500)
{
  "error": "Internal server error"
}

Authorization: YOUR_API_KEY

{
  "recipient_phone_number": "31612345678",
  "template_name": "order_update",
  "language": "en_US",
  "customer_name": "John Doe",
  "parameters": [
    {
      "type": "header",
      "parameters": [
        {
          "type": "image",
          "image": {
            "link": "https://whatsapp_image_template"
          }
        }
      ]
    },
    {
      "type": "body",
      "parameters": [
        {
          "type": "text",
          "text": "ABC123"
        },
        {
          "type": "text",
          "text": "Shipped"
        }
      ]
    }
  ]
}

{
  "messaging_product": "whatsapp",
  "contacts": [{
      "input": "PHONE_NUMBER",
      "wa_id": "WHATSAPP_ID"
    }],
  "messages": [{
      "id": "wamid.ID"
    }]
}

{
  "error": "Invalid API key",
  "message": "The provided API key is not valid"
}

{
  "error": "Missing required fields",
  "message": "recipient_phone_number and template_name are required"
}

{
  "error": "WhatsApp connection not found",
  "message": "No WhatsApp connection found for this agent"
}

{
  "error": "Internal server error"
}

Authorization: YOUR_API_KEY

{
  "content": "string",
  "name": "string",
  "agent_ids": ["uuid"] | "uuid",
  "description_to_index_on": "string"  // Optional
}

curl -X POST "https://flowgent.ai/api/public/knowledge" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Our premium support includes 24/7 chat, phone support, and dedicated account management.",
    "name": "Premium Support Information",
    "agent_ids": ["agent-uuid-1"],
    "description_to_index_on": "Premium support features and benefits"
  }'

{
  "id": "item-uuid-123",
  "name": "Premium Support Information",
  "created_at": "2023-12-29T10:00:00Z",
  "updated_at": "2023-12-29T10:00:00Z",
  "source": "api",
  "linked_agents": ["agent-uuid-1"]
}

// Missing API Key (401)
{
  "error": "API key is required",
  "message": "Please provide an API key in the Authorization header"
}

// Invalid API Key (401)
{
  "error": "Invalid API key",
  "message": "The provided API key is not valid"
}

// Missing Content (400)
{
  "error": "content is required and must be a non-empty string"
}

// Missing Agent IDs (400)
{
  "error": "agent_ids is required and must be a non-empty string or array"
}

// Content Too Long (400)
{
  "error": "Content exceeds character limit",
  "message": "The content field must be 4000 characters or less."
}

// Invalid Agent ID (403)
{
  "error": "Access denied",
  "message": "One or more agents do not belong to your organisation"
}

// Usage Limit Reached (402)
{
  "error": "Usage limit reached",
  "message": "You have reached the maximum number of items in one of your knowledge bases. Please upgrade your plan to add more items.",
  "minimalPlan": "..."
}

// Internal Server Error (500)
{
  "error": "Internal server error"
}

Authorization: YOUR_API_KEY

curl -X GET "https://flowgent.ai/api/public/knowledge?page=1&limit=10" \
  -H "Authorization: YOUR_API_KEY"

{
  "knowledge_items": [
    {
      "id": "item-uuid-123",
      "name": "Premium Support Information",
      "created_at": "2023-12-29T10:00:00Z",
      "updated_at": "2023-12-29T10:00:00Z",
      "source": "api",
      "linked_agents": ["agent-uuid-1"]
    }
  ],
  "pagination": {
    "current_page": 1,
    "limit": 10,
    "total_count": 1,
    "total_pages": 1,
    "has_next_page": false,
    "has_previous_page": false
  }
}

// Missing API Key (401)
{
  "error": "API key is required",
  "message": "Please provide an API key in the Authorization header"
}

// Invalid API Key (401)
{
  "error": "Invalid API key",
  "message": "The provided API key is not valid"
}

// Invalid Agent ID (403)
{
  "error": "Access denied",
  "message": "Agent does not belong to your organisation"
}

// Invalid Pagination (400)
{
  "error": "Invalid pagination parameters",
  "message": "Page must be a positive integer and limit must be between 1 and 100"
}

// Internal Server Error (500)
{
  "error": "Internal server error"
}

Authorization: YOUR_API_KEY

curl -X GET "https://flowgent.ai/api/public/knowledge/item-uuid-123" \
  -H "Authorization: YOUR_API_KEY"

{
  "id": "item-uuid-123",
  "name": "Premium Support Information",
  "content": "Our premium support includes 24/7 chat, phone support, and dedicated account management.",
  "created_at": "2023-12-29T10:00:00Z",
  "updated_at": "2023-12-29T10:00:00Z",
  "source": "api",
  "linked_agents": ["agent-uuid-1"]
}

// Missing API Key (401)
{
  "error": "API key is required",
  "message": "Please provide an API key in the Authorization header"
}

// Invalid API Key (401)
{
  "error": "Invalid API key",
  "message": "The provided API key is not valid"
}

// Knowledge Item Not Found (404)
{
  "error": "Knowledge item not found or access denied"
}

// Internal Server Error (500)
{
  "error": "Internal server error"
}

Authorization: YOUR_API_KEY

{
  "name": "string",
  "content": "string",
  "agent_ids": ["uuid"] | "uuid",
  "description_to_index_on": "string"
}

curl -X PATCH "https://flowgent.ai/api/public/knowledge/item-uuid-123" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Premium Support Information",
    "content": "Our premium support now includes 24/7 chat, phone support, dedicated account management, and priority bug fixes.",
    "agent_ids": ["agent-uuid-1", "agent-uuid-2"]
  }'

{
  "id": "item-uuid-123",
  "name": "Updated Premium Support Information",
  "created_at": "2023-12-29T10:00:00Z",
  "updated_at": "2023-12-29T10:00:00Z",
  "source": "api",
  "linked_agents": ["agent-uuid-1", "agent-uuid-2"]
}

// Missing API Key (401)
{
  "error": "API key is required",
  "message": "Please provide an API key in the Authorization header"
}

// Invalid API Key (401)
{
  "error": "Invalid API key",
  "message": "The provided API key is not valid"
}

// Knowledge Item Not Found (404)
{
  "error": "Knowledge item not found or access denied"
}

// Invalid Agent ID (403)
{
  "error": "Access denied",
  "message": "One or more agents do not belong to your organisation"
}

// Content Too Long (400)
{
  "error": "Content exceeds character limit",
  "message": "The content field must be 4000 characters or less."
}

// Invalid JSON Body (400)
{
  "error": "Invalid JSON body",
  "message": "Unexpected token } in JSON at position 123"
}

// Validation Error (400)
{
  "error": "Validation failed",
  "message": "If provided, \"name\" must be a non-empty string."
}

// Internal Server Error (500)
{
  "error": "Internal server error"
}

Authorization: YOUR_API_KEY

curl -X DELETE "https://flowgent.ai/api/public/knowledge/item-uuid-123" \
  -H "Authorization: YOUR_API_KEY"

{
  "message": "Knowledge item deleted successfully"
}

// Missing API Key (401)
{
  "error": "API key is required",
  "message": "Please provide an API key in the Authorization header"
}

// Invalid API Key (401)
{
  "error": "Invalid API key",
  "message": "The provided API key is not valid"
}

// Knowledge Item Not Found (404)
{
  "error": "Knowledge item not found or access denied"
}

// Internal Server Error (500)
{
  "error": "Internal server error"
}