List Workspace Logs

Retrieve render and API logs for the workspace linked to your API key. Results are returned newest-first and paginated with an opaque cursor. Each entry is a trimmed summary of the request — the render response (output urls and metadata) is included, while heavier fields (request body, previews, AI generation details) are omitted.

Endpoint#

https://api.orshot.com/v1/workspace/logs

Query Parameters#

Request#

await fetch("https://api.orshot.com/v1/workspace/logs?limit=50", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

Pagination#

Logs are paginated with an opaque cursor based on the log id (stable as new logs arrive). To fetch the next page, pass the next_cursor from the previous response as the cursor parameter. When has_more is false, next_cursor is null and there are no more logs.

// Page 1
const page1 = await fetch(
  "https://api.orshot.com/v1/workspace/logs?limit=50",
  { headers: { Authorization: "Bearer <ORSHOT_API_KEY>" } },
).then((r) => r.json());

// Page 2 — pass the cursor from page 1
const page2 = await fetch(
  `https://api.orshot.com/v1/workspace/logs?limit=50&cursor=${page1.pagination.next_cursor}`,
  { headers: { Authorization: "Bearer <ORSHOT_API_KEY>" } },
).then((r) => r.json());

Response Fields#

Error Responses#

Bad Request (400)#

Returned when cursor is not a valid log id.

{
  "error": "Invalid cursor",
  "message": "cursor must be a log id"
}

Forbidden (403)#

Returned when the API key is missing or invalid.

{
  "error": "Access Forbidden"
}

Rate Limits#

• 20 requests per minute per API key