API ReferenceIntroduction
Using the API
Introduction
BuildE2E API Reference (v1)
Features
Fetch
Extract content from any webpage in markdown or JSON format.Generate PDF
Generate PDFs from HTML content or any URL.Execute Code
Run code securely in isolated Code Sandbox environments.Base URL
All API requests should be made to:
https://api.builde2e.com/api/v1
Authentication
All API requests require authentication via an API key. Include your API key in the request header:
Authorization: Bearer uc-YOUR-API-KEY
Alternatively, you can use the
x-api-key header:x-api-key: uc-YOUR-API-KEY
Response Codes
The API uses standard HTTP status codes to indicate success or failure:
| Code | Description |
|---|---|
| 200 | Successful operation |
| 201 | Resource created (Browser Sandbox sessions) |
| 400 | Bad Request - Invalid request parameters |
| 401 | Unauthorized - Missing or invalid API key |
| 402 | Payment Required - Insufficient wallet balance |
| 403 | Forbidden - Access denied to this resource |
| 404 | Not Found - Resource does not exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |
| 503 | Service Unavailable - No capacity available |
Rate Limits
Rate limits are enforced per API key, per endpoint:
| Endpoint | Limit |
|---|---|
/v1/scrape/single | 10 requests/second |
/v1/scrape/batch | 5 requests/second |
/v1/search | 10 requests/second |
/v1/pdf/* | 10 requests/second |
/v1/code-sandbox/execute | 10 requests/second |
/v1/browser-sandbox/* | 10 requests/second |
When you exceed the rate limit, you will receive a 429 response. The response headers include:
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1706745600
Retry-After: 1
Endpoints
POST
/v1/scrape/singleFetch a single URL
POST
/v1/scrape/batchFetch multiple URLs
POST
/v1/pdf/htmlGenerate PDF from HTML
POST
/v1/pdf/urlGenerate PDF from URL
POST
/v1/code-sandbox/executeExecute code in Code Sandbox
POST
/v1/browser-sandbox/sessionCreate Browser Sandbox session
GET
/v1/browser-sandbox/session/:idGet session details
DELETE
/v1/browser-sandbox/session/:idClose Browser Sandbox session
POST
/v1/browser-sandbox/session/:id/resumeResume Browser Sandbox session