POST
/
index
/
url

The Index by URL endpoint allows you to index content from a specified URL. This is useful for processing and indexing remote files or web pages directly.

Request

url
string
required

The URL of the content to be indexed

collection_id
string
required

The ID of the collection to index the content into

should_save
boolean

Whether to save the indexed content (default: true)

video_settings
object

Settings for processing video content

Video Settings Object

interval_sec
number
required

The interval (in seconds) at which to split the video for processing

read
object

Settings for reading the text in each video interval

embed
object

Settings for embedding each video interval

transcribe
object

Settings for transcribing each video interval

describe
object

Settings for describing the content in each video interval

json_output
object

Settings for generating structured JSON output for each video interval

Each processing method (read, embed, transcribe, describe) can have a model_id specified. The available models can be found in the Models section.

Additionally, describe and json_output methods can include a prompt to guide the output generation.

Response

message
string

A message indicating the status of the indexing process

task_id
string

A unique identifier for the indexing task

The indexing process is asynchronous. You can use the returned task_id to check the status of the indexing task if needed.

Was this page helpful?