Skip to main content
POST
Upload material from URL and wait for processing to complete

Authorizations

x-api-key
string
header
required

API Key for server-to-server authentication. Resolves to the owning organization.

Body

application/json
url
string
required

URL to fetch content from

Example:

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

name
string
required

Material name

Example:

"My Document"

folderId
string

Folder ID (optional)

timeoutMs
number
default:300000

Maximum time to wait for processing in milliseconds (default: 5 minutes)

pollIntervalMs
number
default:2000

Polling interval in milliseconds (default: 2 seconds)

references
object[]

References that this material cites

Response

Material uploaded from URL and processed successfully

_id
string
required

Material ID

name
string
required

Material name

organizationId
string
required

Organization ID

folderId
string | null
required

Folder ID

contentType
enum<string>
required

Content type

Available options:
text,
pdf,
video,
audio,
image,
epub
content
object
required

Material content

status
enum<string>
required

Material status

Available options:
active,
processing,
pending_upload,
error,
deleted
createdAt
string<date-time>
required

Creation timestamp

updatedAt
string<date-time>
required

Last update timestamp

metadata
object

Material metadata

usage
object

Usage information

references
object[]

References that this material cites