Retrieve | AISquare Studio

import requests
url = "https://api.example.com/api/v1/videos/1/"
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

{
  "id": 1,
  "sections": [
    {
      "id": 101,
      "uid": "a3f1c9e2-4b7d-4f8a-9c3e-2d5b7f9a1c2d",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T10:00:00Z",
      "order": 1,
      "content": "Welcome to the AISquare Studio platform. In this section, we introduce the core features and benefits.",
      "video": 1,
      "is_active": true,
      "created_by": "jatin.saini",
      "updated_by": "jatin.saini",
      "audio_ready": true,
      "visuals_ready": true,
      "is_assembling": false,
      "title": "Introduction to AISquare Studio",
      "duration": 120,
      "video_file": "https://cdn.aisquare.com/videos/intro_section.mp4",
      "audio_file": "https://cdn.aisquare.com/audios/intro_section.mp3",
      "thumbnail": "https://cdn.aisquare.com/thumbnails/intro_section.jpg",
      "section_summary": "Overview of AISquare Studio capabilities and user interface.",
      "internal_notes": "Focus on clear explanation and engaging visuals.",
      "page_numbers": "1-2",
      "status": "completed",
      "rag_documents": [
        201
      ]
    }
  ],
  "template": {
    "id": 5,
    "uid": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
    "created_at": "2023-12-01T08:00:00Z",
    "updated_at": "2024-01-10T12:00:00Z",
    "name": "Corporate Presentation Template",
    "is_active": true,
    "created_by": "template_admin",
    "updated_by": "template_admin",
    "description": "A professional template designed for corporate video presentations with clean transitions and branding.",
    "thumbnail": "https://cdn.aisquare.com/templates/corporate_thumbnail.jpg",
    "preview_video_url": "https://cdn.aisquare.com/templates/corporate_preview.mp4",
    "voices": [
      3,
      7
    ]
  },
  "video": "https://cdn.aisquare.com/videos/video_1.mp4",
  "owner": {
    "id": 42,
    "email": "jatin.saini@opengrowth.com",
    "full_name": "Jatin Saini",
    "username": "jatinsaini",
    "is_verified": true,
    "profile_picture": "https://cdn.aisquare.com/profiles/jatin_saini.jpg"
  },
  "owner_username": "jatinsaini",
  "metrics": "{\"views\": 1520, \"likes\": 230, \"shares\": 45}",
  "tag_names": [
    "corporate",
    "presentation",
    "marketing"
  ],
  "category_name": "Business",
  "subcategory_name": "Marketing",
  "custom_url": "https://aisquare.com/videos/corporate-presentation-2024",
  "uid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "created_at": "2024-01-15T09:00:00Z",
  "updated_at": "2024-01-15T11:00:00Z",
  "title": "Corporate Presentation 2024",
  "workspace": 12,
  "is_active": true,
  "created_by": "jatinsaini",
  "updated_by": "jatinsaini",
  "description": "An engaging corporate presentation video created using AISquare Studio.",
  "cover_image": "https://cdn.aisquare.com/covers/corporate_presentation_cover.jpg",
  "thumbnail": "https://cdn.aisquare.com/thumbnails/corporate_presentation_thumb.jpg",
  "generated_script": "Welcome to our 2024 corporate presentation. Today, we will cover our achievements and future plans...",
  "generation_progress": 100,
  "status": "completed",
  "internal_status": "completed",
  "is_regenerating": false,
  "duration": 360,
  "visibility": "public",
  "is_draft": false,
  "source_experience": 3,
  "category": 2,
  "subcategory": 5,
  "tags": [
    10,
    15,
    22
  ]
}

Path parameters

idintegerRequired

Response

idintegerRead-only

sectionslist of objectsRead-only

templateobject

videostringRead-only

ownerobject

Simple user serializer with profile picture from associated IAMUserDetail.

Fields:

id, email, full_name, username, is_verified (from IAMUser)
profile_picture (from first related IAMUserDetail if present)

Simple user serializer with profile picture from associated IAMUserDetail. Fields: - id, email, full_name, username, is_verified (from IAMUser) - profile_picture (from first related IAMUserDetail if present)

owner_usernamestringRead-only

metricsstringRead-only

tag_nameslist of stringsRead-only

category_namestringRead-only

subcategory_namestringRead-only

custom_urlstringRead-only

uidstringRead-onlyformat: "uuid"

created_atdatetimeRead-only

updated_atdatetimeRead-only

titlestring<=255 characters

workspaceinteger

deleted_atdatetime or null

is_activeboolean

created_bystring or null<=255 characters

updated_bystring or null<=255 characters

deleted_bystring or null<=255 characters

descriptionstring or null

cover_imagestring or nullformat: "uri"

thumbnailstring or nullformat: "uri"

Thumbnail image, also used as logo

generated_scriptstring or null

generation_progressinteger-2147483648-2147483647

Progress percentage (0-100)

statusenum

not_started - Not Started
in_progress - In Progress
completed - Completed
failed - Failed

* `not_started` - Not Started * `in_progress` - In Progress * `completed` - Completed * `failed` - Failed

Allowed values:

internal_statusenum

planning - Planning Structure
scripting - Scripting & Visual Direction
audio_sync - Audio Generation & Sync
visuals - Visual Asset Generation
rendering - Section Rendering
merging - Final Assembly
completed - Success
failed - Error

* `planning` - Planning Structure * `scripting` - Scripting & Visual Direction * `audio_sync` - Audio Generation & Sync * `visuals` - Visual Asset Generation * `rendering` - Section Rendering * `merging` - Final Assembly * `completed` - Success * `failed` - Error

is_regeneratingboolean

durationinteger or null-2147483648-2147483647

Duration in seconds

visibilityenum

public - Public
private - Private
team - Team
org - Organization

* `public` - Public * `private` - Private * `team` - Team * `org` - Organization

Allowed values:

is_draftboolean

Whether this video is a draft

planany or null

The video plan structure (sections, timings, prompts)

source_experienceinteger or null

categoryinteger or null

subcategoryinteger or null

tagslist of integers