Retrieve

GET

https://host.com/api/v1/videos/:id/

GET

/api/v1/videos/:id/

$ curl /api/v1/videos/1/ \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "id": 1,
3   "sections": [
4     {
5       "id": 101,
6       "uid": "a3f1c9e2-4b7d-4f8a-9c3e-2d5b7f9a1c2d",
7       "created_at": "2024-01-15T09:30:00Z",
8       "updated_at": "2024-01-15T10:00:00Z",
9       "order": 1,
10       "content": "Welcome to the AISquare Studio platform. In this section, we introduce the core features and benefits.",
11       "video": 1,
12       "is_active": true,
13       "created_by": "jatin.saini",
14       "updated_by": "jatin.saini",
15       "audio_ready": true,
16       "visuals_ready": true,
17       "is_assembling": false,
18       "title": "Introduction to AISquare Studio",
19       "duration": 120,
20       "video_file": "https://cdn.aisquare.com/videos/intro_section.mp4",
21       "audio_file": "https://cdn.aisquare.com/audios/intro_section.mp3",
22       "thumbnail": "https://cdn.aisquare.com/thumbnails/intro_section.jpg",
23       "section_summary": "Overview of AISquare Studio capabilities and user interface.",
24       "internal_notes": "Focus on clear explanation and engaging visuals.",
25       "page_numbers": "1-2",
26       "status": "completed",
27       "rag_documents": [
28         201
29       ]
30     }
31   ],
32   "template": {
33     "id": 5,
34     "uid": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
35     "created_at": "2023-12-01T08:00:00Z",
36     "updated_at": "2024-01-10T12:00:00Z",
37     "name": "Corporate Presentation Template",
38     "is_active": true,
39     "created_by": "template_admin",
40     "updated_by": "template_admin",
41     "description": "A professional template designed for corporate video presentations with clean transitions and branding.",
42     "thumbnail": "https://cdn.aisquare.com/templates/corporate_thumbnail.jpg",
43     "preview_video_url": "https://cdn.aisquare.com/templates/corporate_preview.mp4",
44     "voices": [
45       3,
46       7
47     ]
48   },
49   "video": "https://cdn.aisquare.com/videos/video_1.mp4",
50   "owner": {
51     "id": 42,
52     "email": "jatin.saini@opengrowth.com",
53     "full_name": "Jatin Saini",
54     "username": "jatinsaini",
55     "is_verified": true,
56     "profile_picture": "https://cdn.aisquare.com/profiles/jatin_saini.jpg"
57   },
58   "owner_username": "jatinsaini",
59   "metrics": "{\"views\": 1520, \"likes\": 230, \"shares\": 45}",
60   "tag_names": [
61     "corporate",
62     "presentation",
63     "marketing"
64   ],
65   "category_name": "Business",
66   "subcategory_name": "Marketing",
67   "custom_url": "https://aisquare.com/videos/corporate-presentation-2024",
68   "uid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
69   "created_at": "2024-01-15T09:00:00Z",
70   "updated_at": "2024-01-15T11:00:00Z",
71   "title": "Corporate Presentation 2024",
72   "workspace": 12,
73   "is_active": true,
74   "created_by": "jatinsaini",
75   "updated_by": "jatinsaini",
76   "description": "An engaging corporate presentation video created using AISquare Studio.",
77   "cover_image": "https://cdn.aisquare.com/covers/corporate_presentation_cover.jpg",
78   "thumbnail": "https://cdn.aisquare.com/thumbnails/corporate_presentation_thumb.jpg",
79   "generated_script": "Welcome to our 2024 corporate presentation. Today, we will cover our achievements and future plans...",
80   "generation_progress": 100,
81   "status": "completed",
82   "internal_status": "completed",
83   "is_regenerating": false,
84   "duration": 360,
85   "visibility": "public",
86   "is_draft": false,
87   "source_experience": 3,
88   "category": 2,
89   "subcategory": 5,
90   "tags": [
91     10,
92     15,
93     22
94   ]
95 }

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)

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

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

is_regeneratingboolean

durationinteger or null-2147483648-2147483647

Duration in seconds

visibilityenum

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