> ## Documentation Index
> Fetch the complete documentation index at: https://developers.phrase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Video Context

> Returns what the video shows, so that tools that only read text (translation, quality checks, assistants) can take it into account.

The context is created when transcription runs with video analysis enabled, so recordings that were never analysed answer 404 with the reason. Pull it when you need it; Studio does not push it anywhere.

`contextHintUserEdited` is only present after a user has rewritten the detected `contextHint` in Studio; when it is present, prefer it over `contextHint`.

On-screen text is not part of this response. It is a regular segment of the subtitle tracks (speaker `On Screen Text`, see `metadata.onScreenText`).



## OpenAPI

````yaml /openapi/phrase-studio.json get /v1/projects/{projectId}/recordings/{recordingId}/context
openapi: 3.0.3
info:
  title: Studio API
  description: >-
    API for creating projects and reading transcription, translation, and
    dubbing results.
  version: 1.0.0
servers:
  - url: https://api.studio.us.phrase.com
    description: Production US Environment
  - url: https://api.studio.eu.phrase.com
    description: Production EU Environment
security: []
tags:
  - name: Projects
    description: Manage transcription, translation, and dubbing projects
  - name: Recordings
    description: Access recording status and output data
  - name: Subtitle Profiles
    description: Manage subtitle formatting profiles
  - name: Pronunciations
    description: Manage custom pronunciation rules
  - name: Glossaries
    description: Manage translation glossaries
  - name: Insights
    description: Manage AI-powered insight prompts
  - name: Safe Communications
    description: Access safe communication evaluation templates
  - name: Subtitles
    description: Write subtitle segments for a recording
paths:
  /v1/projects/{projectId}/recordings/{recordingId}/context:
    get:
      tags:
        - Recordings
      summary: Get Video Context
      description: >-
        Returns what the video shows, so that tools that only read text
        (translation, quality checks, assistants) can take it into account.


        The context is created when transcription runs with video analysis
        enabled, so recordings that were never analysed answer 404 with the
        reason. Pull it when you need it; Studio does not push it anywhere.


        `contextHintUserEdited` is only present after a user has rewritten the
        detected `contextHint` in Studio; when it is present, prefer it over
        `contextHint`.


        On-screen text is not part of this response. It is a regular segment of
        the subtitle tracks (speaker `On Screen Text`, see
        `metadata.onScreenText`).
      operationId: getRecordingContext
      parameters:
        - name: projectId
          in: path
          required: true
          description: Project ID
          schema:
            type: string
            format: uuid
        - name: recordingId
          in: path
          required: true
          description: Recording ID
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Video context returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingContext'
              example:
                contextHint: >-
                  This is a sunscreen commercial for a product called 'ACE SUN
                  SPORT'. Numbers like 'SPF 50' are product specifications and
                  should be preserved as such.
                scenes:
                  - description: A solid green background is displayed.
                    start: 0
                    end: 1
                  - description: >-
                      A solid green background with the text 'ACE SUN SPORT' in
                      the middle.
                    start: 1
                    end: 5
                generatedAt: '2026-11-10T19:08:01.040Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                bad_request:
                  summary: Bad Request
                  value:
                    success: false
                    statusCode: 400
                    message: projectId must be a UUID
                    timestamp: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    success: false
                    statusCode: 401
                    message: Unauthorized
                    timestamp: '2025-01-01T00:00:00.000Z'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    success: false
                    statusCode: 403
                    message: Access denied
                    timestamp: '2025-01-01T00:00:00.000Z'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                recording_not_found:
                  summary: Recording not found
                  value:
                    success: false
                    statusCode: 404
                    message: Recording not found
                    timestamp: '2025-01-01T00:00:00.000Z'
                no_video_analysis:
                  summary: The recording has no video analysis yet
                  value:
                    success: false
                    statusCode: 404
                    message: >-
                      Video analysis not found. It is created when transcription
                      runs with video analysis enabled.
                    timestamp: '2025-01-01T00:00:00.000Z'
      security:
        - apiKeyAuth: []
components:
  schemas:
    RecordingContext:
      type: object
      description: >-
        What the video shows, produced by analysing the video during
        transcription.
      required:
        - contextHint
        - scenes
        - generatedAt
      properties:
        contextHint:
          type: string
          description: >-
            Short description of the video and how its text should be read, as
            detected.
        contextHintUserEdited:
          type: string
          description: >-
            The context rewritten by a user in Studio. Only present when a user
            edited it; prefer it over `contextHint`.
        scenes:
          type: array
          description: What is on screen over time.
          items:
            type: object
            required:
              - description
              - start
              - end
            properties:
              description:
                type: string
                description: What is visible during the scene
              start:
                type: number
                description: Scene start in seconds
              end:
                type: number
                description: Scene end in seconds
        generatedAt:
          type: string
          format: date-time
          description: When the analysis was created
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        statusCode:
          type: integer
          example: 400
        message:
          type: string
          example: Bad Request
        timestamp:
          type: string
          format: date-time
          example: '2025-01-01T00:00:00.000Z'
      required:
        - success
        - statusCode
        - message
        - timestamp
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

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