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

metadata
object

Additional metadata to associate with the indexed content

settings
object

Optional settings for processing the content (e.g., image caption model)

​
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?

Upload