Get a recording frame
Works with the console cookie, so <img src> can show it.
GET
/v1/sessions/{id}/recording/frames/{index}Request
| Method and path | GET/v1/sessions/{id}/recording/frames/{index} |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | Your API key in the x-api-key header (or Authorization: Bearer). The examples read it from BOXLINE_API_KEY. |
Path parameters
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
idrequired | string | – | – | |
indexrequired | integer | – | – | At least 0. |
curl "https://api.boxline.dev/v1/sessions/$SESSION_ID/recording/frames/0" \ -H "x-api-key: $BOXLINE_API_KEY" \ -o frame-0.jpgimport { writeFile } from "node:fs/promises";import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst jpeg = await bx.sessions.recordingFrame("SESSION_ID", 0);await writeFile("frame-0.jpg", jpeg);from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLjpeg = bx.sessions.recording_frame("SESSION_ID", 0)with open("frame-0.jpg", "wb") as f: f.write(jpeg)Responses
200 OK
The frame.
image/jpeg: An image (image/jpeg).
An image (image/jpeg)Errors
Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.
| Status | Codes | When |
|---|---|---|
| 400 Bad Request | invalid_request, invalid_json, invalid_cursor, invalid_idempotency_key, invalid_extension, variables_with_extensions, terms_not_accepted, invalid_reset_token, invalid_confirmation_code, wrong_password, no_password, invalid_next, invalid_oauth_token | The request is not valid. |
| 401 Unauthorized | unauthorized | Missing or invalid API key. |
| 404 Not Found | not_found, invite_not_found, provider_unavailable | No such thing in this project (or organization), or no such route. |
{ "error": { "code": "not_found", "message": "session not found", "requestId": "req_4fJx0aQm2Lk9Pz7N" }}Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.