Chat with a MOV video

Ask questions about a MOV video using its file_id.

Workflow:

1. Ingest video using /source/v1/api/document
2. Use returned file_id with this endpoint

POST /chat/v1/api/video/mov

Chat with a MOV video

cURL

curl --request POST \
  --url https://app.skimming.ai/back/chat/v1/api/video/mov \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_id": "abc123-def456-ghi789",
  "question": "What are the main points discussed in this document?",
  "streaming": true,
  "model": "gpt-4",
  "model_type": "openai",
  "conversation_type": "single",
  "max_output": 2000
}
'

import requests

url = "https://app.skimming.ai/back/chat/v1/api/video/mov"

payload = {
    "file_id": "abc123-def456-ghi789",
    "question": "What are the main points discussed in this document?",
    "streaming": True,
    "model": "gpt-4",
    "model_type": "openai",
    "conversation_type": "single",
    "max_output": 2000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    file_id: 'abc123-def456-ghi789',
    question: 'What are the main points discussed in this document?',
    streaming: true,
    model: 'gpt-4',
    model_type: 'openai',
    conversation_type: 'single',
    max_output: 2000
  })
};

fetch('https://app.skimming.ai/back/chat/v1/api/video/mov', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.skimming.ai/back/chat/v1/api/video/mov",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'file_id' => 'abc123-def456-ghi789',
    'question' => 'What are the main points discussed in this document?',
    'streaming' => true,
    'model' => 'gpt-4',
    'model_type' => 'openai',
    'conversation_type' => 'single',
    'max_output' => 2000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.skimming.ai/back/chat/v1/api/video/mov"

	payload := strings.NewReader("{\n  \"file_id\": \"abc123-def456-ghi789\",\n  \"question\": \"What are the main points discussed in this document?\",\n  \"streaming\": true,\n  \"model\": \"gpt-4\",\n  \"model_type\": \"openai\",\n  \"conversation_type\": \"single\",\n  \"max_output\": 2000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.skimming.ai/back/chat/v1/api/video/mov")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_id\": \"abc123-def456-ghi789\",\n  \"question\": \"What are the main points discussed in this document?\",\n  \"streaming\": true,\n  \"model\": \"gpt-4\",\n  \"model_type\": \"openai\",\n  \"conversation_type\": \"single\",\n  \"max_output\": 2000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.skimming.ai/back/chat/v1/api/video/mov")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_id\": \"abc123-def456-ghi789\",\n  \"question\": \"What are the main points discussed in this document?\",\n  \"streaming\": true,\n  \"model\": \"gpt-4\",\n  \"model_type\": \"openai\",\n  \"conversation_type\": \"single\",\n  \"max_output\": 2000\n}"

response = http.request(request)
puts response.read_body

200

"<string>"

{
  "success": false,
  "error": {},
  "message": {
    "content": "Invalid request parameters",
    "displayContent": true
  }
}

{
  "success": false,
  "error": {},
  "message": {
    "content": "Invalid API key",
    "displayContent": true
  }
}

{
  "success": false,
  "error": {},
  "message": {
    "content": "Question limit exceeded!",
    "displayContent": true
  }
}

Authorizations

Authorization · string · header · required

Bearer token authentication using an API key

Body

application/json

file_id · string · required

The file_id returned from ingest endpoint

Example:

"abc123-def456-ghi789"

question · string · required

Your question about the content

Example:

"What are the main points discussed in this document?"

streaming · boolean · default: true

Whether to stream the response (SSE format)

model · enum<string> · default: gpt-4

AI model to use

Available options: gpt-4, gpt-4o, gpt-4o-mini, gpt-3.5-turbo, claude-3-opus, claude-3-sonnet, claude-3.5-sonnet, gemini-1.5-pro, gemini-1.5-flash

Example:

"gpt-4"

model_type · enum<string> · default: openai

Model provider

Available options: openai, anthropic, gemini

Example:

"openai"

conversation_type · enum<string> · default: single

Type of conversation

Available options: single, group

max_output · integer

Maximum output tokens

Example:

2000

Response

200

text/event-stream

Successful response

Server-Sent Events stream (when streaming=true)