spicrawlspicrawlDocs
Browser

Mint a single-use connect URL for /v1/browser Coming soon

Returns a `/v1/browser` URL that carries a short-lived token instead of the API key, for CDP clients that accept only a URL.

Requires scope: browser

POST
/v1/browser/token

Coming soon Returns a /v1/browser URL that carries a short-lived token instead of the API key, for CDP clients that accept only a URL. The key goes in the Authorization header of THIS request only (a query key is refused). The token is single-use, expires after 60 s, and is bound to the options in the body: connect with the URL unchanged. path is authoritative: the URL relative to the API base. url is built from the deployment's SPICRAWL_BROWSER_PUBLIC_URL when set, otherwise from this request's scheme and Host header (caller-controlled, a convenience only). The token is never logged and never stored in plaintext. Requires the browser scope.

Authorization

bearerAuth
AuthorizationBearer <token>

Authorization: Bearer <key>. Read the key from the SPICRAWL_API_KEY environment variable; never hard-code or log it. spicrawl_test_… keys can never spend live credits. Scopes: scrape, batch, sessions (granted by default), browser and read (granted deliberately). A missing scope is 403 ERR::AUTH::INSUFFICIENT_SCOPE naming the scope.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The options GET /v1/browser accepts, validated the same way. All optional.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/browser/token" \  -H "Content-Type: application/json" \  -d '{}'
{  "url": "wss://api.spicrawl.com/v1/browser?proxy_country=de&token=wbt_Q2hhbmdlTWVJbkEtVGVzdC1Ub2tlbi1FeGFtcGxlLVZhbHVlMDE",  "path": "string",  "expires_at": "2019-08-24T14:15:22Z",  "expires_in": 60,  "single_use": true}

Open a Chrome DevTools Protocol WebSocket to a cloud browser Coming Soon GET

A WebSocket upgrade, not a JSON endpoint. Connect with `puppeteer.connect({browserWSEndpoint})` or `chromium.connectOverCDP(url)`.

List recent requests in the key's project, or in every project of its organization GET

Per-request records from the ephemeral request log, newest first, for the API key's project (every key in that project, not only this key).