API Documentation

​

Account Quota API

​

Endpoint

• URL: /api/account/quota
• Method: GET

​

Request

• Headers:
  • x-api-key (string, required): The API key for authentication.

​

Response

• 200 OK:
  • Description: Quota details retrieved successfully.
  • Body:
    Copy

    {
      "success": true,
      "result": {
        "total_quota": 1000,
        "quota_used": 500,
        "quota_remaining": 500,
        "plan_name": "basic"
      }
    }
    
• 400 Bad Request:
  • Description: Invalid API key.
  • Body:
    Copy

    {
      "success": false,
      "message": "Invalid API key"
    }
    
• 500 Internal Server Error:
  • Description: Internal server error.
  • Body:
    Copy

    {
      "success": false,
      "message": "Internal server error"
    }
    

​

Capture Screenshot Route

​

Endpoint

• URL: /api/capture-screenshot
• Method: POST

​

Request

• Headers:
  • x-api-key (string, required): The API key for authentication.
• Body:
  • Params (object, required): Parameters for capturing the screenshot.

​

Response

• 200 OK:
  • Description: Screenshot captured successfully.
  • Body:
    Copy

    {
      "pageResourceSizeinKB": 1000,
      "screenshotUrl": "https://example.com/screenshot.png",
      "statusCode": 200,
      "success": true,
      "taskDurationSec": 1.5
    }
    
• 400 Bad Request:
  • Description: Invalid request.
  • Body:
    Copy

    {
      "error": 400,
      "message": "Bad request"
    }
    
• 401 Unauthorized:
  • Description: Unauthorized.
  • Body:
    Copy

    {
      "error": 401,
      "message": "Unauthorized"
    }
    
• 403 Forbidden:
  • Description: Forbidden.
  • Body:
    Copy

    {
      "error": 403,
      "message": "Forbidden"
    }
    
• 500 Internal Server Error:
  • Description: Internal server error.
  • Body:
    Copy

    {
      "error": 500,
      "message": "Internal server error"
    }