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

# Get a video

> Returns full details for one video, including stream URLs, caption tracks, tags, meta tags and processing state. Requires the `READ_MEDIA` scope.



## OpenAPI

````yaml GET /v1/api/video/{videoId}
openapi: 3.1.0
info:
  title: PN Player API
  description: >-
    Manage videos, captions, playlists, tags, analytics, team members and
    account settings for your PN Player account.


    All `/v1/api` endpoints accept either an API key in the `X-Auth-Token`
    header or a JWT in the `Authorization: Bearer` header. Most endpoints also
    require the calling user to hold a specific role (scope): `READ_MEDIA`,
    `UPDATE_MEDIA`, `READ_ANALYTICS`, `READ_BILLING`, `READ_SETTINGS`,
    `UPDATE_SETTINGS` or `UPDATE_USERS`. The required scope is noted on each
    endpoint.
  version: 2.0.0
servers:
  - url: https://api.pnplayer.com
security:
  - apiKeyAuth: []
  - bearerAuth: []
tags:
  - name: Authentication
    description: >-
      Obtain a session token or reset a password. These endpoints do not require
      authentication.
  - name: Videos
    description: Create, list, update and delete videos.
  - name: Captions
    description: Upload, download, transcribe and manage caption tracks for a video.
  - name: Playlists
    description: Manual and rule-based (dynamic) playlists.
  - name: Tags
    description: Account-level tags that can be attached to videos.
  - name: Analytics
    description: Playback, engagement and usage metrics.
  - name: Reports
    description: Saved analytics report links.
  - name: Account
    description: Team members and account-wide streaming and security settings.
  - name: Profile
    description: The authenticated user's own profile.
  - name: API keys
    description: Long-lived keys for programmatic access.
  - name: Webhooks
    description: Configure the HTTPS endpoint that receives signed event notifications.
  - name: Billing
    description: Plan, usage, invoices, expansion packs and billing address.
  - name: Transcription settings
    description: Per-account key/value settings for automatic transcription.
  - name: Feature requests
    description: Submit, upvote and discuss feature requests.
  - name: Agreements
    description: Data processing agreement (DPA) and enterprise order form signing.
paths:
  /v1/api/video/{videoId}:
    parameters:
      - $ref: '#/components/parameters/videoId'
    get:
      tags:
        - Videos
      summary: Get a video
      description: >-
        Returns full details for one video, including stream URLs, caption
        tracks, tags, meta tags and processing state. Requires the `READ_MEDIA`
        scope.
      responses:
        '200':
          description: Video details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoDetail'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    videoId:
      name: videoId
      in: path
      required: true
      description: Video ID (GUID)
      schema:
        type: string
        example: 657bb740-a71b-4529-a012-528021c31a92
  schemas:
    VideoDetail:
      type: object
      properties:
        videoId:
          type: string
        title:
          type: string
        availableResolutions:
          type: string
          description: Comma-separated encoded resolutions
          example: 360p,720p,1080p
        length:
          type: number
          description: Duration in seconds
        status:
          type: integer
          description: See `VideoSummary.status`
        encodeProgress:
          type: number
        storageSize:
          type: integer
          description: Size in bytes
        captions:
          type: array
          items:
            $ref: '#/components/schemas/Caption'
        streamUrl:
          type: string
          format: uri
          description: Base CDN URL for the account
        chaptersUrl:
          type: string
          format: uri
          description: WebVTT chapters file
        hlsUrl:
          type: string
          format: uri
        preview:
          type: string
          format: uri
          description: Animated preview (WebP)
        thumbnail:
          type: string
          format: uri
          description: Poster image (JPEG)
        tags:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
        metaTags:
          type: array
          items:
            $ref: '#/components/schemas/MetaTag'
        audioStatus:
          type: string
          nullable: true
          enum:
            - pending
            - ready
            - failed
            - null
          description: Standalone audio extraction state
        audioUrl:
          type: string
          format: uri
          nullable: true
          description: M4A audio URL, present when `audioStatus` is `ready`
        alignStatus:
          type: string
          nullable: true
          enum:
            - pending
            - ready
            - failed
            - null
          description: Karaoke alignment job state
    Caption:
      type: object
      properties:
        srclang:
          type: string
          example: en
        label:
          type: string
          example: English
        ext:
          type: string
          enum:
            - vtt
            - srt
            - ssa
            - ass
    MetaTag:
      type: object
      required:
        - key
        - value
      properties:
        key:
          type: string
          maxLength: 255
          example: author
        value:
          type: string
          maxLength: 1000
          example: Jane Citizen
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  responses:
    Forbidden:
      description: The caller lacks the required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Forbidden
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        API key created in the dashboard or via `POST /v1/api/api-keys`. Keys
        are prefixed `pn_` and do not expire until revoked.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Session token from `POST /auth/token`, valid for 24 hours.

````