> ## Documentation Index > Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.app/llms.txt > Use this file to discover all available pages before exploring further. # Get Video Agent Session > Returns the current status, progress, video_id, and recent chat messages for a session. ## OpenAPI ````yaml /openapi/external-api.json get /v3/video-agents/{session_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 Agent description: Create videos from text prompts using AI - name: Videos description: Create, list, retrieve, and delete videos - name: Voices description: Text-to-speech and voice management - name: Audio description: Search the background-music and sound-effects catalog - name: Video Translate description: Translate videos into other languages - name: User description: Account information and billing - name: Avatars description: List and manage avatars and looks - name: Assets description: Upload files for use in video creation - name: Webhooks description: Manage webhook endpoints and events - name: Lipsync description: Dub or replace audio on existing videos - name: Brand description: >- Brand-related resources — brand kits (colors, fonts, logos) and brand glossaries (custom term translations) paths: /v3/video-agents/{session_id}: get: tags: - Video Agent summary: Get Video Agent Session description: >- Returns the current status, progress, video_id, and recent chat messages for a session. operationId: getVideoAgentSession parameters: - name: session_id in: path required: true schema: type: string description: Session ID responses: '200': description: Successful response content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/GetSessionResponse' '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: authentication_failed 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: Session 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: GetSessionResponse: description: Response from getting a video agent session. properties: session_id: description: Session ID title: Session Id type: string status: description: Session status enum: - thinking - waiting_for_input - reviewing - generating - completed - failed title: Status type: string progress: default: 0 description: Progress 0-100 title: Progress type: integer title: anyOf: - type: string - type: 'null' default: null description: LLM-generated session title title: Title video_id: anyOf: - type: string - type: 'null' default: null description: Video ID once generation starts title: Video Id created_at: description: Unix timestamp of session creation title: Created At type: integer messages: description: Most recent visible messages (max 40, newest-first) items: $ref: '#/components/schemas/SessionMessage' title: Messages type: array required: - session_id - status - created_at title: GetSessionResponse 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 required: - code - message SessionMessage: description: Simplified chat message for external consumers. properties: role: description: 'Message author: ''user'' or ''model''' title: Role type: string content: description: Message text content title: Content type: string type: $ref: '#/components/schemas/SessionMessageType' description: 'Message type: text, resource, or error' created_at: anyOf: - type: integer - type: 'null' default: null description: Unix timestamp of message creation title: Created At resource_ids: anyOf: - items: type: string type: array - type: 'null' default: null description: Resource IDs referenced in this message title: Resource Ids required: - role - content - type title: SessionMessage type: object SessionMessageType: description: Public message types exposed to external consumers. enum: - text - resource - error title: SessionMessageType type: string 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. ````