> ## Documentation Index
> Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Session Resource

> Returns a single session resource (image, video, draft, avatar, voice, etc.) by its resource_id.



## OpenAPI

````yaml /openapi/external-api.json get /v3/video-agents/{session_id}/resources/{resource_id}
openapi: 3.1.0
info:
  title: HeyGen External API
  version: 1.0.0
  description: >-
    HeyGen's external API for programmatic AI video creation. See
    https://docs.heygen.com for full documentation.
  contact:
    name: HeyGen Product Infra
    url: https://heygen.com
servers:
  - url: https://api.heygen.com
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Video
    description: >-
      Create videos from a prompt or an avatar, then list, fetch, deliver and
      delete them
  - name: Avatar
    description: >-
      Create avatars and looks, record consent, and generate with the Avatar 6
      model
  - name: Voice
    description: Text to speech, speech to speech, and voice cloning
  - name: Audio
    description: Music, sound effects, transcription, stem separation and audio analysis
  - name: Image
    description: Generate images
  - name: Video editing
    description: >-
      Translate, lipsync, clip, analyze and remove filler words or backgrounds
      from existing videos
  - name: Video Agent
    description: Create videos from a prompt with an agent that plans, writes and edits
  - name: Templates
    description: Generate videos from reusable templates by replacing their variables
  - name: HyperFrames
    description: Render HyperFrames compositions into video
  - name: Brand
    description: >-
      Brand kits (colors, fonts, logos) and brand glossaries (term translations
      and pronunciations)
  - name: Assets and folders
    description: Upload files and organize them in folders
  - name: Batches
    description: Submit and track videos, translations, lipsyncs and uploads in bulk
  - name: Webhooks
    description: Manage webhook endpoints and events
  - name: Feedback
    description: Tell HeyGen how a generated result turned out
  - name: Account and usage
    description: Your account, the current API key, request logs and usage
paths:
  /v3/video-agents/{session_id}/resources/{resource_id}:
    get:
      tags:
        - Video Agent
      summary: Get Session Resource
      description: >-
        Returns a single session resource (image, video, draft, avatar, voice,
        etc.) by its resource_id.
      operationId: getVideoAgentResource
      parameters:
        - name: session_id
          in: path
          required: true
          schema:
            type: string
          description: Session ID
        - name: resource_id
          in: path
          required: true
          schema:
            type: string
          description: Resource ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SessionResource'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: unauthorized
                  message: Invalid or expired API key. Verify your x-api-key header.
                  param: null
                  doc_url: null
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: not_found
                  message: Resource not found.
                  param: null
                  doc_url: null
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Retry after the duration specified in the
                    Retry-After header.
                  param: null
                  doc_url: null
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    SessionResource:
      description: Simplified session resource for external consumers.
      properties:
        resource_id:
          description: Resource identifier
          title: Resource Id
          type: string
        resource_type:
          description: 'Resource type: image, video, draft, avatar, voice, etc.'
          title: Resource Type
          type: string
        source_type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: 'Source: generated or user_uploaded'
          title: Source Type
        url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Primary media URL
          title: Url
        thumbnail_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Thumbnail URL
          title: Thumbnail Url
        preview_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Preview URL
          title: Preview Url
        created_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Unix timestamp of resource creation
          title: Created At
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: Type-specific metadata
          title: Metadata
        blueprint:
          anyOf:
            - $ref: '#/components/schemas/SessionBlueprint'
            - type: 'null'
          default: null
          description: >-
            The video plan the agent asks the user to approve. Present only when
            `resource_type` is `blueprint`.
      required:
        - resource_id
        - resource_type
      title: SessionResource
      type: object
    StandardAPIError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: invalid_parameter
        message:
          type: string
          description: Human-readable error message
          example: Video not found
        param:
          type:
            - string
            - 'null'
          description: Which request field caused the error
        doc_url:
          type:
            - string
            - 'null'
          description: Link to error documentation
        errors:
          type: array
          description: >-
            Per-item error details for batch/multi-node failures (e.g. graph
            compilation errors by node).
          items:
            $ref: '#/components/schemas/StandardAPIErrorDetail'
        request_id:
          type: string
          description: >-
            Request identifier, also returned in the X-HeyGen-Request-Id
            response header. Include it when contacting support.
          example: 8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40
      required:
        - code
        - message
    SessionBlueprint:
      description: The video plan, as the agent will produce it once approved.
      properties:
        title:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Planned video title
          title: Title
        concept:
          description: Theme, approach and overall direction of the video
          title: Concept
          type: string
        style:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Visual style and script tone
          title: Style
        orientation:
          description: '`portrait` or `landscape`'
          title: Orientation
          type: string
        language:
          description: Target language
          title: Language
          type: string
        captions:
          description: Whether captions are included
          title: Captions
          type: boolean
        include_narrator:
          description: Whether a narrator appears on camera
          title: Include Narrator
          type: boolean
        include_voice:
          description: Whether the video has voiceover narration
          title: Include Voice
          type: boolean
        include_brand_kit:
          description: Whether the video follows a brand kit
          title: Include Brand Kit
          type: boolean
        narrator_resource_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Session resource ID of the planned narrator
          title: Narrator Resource Id
        voice_resource_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Session resource ID of the planned voice
          title: Voice Resource Id
        brand_kit_resource_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Session resource ID of the planned brand kit
          title: Brand Kit Resource Id
        notes:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Extra requirements the agent recorded
          title: Notes
        total_duration:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Planned length in seconds
          title: Total Duration
        scenes:
          description: Planned scenes, in order
          items:
            $ref: '#/components/schemas/SessionBlueprintScene'
          title: Scenes
          type: array
      required:
        - concept
        - orientation
        - language
        - captions
        - include_narrator
        - include_voice
        - include_brand_kit
        - scenes
      title: SessionBlueprint
      type: object
    StandardAPIErrorDetail:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: unknown_node_type
        message:
          type: string
          description: Human-readable error message
          example: Unknown node type
        node_id:
          type: string
          description: Graph node id this error pertains to, if applicable
        port:
          type: string
          description: Port name on the node this error pertains to, if applicable
        path:
          type: string
          description: Field path within the item this error pertains to, if applicable
      required:
        - code
        - message
    SessionBlueprintScene:
      description: One planned scene.
      properties:
        title:
          description: Short label for the scene
          title: Title
          type: string
        start_time:
          description: Start time in seconds
          title: Start Time
          type: integer
        end_time:
          description: End time in seconds
          title: End Time
          type: integer
        scene_type:
          description: '`a_roll` (narrator on camera) or `b_roll` (footage or images)'
          title: Scene Type
          type: string
        visual:
          description: What the scene shows
          title: Visual
          type: string
        script:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Exact words spoken in the scene, or null for a silent scene
          title: Script
        is_cinematic:
          description: Whether the scene uses the cinematic generation pipeline
          title: Is Cinematic
          type: boolean
      required:
        - title
        - start_time
        - end_time
        - scene_type
        - visual
        - is_cinematic
      title: SessionBlueprintScene
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: HeyGen API key. Obtain from your HeyGen dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth2 bearer token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.