Request Headers

Content-Type: application/json

Request Body Parameters

Parameter	Type	Required	Description
name	string	required	Full name of the developer.
email	string	required	Valid email address (must be unique).
password	string	required	At least 8 characters.
password_confirmation	string	required	Must match the password parameter.

Sample Request Body

{
  "name": "Dev Alex",
  "email": "alex@dev.com",
  "password": "superSecure123",
  "password_confirmation": "superSecure123"
}

Sample Response (302 Redirect)

On successful registration, sets session cookies and redirects to dashboard:

HTTP/1.1 302 Found
Location: https://youextractor.me/dashboard
Set-Cookie: laravel_session=eyJpdiI...; path=/; expires=...

Request Body Parameters

Parameter	Type	Required	Description
email	string	required	Account email address.
password	string	required	Account password.
remember	boolean	optional	Remembers session for extended duration if true.

Sample Request Body

{
  "email": "alex@dev.com",
  "password": "superSecure123",
  "remember": true
}

Sample Response (302 Redirect)

HTTP/1.1 302 Found
Location: https://youextractor.me/dashboard
Set-Cookie: laravel_session=eyJpdiI...; path=/;

Response (302 Redirect)

HTTP/1.1 302 Found
Location: https://youextractor.me/
Set-Cookie: laravel_session=deleted; expires=Thu, 01-Jan-1970 00:00:01 GMT; path=/;

Request Body Parameters

Parameter	Type	Required	Description
youtube_url	string	required	Full YouTube URL, short link, shorts URL, or YouTube video ID.
force_refresh	boolean	optional	Bypass caches and force extraction from scratch. Default is false.

Sample Response (202 Queued)

Returned when the extraction is successfully queued for background processing:

{
  "success": true,
  "queued": true,
  "message": "Extraction started! Poll /api/videos/42/status to track progress.",
  "data": {
    "id": 42,
    "youtube_id": "dQw4w9WgXcQ",
    "title": "Build a Todo App in React",
    "description": "Video by CodeWizard",
    "extraction_status": "pending",
    "explanation": "Extraction in progress...",
    "summary": "Pending extraction..."
  }
}

Sample Response (200 Cache Hit)

Returned if the video was previously completed:

{
  "success": true,
  "cached": true,
  "message": "Retrieved from cache",
  "data": { /* Complete Video Payload */ }
}

URL Parameters

Parameter	Type	Required	Description
video	integer	required	The database ID of the video record.

Sample Response (In Progress)

{
  "success": true,
  "status": "processing",  // "pending" | "processing"
  "error": null,
  "data": null
}

Sample Response (Completed)

{
  "success": true,
  "status": "completed",
  "error": null,
  "data": {
    "id": 42,
    "youtube_id": "dQw4w9WgXcQ",
    "title": "Build a Todo App in React",
    "extraction_status": "completed",
    "tech_stack": {
      "primary": "React",
      "all": ["React", "Vite", "JavaScript"]
    },
    "code_snippets": [
      {
        "path": "src/App.jsx",
        "code": "import React from 'react';\n...",
        "language": "javascript"
      }
    ]
  }
}

Query Parameters

Parameter	Type	Required	Description
page	integer	optional	Pagination page number. Defaults to 1 (15 items/page).

Sample Response

{
  "current_page": 1,
  "data": [
    {
      "id": 42,
      "youtube_id": "dQw4w9WgXcQ",
      "title": "Build a Todo App in React",
      "extraction_status": "completed",
      "extracted_at": "2026-07-04T12:00:00.000000Z"
    }
  ],
  "total": 1
}

Query Parameters

Parameter	Type	Required	Description
q	string	required	The text query to search in video titles and descriptions.
page	integer	optional	Pagination page number.

Sample Response

{
  "current_page": 1,
  "data": [
    { "id": 42, "title": "Build a Todo App in React" }
  ],
  "total": 1
}

URL Parameters

Parameter	Type	Required	Description
video	integer	required	The database ID of the video record.

Sample Response (200 OK)

{
  "success": true,
  "data": {
    "id": 42,
    "youtube_id": "dQw4w9WgXcQ",
    "title": "Build a Todo App in React",
    "description": "Complete setup guide...",
    "tech_stack": { "primary": "React", "all": ["React", "Vite"] },
    "summary": "Step by step guide...",
    "explanation": "This codebase showcases state management...",
    "setup_instructions": "# Setup\nRun `npm install`...",
    "dependencies": ["react", "react-dom"],
    "code_snippets": [
      {
        "path": "src/App.jsx",
        "code": "...",
        "language": "javascript"
      }
    ],
    "extraction_status": "completed",
    "github_repo_url": null
  }
}

URL Parameters

Parameter	Type	Required	Description
video	integer	required	The database ID of the video.

Sample Response (200 OK)

HTTP/1.1 200 OK
Content-Type: application/zip
Content-Disposition: attachment; filename="Build_a_Todo_App_in_React_code.zip"

[Binary ZIP Stream]

Sample Response (202 Queued)

{
  "success": true,
  "message": "Re-extraction started. Poll /api/videos/42/status for progress.",
  "data": {
    "id": 42,
    "extraction_status": "pending"
  }
}

Request Body Parameters

Parameter	Type	Required	Description
github_token	string	required	GitHub Personal Access Token (requires `repo` scope).
repo_name	string	optional	Desired repository name. Defaults to sanitized video title.
description	string	optional	Short description for the GitHub repository.
private	boolean	optional	Create repository as private if true. Defaults to false.

Sample Request Body

{
  "github_token": "ghp_1a2b3c4d5e6f7g8h9i0j",
  "repo_name": "react-todo-tutorial",
  "private": true
}

Sample Response (200 OK)

{
  "success": true,
  "message": "Repository created and code pushed successfully!",
  "github_url": "https://github.com/developer-username/react-todo-tutorial"
}

Request Body Parameters

Parameter	Type	Required	Description
question	string	required	Max 1000 characters. Question about the code setup, architecture, or flow.

Sample Request Body

{
  "question": "How is state managed in the Todo component?"
}

Sample Response (200 OK)

{
  "success": true,
  "answer": "In the App component (src/App.jsx), state is managed using the `useState` hook to maintain the list of todo objects. The handlers for add, toggle, and delete modify this array state and pass updater callbacks down to child components..."
}

Sample Response

{
  "status": "ok",
  "gemini_key": "configured",
  "openai_key": "configured",
  "anthropic_key": "missing",
  "queue_driver": "database"
}