مرجع API

Base URL: https://browserip.com. احراز هویت: اول با POST /api/auth/login وارد شوید تا سرور کوکی sid بدهد و در درخواست‌های بعدی کوکی را بفرستید. همچنین می‌توانید از کلیدی که در صفحه «API Keys» کنسول ساخته می‌شود استفاده کنید: سربرگ Authorization: Bearer bip_… و بدون نیاز به کوکی (کلید فقط یک بار نمایش داده می‌شود، پس آن را خوب نگه دارید).

روشن‌کردن POST /api/sessions/

curl -b cookies.txt -X POST https://browserip.com/api/sessions/ \
  -H 'Content-Type: application/json' -d '{}'

موفقیت (جایگاه خالی موجود است) ← 200:

{
  "session": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "ready",
    "region": "default",
    "token": "…",
    "cdp_url": "https://browserip.com/s/123e4567-e89b-12d3-a456-426614174000/…",
    "view_url": "/view/123e4567-e89b-12d3-a456-426614174000/…",
    "created_at": "2026-10-19T00:00:00.000Z",
    "last_activity": "2026-10-19T00:00:00.000Z"
  }
}

جایگاه خالی نیست و مقیاس‌دهی فعال شده ← 202 {"session": {...}, "queue_position": 1} (با GET /api/sessions/:id نظرسنجی کنید تا status به ready برسد). خطاها: 402 insufficient_credits (موجودی ناکافی)، 429 too_many_sessions، 503 no_capacity.

مشاهده نشست GET /api/sessions/:id

{"session": {"id": "123e4567-e89b-12d3-a456-426614174000", "status": "ready", "cdp_url": "https://browserip.com/s/123e4567-e89b-12d3-a456-426614174000/…", …}}

خاموش‌کردن DELETE /api/sessions/:id

curl -b cookies.txt -X DELETE https://browserip.com/api/sessions/123e4567-e89b-12d3-a456-426614174000
→ {"ok": true}

مشاهده اطلاعات کاربر GET /api/auth/me

{"user": {"id": "u_x", "email": "[email protected]", "hours": 4.5, "credits": 0, "account_type": "personal", "credit_rate_per_hour": null, "is_admin": false, "created_at": "…"}} 

بررسی موجودی GET /api/billing/balance

موجودی فعلی را برمی‌گرداند: برای کاربران شخصی hours (ساعت) و برای کاربران سازمانی/مدیر credits، همراه با account_type و نرخ سازمانی credit_rate_per_hour.