> ## 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 a template render and its output artifacts

> Requires the studio-owned API account that owns the render and the print_orders:read key scope.



## OpenAPI

````yaml https://api.batchrelay.com/openapi.json get /v1/renders/{render_id}
openapi: 3.1.0
info:
  title: Batch Relay API
  version: 1.0.0
  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.
servers:
  - url: https://api.batchrelay.com
security: []
tags:
  - name: System
  - name: Catalog
  - name: Print orders
  - name: Managed assets
  - name: Template renders
  - name: API accounts
paths:
  /v1/renders/{render_id}:
    get:
      tags:
        - Template renders
      summary: Get a template render and its output artifacts
      description: >-
        Requires the studio-owned API account that owns the render and the
        print_orders:read key scope.
      operationId: getTemplateRender
      parameters:
        - name: render_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: Template render
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateRender'
        '401':
          $ref: '#/components/responses/APIKeyAuthenticationRequired'
        '403':
          $ref: '#/components/responses/APIKeyForbidden'
        '404':
          $ref: '#/components/responses/TemplateRenderNotFound'
        '503':
          $ref: '#/components/responses/TemplateRenderUnavailable'
      security:
        - bearerAuth: []
components:
  schemas:
    TemplateRender:
      type: object
      required:
        - render_id
        - status
        - template
        - output_id
        - artifacts
        - created_at
        - updated_at
      properties:
        render_id:
          type: string
        status:
          type: string
          enum:
            - queued
            - running
            - succeeded
            - failed
            - cancelled
        template:
          $ref: '#/components/schemas/TemplateRenderTemplate'
        output_id:
          type: string
        artifacts:
          type: array
          items:
            $ref: '#/components/schemas/TemplateRenderArtifact'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      additionalProperties: false
    TemplateRenderTemplate:
      type: object
      required:
        - id
        - revision_id
        - template_engine_version
      properties:
        id:
          type: string
        revision_id:
          type: string
        document_hash:
          type: string
        template_engine_version:
          type: string
          const: 0.10.0
      additionalProperties: false
    TemplateRenderArtifact:
      type: object
      required:
        - surface_id
        - fulfillment_role
        - asset_id
        - pixel_width
        - pixel_height
      properties:
        surface_id:
          type: string
          description: The rendered surface, such as front, back, or print.
        fulfillment_role:
          type: string
          enum:
            - artwork
            - front
            - back
          description: Only final fulfillment-ready artwork surfaces are exposed.
        asset_id:
          type: string
        pixel_width:
          type: integer
          minimum: 1
        pixel_height:
          type: integer
          minimum: 1
        sha256:
          type: string
        resolved_orientation:
          type: string
          enum:
            - north
            - east
            - south
            - west
            - custom
          description: >-
            Optional bottom-center anchor direction when the surface contains
            exactly one resolved exact image slot.
      additionalProperties: false
    Error:
      type: object
      required:
        - error
        - code
        - message
        - docs_url
        - request_id
      properties:
        error:
          type: string
          description: Backward-compatible human-readable error.
        code:
          type: string
          description: Stable machine-readable error code.
        message:
          type: string
        docs_url:
          type: string
          format: uri
        request_id:
          type: string
      additionalProperties: false
  responses:
    APIKeyAuthenticationRequired:
      description: A valid Batch Relay API key is required.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    APIKeyForbidden:
      description: The API key cannot perform this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TemplateRenderNotFound:
      description: The requested render does not exist or is not visible to the caller.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TemplateRenderUnavailable:
      description: >-
        The stateful template store or private renderer bridge is not
        configured.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Batch Relay API key
      description: >-
        Batch Relay scoped API key, not OAuth. Scope names document required key
        capabilities.

````