Skip to main content
POST
Create video index

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

video_id
string
required
Pattern: ^m-
Example:

"m-12345"

Body

application/json
index_type
enum<string>
default:spoken_word
Available options:
spoken_word,
scene
Example:

"spoken_word"

engine
string
default:default
Example:

"default"

force
boolean
Example:

false

language_code
string
Example:

"en-US"

segmentation_type
string
default:sentence
Example:

"sentence"

callback_url
string
Example:

"https://webhook.example.com/callback"

Response

200 - application/json

Index job started

success
boolean
Example:

true

status
enum<string>
Available options:
processing,
done,
failed
Example:

"processing"

data
object