Documentation

Download Recordings and Transcripts

Download a recording or transcript using a time-limited public URL

Download a recording or transcript using a time-limited public URL

artifact_type is either recording or transcript. The token is a time-limited download token — generate one from the run details before calling this endpoint.

Quick reference#

Download a recording or transcript using a time-limited public URL. Send the request to GET /api/v1/public/download/workflow/{token}/{artifacttype} on the Paladin API base URL.

Method	`GET`
Path	`/api/v1/public/download/workflow/{token}/{artifacttype}`
Path parameters	token, artifacttype
Authentication	Use the authentication method shown in the OpenAPI block and the Authentication docs. Keep API keys server-side.

Before you call#

Confirm you are using the production base URL shown in the API reference.
Make sure any path IDs belong to the same Paladin organization as the credential you are using.
Validate request bodies and required fields before sending production traffic.

Common error checks#

Use 401 or 403 responses to check credentials, organization scope, and permissions.
Use 404 responses to check whether the referenced resource exists in the current organization.
Use 422 responses to inspect missing or invalid request fields.

OpenAPI#

GET /api/v1/public/download/workflow/{token}/{artifacttype}

openapi: 3.1.0
info:
  title: Paladin API
  description: API for the Paladin app
  version: 1.0.0
servers:
  - url: https://app.paladin.northmanngrp.com
    description: Production

security: []
paths:
  /api/v1/public/download/workflow/{token}/{artifact_type}:
    get:
      tags:
        - main
      summary: Download Workflow Artifact
      description: |-
        Download a workflow recording or transcript via public access token.

        This endpoint:
        1. Validates the public access token
        2. Looks up the corresponding workflow run
        3. Generates a signed URL for the requested artifact
        4. Redirects to the signed URL

        Args:
            token: The public access token (UUID format)
            artifact_type: Type of artifact - "recording" or "transcript"
            inline: If true, sets Content-Disposition to inline for browser preview

        Returns:
            RedirectResponse to the signed URL (302 redirect)

        Raises:
            HTTPException 404: If token is invalid or artifact not found
      operationId: >-
        download_workflow_artifact_api_v1_public_download_workflow__token___artifact_type__get
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
            title: Token
        - name: artifact_type
          in: path
          required: true
          schema:
            enum:
              - recording
              - transcript
            type: string
            title: Artifact Type
        - name: inline
          in: query
          required: false
          schema:
            type: boolean
            description: Display inline in browser instead of download
            default: false
            title: Inline
          description: Display inline in browser instead of download
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError