AI Agent API

Create AI-powered browser automation sessions that execute tasks using natural language instructions.

Create AI Session

POST /api/v1/ai/session
Content-Type: application/json
x-api-key: YOUR_API_KEY

{
  "task": "Go to Amazon.com and find the top-rated wireless mouse under $30",
  "model": "gemini-3-flash",
  "maxIterations": 10,
  "captcha": true,
  "proxyCountry": "US"
}

Parameters

Response

{
  "success": true,
  "data": {
    "sessionId": "ai_session_abc123",
    "status": "running"
  }
}

Check Session Status

GET /api/v1/ai/session/:sessionId
x-api-key: YOUR_API_KEY

Response:

{
  "success": true,
  "data": {
    "sessionId": "ai_session_abc123",
    "status": "completed",
    "result": {
      "success": true,
      "extractedData": { ... },
      "steps": [
        { "action": "navigate", "url": "https://amazon.com", "status": "success" },
        { "action": "type", "selector": "#search", "value": "wireless mouse", "status": "success" },
        { "action": "click", "selector": "#search-btn", "status": "success" }
      ],
      "screenshot": "base64..."
    },
    "creditsUsed": 25,
    "iterations": 5
  }
}

Stream Session Events

GET /api/v1/ai/session/:sessionId/stream
x-api-key: YOUR_API_KEY
Accept: text/event-stream

Returns Server-Sent Events with real-time updates:

event: step
data: {"action": "navigate", "url": "https://amazon.com"}

event: step
data: {"action": "type", "selector": "#search", "value": "wireless mouse"}

event: complete
data: {"result": {...}}

Convert to Workflow

POST /api/v1/ai/session/:sessionId/convert
x-api-key: YOUR_API_KEY

Converts a completed AI session into a reusable workflow.

Available Models

Credit Calculation

Total = 5 (base) + (maxIterations x creditsPerIteration) + (captcha ? 3 : 0)