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

# List videos

> List all videos with optional filtering and pagination



## OpenAPI

````yaml /openapi.json get /videos
openapi: 3.0.0
info:
  title: RawUGC API
  version: 1.0.0
  description: >-
    Generate AI videos, images, and music, and schedule social media posts
    programmatically.
  contact:
    name: API Support
    email: support@rawugc.com
    url: https://docs.rawugc.com
  license:
    name: Proprietary
servers:
  - url: https://rawugc.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Tasks
    description: >-
      Deprecated. Use typed resource endpoints instead: GET /videos/{videoId},
      GET /images/{imageId}, GET /music/{musicId}.
  - name: Image Generation
    description: >-
      Generate and edit AI images using Nano Banana models. Supports
      text-to-image generation (6 credits) and image-to-image editing (2
      credits).
  - name: Video Generation
    description: Generate and manage AI videos using Sora 2, Kling, and Veo 3 models
  - name: Personas
    description: Manage target audience personas for content plans
  - name: Messaging
    description: Manage brand/positioning messaging for content plans
  - name: Products
    description: Manage products for video generation
  - name: Styles
    description: Manage video creative styles and templates
  - name: Characters
    description: List available AI characters for video generation
  - name: Video Editing
    description: Post-process videos with captions, overlays, and effects
  - name: Upload
    description: Upload video and image files for use in generation requests
  - name: Social Scheduling
    description: Schedule and manage social media posts to TikTok, Instagram, and YouTube
  - name: Social Accounts
    description: Manage connected social media accounts
  - name: Music Generation
    description: >-
      Generate AI music tracks using Suno models with customizable genre, mood,
      and style
  - name: Viral Library
    description: >-
      Browse and search analyzed TikTok videos across the platform. Includes
      AI-powered analysis with hooks, keyframes, performance insights, and
      semantic search via natural language queries.
  - name: Research
    description: >-
      Scrape TikTok videos, analyze any video, and generate content plans. Tools
      for competitive research and content strategy.
paths:
  /videos:
    get:
      tags:
        - Video Generation
      summary: List videos
      description: List all videos with optional filtering and pagination
      operationId: listVideos
      parameters:
        - $ref: '#/components/parameters/RawUGCVersion'
        - name: status
          in: query
          schema:
            type: string
            enum:
              - pending
              - processing
              - completed
              - failed
          description: Filter by video status
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Number of videos per page
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number
      responses:
        '200':
          description: Videos retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedVideosResponse'
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  parameters:
    RawUGCVersion:
      name: RawUGC-Version
      in: header
      required: false
      schema:
        type: string
        pattern: ^\d{4}-\d{2}-\d{2}$
        example: '2026-03-06'
      description: >-
        API version to use for this request (date string, e.g. '2026-03-06'). If
        omitted, uses your API key's pinned version or the latest version.
  schemas:
    PaginatedVideosResponse:
      type: object
      properties:
        videos:
          type: array
          items:
            $ref: '#/components/schemas/VideoResponse'
        pagination:
          type: object
          properties:
            total:
              type: number
              description: Total number of videos
            page:
              type: number
              description: Current page number
            pageSize:
              type: number
              description: Number of items per page
            hasMore:
              type: boolean
              description: Whether more pages are available
    ApiError:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: >-
            URI reference identifying the problem type (e.g.,
            https://api.rawugc.com/errors/validation_error)
        title:
          type: string
          description: Short, human-readable summary of the problem
        status:
          type: number
          description: HTTP status code
        detail:
          type: string
          description: Human-readable explanation of the problem
        instance:
          type: string
          format: uri
          description: URI reference identifying this specific occurrence
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Field-specific validation errors
    VideoResponse:
      type: object
      properties:
        videoId:
          type: string
          description: Unique video identifier (vid_xxx format)
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
          description: Current generation status
        model:
          type: string
          description: Model used for generation
        prompt:
          type: string
          description: Text prompt used (if applicable)
        creditsUsed:
          type: number
          description: Credits deducted for this generation
        url:
          type: string
          format: uri
          description: >-
            URL to download the generated video (available when status is
            'completed')
        createdAt:
          type: number
          description: Timestamp when generation was initiated
        completedAt:
          type: number
          description: Timestamp when generation completed (if finished)
        failCode:
          type: string
          description: Error code if generation failed
        failMessage:
          type: string
          description: Error message if generation failed
        versions:
          type: array
          items:
            $ref: '#/components/schemas/MediaVersion'
          description: >-
            Version chain showing edit history (captions, overlays). Present
            when the video has been edited.
    MediaVersion:
      type: object
      description: A single version in a media asset's version chain
      properties:
        videoId:
          type: string
          description: Unique video identifier for this version (vid_xxx format)
        version:
          type: integer
          description: Version number (1 for original, increments for edits)
        url:
          type: string
          format: uri
          description: URL to this version of the media asset
        operation:
          type: string
          description: >-
            Operation that created this version (e.g. 'captions', 'overlay').
            Absent for the original.
        createdAt:
          type: number
          description: Timestamp when this version was created (milliseconds since epoch)
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Use your API key from the RawUGC dashboard. Include as: Authorization:
        Bearer YOUR_API_KEY

````