> ## 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.

# Publish a package



## OpenAPI

````yaml https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/packages/{package_id}/publish
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/studios/{studio_id}/packages/{package_id}/publish:
    parameters:
      - $ref: '#/components/parameters/ClientSurface'
      - $ref: '#/components/parameters/ClientVersion'
      - $ref: '#/components/parameters/InvocationMode'
    post:
      tags:
        - Studio catalog
      summary: Publish a package
      operationId: publishStudioCatalogPackage
      parameters:
        - $ref: '#/components/parameters/StudioID'
        - $ref: '#/components/parameters/PackageID'
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpectedEditVersion'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudioCatalogPackage'
          description: Published package
        '400':
          $ref: '#/components/responses/IdempotencyKeyRequired'
        '401':
          $ref: '#/components/responses/APIKeyAuthenticationRequired'
        '403':
          $ref: '#/components/responses/StudioCatalogForbidden'
        '404':
          $ref: '#/components/responses/StudioCatalogNotFound'
        '409':
          $ref: '#/components/responses/StudioCatalogConflict'
        '422':
          $ref: '#/components/responses/StudioCatalogInvalid'
        '503':
          $ref: '#/components/responses/StudioCatalogUnavailable'
      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
    StudioID:
      description: >-
        Stable public studio ID beginning with stu_. The API never selects a
        studio implicitly; a local CLI profile name is not a studio ID.
      in: path
      name: studio_id
      required: true
      schema:
        maxLength: 256
        minLength: 5
        pattern: ^stu_[A-Za-z0-9_-]+$
        type: string
    PackageID:
      in: path
      name: package_id
      required: true
      schema:
        maxLength: 256
        minLength: 1
        type: string
    IdempotencyKey:
      in: header
      name: Idempotency-Key
      required: true
      schema:
        maxLength: 200
        minLength: 1
        type: string
  schemas:
    ExpectedEditVersion:
      additionalProperties: false
      properties:
        expected_edit_version:
          minimum: 1
          type: integer
      required:
        - expected_edit_version
      type: object
    StudioCatalogPackage:
      additionalProperties: false
      properties:
        add_ons:
          items:
            $ref: '#/components/schemas/StudioCatalogPackageAddOn'
          type: array
        availability:
          $ref: '#/components/schemas/StudioCatalogAvailability'
        description:
          type: string
        edit_version:
          type: integer
        id:
          type: string
        lines:
          items:
            $ref: '#/components/schemas/StudioCatalogPackageLine'
          type: array
        media_asset_ids:
          items:
            type: string
          type: array
        name:
          type: string
        price:
          $ref: '#/components/schemas/StudioCatalogMoney'
        sort_order:
          type: integer
        status:
          type: string
      required:
        - id
        - name
        - status
        - edit_version
        - price
        - availability
        - lines
        - add_ons
        - media_asset_ids
      type: object
    StudioCatalogPackageAddOn:
      additionalProperties: false
      properties:
        active:
          type: boolean
        digital_configuration_id:
          type: string
        price:
          $ref: '#/components/schemas/StudioCatalogMoney'
        product_id:
          type: string
        sort_order:
          minimum: 0
          type: integer
      required:
        - product_id
        - price
        - active
      type: object
    StudioCatalogAvailability:
      additionalProperties: false
      properties:
        active:
          type: boolean
        as_add_on:
          type: boolean
        in_packages:
          type: boolean
        listed:
          type: boolean
        standalone:
          type: boolean
      type: object
    StudioCatalogPackageLine:
      additionalProperties: false
      properties:
        digital_configuration_id:
          type: string
        photo_configuration:
          enum:
            - individual
            - buddy
            - team
          type: string
        product_id:
          type: string
        quantity:
          maximum: 100
          minimum: 1
          type: integer
      required:
        - product_id
        - quantity
        - photo_configuration
      type: object
    StudioCatalogMoney:
      additionalProperties: false
      properties:
        amount:
          description: Integer USD cents.
          minimum: 0
          type: integer
        currency:
          const: USD
          type: string
      required:
        - currency
        - amount
      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:
    IdempotencyKeyRequired:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Idempotency-Key is required for this operation.
    APIKeyAuthenticationRequired:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: A valid Batch Relay API key or anonymous Test Mode session is required.
    StudioCatalogForbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: >-
        The credential is anonymous, lacks the required studio catalog or
        storefront scope, is a Test Mode key attempting a mutation, or is not
        authorized for the requested studio.
    StudioCatalogNotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: >-
        The requested studio catalog or storefront resource does not exist or is
        not visible to this credential.
    StudioCatalogConflict:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: >-
        The resource version is stale, immutable, or conflicts with this request
        or idempotency key.
    StudioCatalogInvalid:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: >-
        The studio catalog or storefront request is structurally or semantically
        invalid.
    StudioCatalogUnavailable:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: >-
        The trusted studio catalog Convex functions are not configured or are
        temporarily unavailable.
  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

````