Documentation

Introduction

Welcome to the MeshPrivacy API documentation. Our platform provides a standardized interface for interacting with complex WAF challenges and bot protection systems programmatically.

The Task Lifecycle

All interactions with MeshPrivacy follow an asynchronous Task Lifecycle to ensure reliability and scalability.

1. Create Task

Submit your request (URL, service type, payload) via POST /tasks/submit.

2. Wait for Processing

The system processes your request. Poll the /tasks/result endpoint.

3. Get Result

Receive the solution token (e.g., cookie, captcha key) to use in your client.

Example: Creating a Task

💡

Pro Tip: Don't construct JSON manually. Go to the Playground, configure your service, and click Copy Post Data.

# 1. Submit Task
curl -X POST https://api.meshprivacy.com/v1/tasks/submit \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "service": "akamai", 
    "url": "https://target.com"
  }'

# Response:
# { "task_id": "...", "status": "processing" }

# 2. Poll Result
curl https://api.meshprivacy.com/v1/tasks/result/TASK_ID \
  -H "x-api-key: YOUR_API_KEY"

Check Balance

Check your current credit balance before submitting tasks. This helps you ensure you have enough credits for your requests.

curl https://api.meshprivacy.com/v1/billing/balance \
  -H "x-api-key: YOUR_API_KEY"

# Response:
# {
#   "total_credits": 9860.00,
#   "api_keys": [
#     { "api_key": "2d24bb8c...", "is_active": true, "created_at": "..." }
#   ]
# }

Authentication

MeshPrivacy uses API keys to allow access to the API. You can register a new API key at our API Keys Page.

Authentication to the API is performed via the x-api-key header.

curl "https://api.meshprivacy.com/v1/..." \
  -H "x-api-key: YOUR_API_KEY"

Error Codes

Code	Description
400	Bad Request - Missing required fields.
401	Unauthorized - Invalid or missing API key.
402	Payment Required - Insufficient credits.
429	Too Many Requests - Rate limit exceeded.
500	Internal Error - Something went wrong.