Retrieve Video by Publication URL | AISquare Studio

import requests
url = "https://api.example.com/api/v2/videos/by-url/1/"
payload = { "url": "https://publication.example.com/custom-access-url" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": 12345,
  "sections": [
    {
      "id": 101,
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "created_at": "2024-04-10T14:20:00Z",
      "updated_at": "2024-04-12T10:15:00Z",
      "order": 1,
      "video": 12345,
      "deleted_at": "2024-05-01T00:00:00Z",
      "is_active": true,
      "created_by": "editor_jane",
      "updated_by": "editor_jane",
      "deleted_by": "admin_mark",
      "audio_ready": true,
      "visuals_ready": true,
      "is_assembling": false,
      "title": "Introduction to Quantum Computing",
      "duration": 300,
      "video_file": "https://cdn.example.com/videos/quantum_intro_section1.mp4",
      "audio_file": "https://cdn.example.com/audios/quantum_intro_section1.mp3",
      "thumbnail": "https://cdn.example.com/thumbnails/quantum_intro_section1.png",
      "section_summary": "Overview of quantum computing basics",
      "internal_notes": "Focus on clarity and simple examples",
      "page_numbers": "1-5",
      "status": "completed",
      "rag_documents": [
        201,
        202
      ]
    }
  ],
  "template": {
    "id": 10,
    "uid": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
    "created_at": "2023-12-01T08:00:00Z",
    "updated_at": "2024-04-01T09:00:00Z",
    "name": "Educational Lecture Template",
    "deleted_at": "2024-06-01T00:00:00Z",
    "is_active": true,
    "created_by": "template_admin",
    "updated_by": "template_admin",
    "deleted_by": "template_admin",
    "description": "Template designed for educational video lectures with sections and voiceovers",
    "thumbnail": "https://cdn.example.com/templates/edu_lecture_thumbnail.png",
    "preview_video_url": "https://cdn.example.com/templates/previews/edu_lecture_preview.mp4",
    "voices": [
      5,
      7
    ]
  },
  "video": "https://cdn.example.com/videos/quantum_intro_full.mp4",
  "owner": {
    "id": 501,
    "email": "jane.doe@example.com",
    "full_name": "Jane Doe",
    "username": "jane_doe",
    "is_verified": true,
    "profile_picture": "https://cdn.example.com/profiles/jane_doe.png"
  },
  "owner_username": "jane_doe",
  "metrics": "{\"views\": 1500, \"likes\": 300, \"shares\": 45}",
  "tag_names": [
    "Quantum Computing",
    "Education",
    "Technology"
  ],
  "category_name": "Technology",
  "subcategory_name": "Computing",
  "custom_url": "quantum-computing-intro",
  "uid": "9f8e7d6c-5b4a-3210-fedc-ba9876543210",
  "created_at": "2024-04-10T14:00:00Z",
  "updated_at": "2024-04-12T10:00:00Z",
  "title": "Introduction to Quantum Computing",
  "workspace": 42,
  "deleted_at": "2024-06-01T00:00:00Z",
  "is_active": true,
  "created_by": "jane_doe",
  "updated_by": "jane_doe",
  "deleted_by": "admin_mark",
  "description": "A comprehensive introduction to the principles of quantum computing.",
  "cover_image": "https://cdn.example.com/covers/quantum_intro_cover.jpg",
  "thumbnail": "https://cdn.example.com/thumbnails/quantum_intro_thumbnail.jpg",
  "generated_script": "Welcome to the introduction to quantum computing...",
  "generation_progress": 100,
  "status": "completed",
  "internal_status": "completed",
  "is_regenerating": false,
  "duration": 1800,
  "visibility": "public",
  "is_draft": false,
  "source_experience": 3,
  "category": 12,
  "subcategory": 34,
  "tags": [
    101,
    102,
    103
  ]
}

Retrieve a single video by ID, verifying access via a Publication URL. Requires Authentication. Access depends on User Role and Video Visibility.

Path parameters

idintegerRequired

Request

This endpoint expects an object.

urlstringRequired

The custom URL of the publication to verify access against.

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