Ingest a YouTube video

Dedicated endpoint for ingesting YouTube videos.

This endpoint processes YouTube videos and returns a file_id that you can use with the /chat/v1/api/video/youtube endpoint.

Example Request:

curl --request POST \
  --url https://api.skimming.ai/ingest/v1/api/youtube \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://www.youtube.com/watch?v=VIDEO_ID"
  }'

Then use the file_id with /chat/v1/api/video/youtube to ask questions about the video.

POST /ingest/v1/api/youtube

Ingest a YouTube video

cURL

curl --request POST \
  --url https://api.skimming.ai/ingest/v1/api/youtube \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}
'

200

{
  "success": {
    "file_id": "abc123-def456-ghi789",
    "file_name": "document.pdf",
    "user_id": "<string>",
    "createAt": "2023-11-07T05:31:56Z"
  },
  "error": {},
  "message": {
    "content": "<string>",
    "displayContent": true
  }
}

Authorizations

Authorization · string · header · required

Bearer token authentication using an API key

Body

application/json

url · string<uri> · required

YouTube video URL

Example:

"https://www.youtube.com/watch?v=dQw4w9WgXcQ"

Response

200

application/json

YouTube video ingested successfully

success · object

Show child attributes

error · object

message · object

Show child attributes