Publish Create

POST

https://host.com/api/v1/videos/:video_id/publish/

POST

/api/v1/videos/:video_id/publish/

$ curl -X POST /api/v1/videos/1/publish/ \
>      -H "Content-Type: application/json" \
>      -d '{
>   "title": "Launch Event Highlights",
>   "workspace": 42
> }'

200Successful

1 {
2   "id": 1,
3   "sections": [
4     {
5       "id": 101,
6       "uid": "a3f1c9e2-7b4d-4f8a-9c3e-2d5b6f7a8c9d",
7       "created_at": "2024-01-15T09:30:00Z",
8       "updated_at": "2024-01-15T09:30:00Z",
9       "order": 1,
10       "video": 1,
11       "deleted_at": "2024-02-01T10:00:00Z",
12       "is_active": true,
13       "created_by": "jatin.saini",
14       "updated_by": "jatin.saini",
15       "deleted_by": "admin.user",
16       "audio_ready": true,
17       "visuals_ready": true,
18       "is_assembling": false,
19       "title": "Introduction",
20       "duration": 120,
21       "video_file": "https://cdn.aisquare.com/videos/section101.mp4",
22       "audio_file": "https://cdn.aisquare.com/audios/section101.mp3",
23       "thumbnail": "https://cdn.aisquare.com/thumbnails/section101.jpg",
24       "section_summary": "Overview of the event kickoff",
25       "internal_notes": "Ensure audio sync is perfect",
26       "page_numbers": "1-2",
27       "status": "completed",
28       "rag_documents": [
29         15
30       ]
31     }
32   ],
33   "template": {
34     "id": 5,
35     "uid": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7g",
36     "created_at": "2023-12-01T08:00:00Z",
37     "updated_at": "2024-01-10T12:00:00Z",
38     "name": "Corporate Presentation",
39     "deleted_at": "2024-01-20T00:00:00Z",
40     "is_active": true,
41     "created_by": "template.admin",
42     "updated_by": "template.editor",
43     "deleted_by": "template.admin",
44     "description": "Template for corporate event videos",
45     "thumbnail": "https://cdn.aisquare.com/templates/corp_presentation.jpg",
46     "preview_video_url": "https://cdn.aisquare.com/templates/previews/corp_presentation.mp4",
47     "voices": [
48       3,
49       7
50     ]
51   },
52   "video": "https://cdn.aisquare.com/videos/launch_event.mp4",
53   "owner": {
54     "id": 12,
55     "email": "jatin.saini@opengrowth.com",
56     "full_name": "Jatin Saini",
57     "username": "jatins",
58     "is_verified": true,
59     "profile_picture": "https://cdn.aisquare.com/profiles/jatin_saini.jpg"
60   },
61   "owner_username": "jatins",
62   "metrics": "views: 1500, likes: 300, shares: 45",
63   "tag_names": [
64     "launch",
65     "event",
66     "highlights"
67   ],
68   "category_name": "Marketing",
69   "subcategory_name": "Event Videos",
70   "custom_url": "launch-event-highlights-2024",
71   "uid": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
72   "created_at": "2024-01-10T09:00:00Z",
73   "updated_at": "2024-01-15T10:00:00Z",
74   "title": "Launch Event Highlights",
75   "workspace": 42,
76   "deleted_at": "2024-02-01T00:00:00Z",
77   "is_active": true,
78   "created_by": "jatins",
79   "updated_by": "video.editor",
80   "deleted_by": "admin.user",
81   "description": "A highlight reel of the 2024 product launch event.",
82   "cover_image": "https://cdn.aisquare.com/covers/launch_event_cover.jpg",
83   "thumbnail": "https://cdn.aisquare.com/thumbnails/launch_event_thumb.jpg",
84   "generated_script": "Welcome to the 2024 launch event highlights...",
85   "generation_progress": 100,
86   "status": "completed",
87   "internal_status": "completed",
88   "is_regenerating": false,
89   "duration": 360,
90   "visibility": "public",
91   "is_draft": false,
92   "source_experience": 3,
93   "category": 7,
94   "subcategory": 14,
95   "tags": [
96     101,
97     102,
98     103
99   ]
100 }

Publish video by setting is_draft to False.

Path parameters

video_idintegerRequired

Request

This endpoint expects an object.

templateobjectRequired

ownerobjectRequired

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)

titlestringRequired<=255 characters

workspaceintegerRequired

deleted_atdatetime or nullOptional

is_activebooleanOptional

created_bystring or nullOptional<=255 characters

updated_bystring or nullOptional<=255 characters

deleted_bystring or nullOptional<=255 characters

descriptionstring or nullOptional

cover_imagestring or nullOptionalformat: "uri"

thumbnailstring or nullOptionalformat: "uri"

Thumbnail image, also used as logo

generated_scriptstring or nullOptional

generation_progressintegerOptional-2147483648-2147483647

Progress percentage (0-100)

statusenumOptional

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

Allowed values:

internal_statusenumOptional

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_regeneratingbooleanOptional

durationinteger or nullOptional-2147483648-2147483647

Duration in seconds

visibilityenumOptional

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

Allowed values:

is_draftbooleanOptional

Whether this video is a draft

planany or nullOptional

The video plan structure (sections, timings, prompts)

source_experienceinteger or nullOptional

categoryinteger or nullOptional

subcategoryinteger or nullOptional

tagslist of integersOptional

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