Skip to main content
POST
Upload content from URL

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
url
string<uri>
required

URL to download and ingest content from

Example:

"https://example.com/document.pdf"

confidential
boolean
default:false

Whether the content is confidential. Only applied when institution is provided; ignored for personal uploads.

skipIndexing
boolean
default:false

When true, the file is stored in the vault but RAG embedding generation is skipped. The file is set to status 'active' (visible in vault) with no embeddings. Default: false.

scrape
boolean
default:false

When true, scrapes webpage content. When false, downloads the file directly.

institution
string

Institution ID to associate the upload with. Must match the user's institution for regular users.

Example:

"6631915765bb0a94cfd6ca99"

selectedCourse
object

Course context for the upload history record

selectedAssistant
string

Assistant ID for the upload history record (used as fallback if selectedCourse.assistant._id is not set)

Example:

"6856fa89cbafcff8d98680f5"

collection
string

Collection ID to associate the uploaded file with. When provided, the Upload record is linked to this collection.

Example:

"6631915765bb0a94cfd6ca99"

account_shared
boolean
default:false

When true and institution is set, marks the file as shared across the institution's account

Response

URL content ingested successfully

success
boolean
Example:

true

message
string
Example:

"URL ingested successfully"

code
integer

Status code (1 indicates success)

Example:

1