> ## Documentation Index > Fetch the complete documentation index at: https://docs.batchrelay.com/llms.txt > Use this file to discover all available pages before exploring further. # Get browser-preview proof status ## OpenAPI ````yaml https://api.batchrelay.com/openapi.json get /v1/browser-previews/{render_id} openapi: 3.1.0 info: description: >- Provider-neutral print catalog and prepared-media validation. This document covers only routes owned by the Go service; it deliberately excludes migration-proxied order lifecycle routes and all provider payloads. license: name: Proprietary url: https://github.com/SENTINELITE/Batch-Relay-Go/blob/main/README.md title: Batch Relay API version: 1.0.1 servers: - url: https://api.batchrelay.com security: [] tags: - description: Service health and the public API description. name: System - description: Test Mode session creation and API credential entry points. name: Authentication - description: >- Provider-neutral canonical catalog resources and platform-owned semantic definitions. name: Catalog - description: Studio-scoped guest checkout-link management. name: Checkout links - description: >- One-way operational event messages. Alert emails contain no message body and recipients read messages after Batch Relay authentication. name: Studio messages - description: >- Explicit, reviewable sandbox-to-Live promotion plans for forms, catalog, and storefront configuration. name: Sandbox promotions - description: Provider-neutral validation, quoting, and order lifecycle operations. name: Print orders - description: Managed fulfillment asset ingestion and metadata. name: Managed assets - description: Studio-scoped original asset upload sessions and objects. name: Studio assets - description: Prepared and confirmed event roster team changes. name: Event team changes - description: Authenticated studio, event, and form-management operations. name: Studio management - description: >- Authenticated studio retail catalog management. Draft and publication lifecycles are explicit per product or package. name: Studio catalog - description: >- Authenticated singular storefront assortment management. PATCH atomically publishes a new immutable assortment revision; no storefront draft lifecycle exists yet. name: Storefront - description: Managed media used by the studio retail catalog. name: Studio catalog assets - description: Template rendering job creation and retrieval. name: Template renders - description: >- Published browser-side template packages and short-lived server proof renders. Preview artifacts are never fulfillment artwork. name: Browser previews - description: API account and credential administration. name: API accounts paths: /v1/browser-previews/{render_id}: parameters: - $ref: '#/components/parameters/ClientSurface' - $ref: '#/components/parameters/ClientVersion' - $ref: '#/components/parameters/InvocationMode' get: tags: - Browser previews summary: Get browser-preview proof status operationId: getBrowserTemplatePreviewRender parameters: - in: path name: render_id required: true schema: minLength: 1 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BrowserTemplatePreviewRender' description: Browser-preview render status '400': $ref: '#/components/responses/BrowserPreviewInvalidRequest' '401': $ref: '#/components/responses/APIKeyAuthenticationRequired' '403': $ref: '#/components/responses/APIKeyForbidden' '404': $ref: '#/components/responses/BrowserPreviewNotFound' '502': $ref: '#/components/responses/BrowserPreviewFailed' '503': $ref: '#/components/responses/BrowserPreviewUnavailable' security: - bearerAuth: [] components: parameters: ClientSurface: description: >- Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior. in: header name: X-BatchRelay-Client-Surface required: false schema: maxLength: 100 minLength: 1 type: string ClientVersion: description: >- Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior. in: header name: X-BatchRelay-Client-Version required: false schema: maxLength: 100 minLength: 1 type: string InvocationMode: description: >- Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior. in: header name: X-BatchRelay-Invocation-Mode required: false schema: maxLength: 100 minLength: 1 type: string schemas: BrowserTemplatePreviewRender: additionalProperties: false properties: artifacts: description: >- Present for succeeded preview renders; every artifact expires shortly and cannot be used for fulfillment. items: $ref: '#/components/schemas/BrowserTemplatePreviewArtifact' type: array profile: $ref: '#/components/schemas/BrowserTemplatePreviewProfile' render_id: type: string status: enum: - queued - running - succeeded - failed - cancelled type: string required: - render_id - status - profile type: object BrowserTemplatePreviewArtifact: additionalProperties: false properties: byte_size: minimum: 1 type: integer content_type: const: image/jpeg type: string dpi: const: 96 type: integer expires_at: format: date-time type: string id: type: string pixel_height: minimum: 1 type: integer pixel_width: minimum: 1 type: integer sha256: pattern: ^[a-f0-9]{64}$ type: string surface_id: type: string required: - id - surface_id - content_type - byte_size - sha256 - pixel_width - pixel_height - dpi - expires_at type: object BrowserTemplatePreviewProfile: additionalProperties: false properties: dpi: const: 96 type: integer format: const: jpeg type: string id: const: api_preview_v1 type: string jpeg_quality: const: 78 type: integer required: - id - dpi - format - jpeg_quality type: object Error: additionalProperties: false properties: code: description: Stable machine-readable error code. type: string docs_url: format: uri type: string error: description: Backward-compatible human-readable error. type: string message: type: string request_id: type: string required: - error - code - message - docs_url - request_id type: object responses: BrowserPreviewInvalidRequest: content: application/json: schema: $ref: '#/components/schemas/Error' description: >- The browser-preview request was malformed, mismatched its path, or used an invalid opaque identifier. APIKeyAuthenticationRequired: content: application/json: schema: $ref: '#/components/schemas/Error' description: A valid Batch Relay API key or anonymous Test Mode session is required. APIKeyForbidden: content: application/json: schema: $ref: '#/components/schemas/Error' description: >- The API key or anonymous Test Mode session cannot perform this operation. BrowserPreviewNotFound: content: application/json: schema: $ref: '#/components/schemas/Error' description: >- The requested published preview package, render, asset, or artifact does not exist or is not visible to the caller. BrowserPreviewFailed: content: application/json: schema: $ref: '#/components/schemas/Error' description: >- The browser-preview bridge or its validated object stream returned an invalid or unavailable upstream response. BrowserPreviewUnavailable: content: application/json: schema: $ref: '#/components/schemas/Error' description: >- The browser-preview Convex bridge or private object store is not configured. securitySchemes: bearerAuth: bearerFormat: Batch Relay API key or anonymous session description: >- Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations. scheme: bearer type: http ````