Get one session's metadata
Returns the session's metadata and a non-secret context summary.
Requires scope: sessions
Returns the session's metadata and a non-secret context summary. Never returns cookies, and does not
slide the TTL, so it is safe to poll. Released and expired sessions are still returned (200) with
their status; only a deleted or unknown session is 404. A malformed id also answers 404
ERR::SESSION::NOT_FOUND.
Authorization
bearerAuth 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
Path Parameters
Session id from POST /v1/sessions (26-character ULID; a UUID is also accepted). A malformed id answers 404 ERR::SESSION::NOT_FOUND, the same as an unknown one.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/sessions/01J9ZQ4M7R3T8VX2K5N6P0B1CD"{ "id": "01J9ZQ4M7R3T8VX2K5N6P0B1CD", "project_id": "string", "engine": "fetch", "status": "active", "sticky_key": "string", "proxy": { "tier": "none", "country": "string", "region_pool": "string" }, "created_at": "2019-08-24T14:15:22Z", "last_used_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "hard_expires_at": "2019-08-24T14:15:22Z", "released_at": "2019-08-24T14:15:22Z", "usage_count": 0, "context": { "schema_version": 0, "cookies": 0, "origins": 0, "bytes": 0 }, "retired": "expired", "domain_scores": { "property1": { "score": 0, "good": 0, "bad": 0, "last_updated": 0, "retired": true }, "property2": { "score": 0, "good": 0, "bad": 0, "last_updated": 0, "retired": true } }, "fingerprint": {}, "lease": { "holder": "string", "expires_at": "2019-08-24T14:15:22Z" }, "warnings": [ "string" ]}Create a persisted browser session POST
Creates a session: a sealed cookie jar and web-storage snapshot, pinned to one engine and one exit intent, that you reuse by passing its `id` as `session_id` on `/v1/scrape`.
Delete a session and its context DELETE
Removes the session row and purges its context permanently. Unlike release, the id stops resolving afterwards.