API Documentation

Integrate Zen Bypass into your apps, bots, and workflows.

⚠️ Note: This is a demo deployment. API keys are not yet available for public use. The endpoints below show the planned API structure.

Authentication

API requests require an API key passed in the X-API-Key header or api_key body field.

# Header authentication
X-API-Key: zen_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
            

Bypass a Link

POST /api/bypass

Submit a URL to bypass. Returns the destination URL if successful.

Request Body

Parameter	Type	Required	Description
`url`	string	Yes	The link to bypass
`api_key`	string	No	Your API key (skips captcha)
`recaptcha_token`	string	Conditional	reCAPTCHA token (required without API key)

// Request
POST /api/bypass HTTP/1.1
Content-Type: application/json
X-API-Key: zen_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

{
  "url": "https://linkvertise.com/xxx"
}
                

// Success Response (200)
{
  "success": true,
  "result": "https://example.com/destination",
  "service": "linkvertise",
  "original": "https://linkvertise.com/xxx"
}
                

// Error Response (200, success: false)
{
  "success": false,
  "error": "Unsupported provider or link expired",
  "service": "unknown"
}
                

Health Check

GET /api/health

Check if the service is operational.

// Response
{
  "status": "ok"
}
                

Supported Services

GET /api/services

List all supported bypass providers.

// Response
{
  "services": [
    { "id": "linkvertise", "name": "Linkvertise", "supported": true },
    { "id": "workink", "name": "Work.ink", "supported": true },
    { "id": "platoboost", "name": "Platoboost", "supported": false, "reason": "Requires verification tasks" }
  ]
}
                

Rate Limits

Without an API key, requests are rate-limited to 10 requests per minute per IP address.

With an API key, limits scale with your plan. Contact us for higher-volume access.