smb
SMB

Upload Knowledge Source

Changed on

Upload a file as a knowledge source

post/v1/smb/knowledge-sources

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/smb/knowledge-sources
  • Auth
    none declared

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

xi-workspace-idstring nullable

The customer workspace a reseller's API key acts on.

Request body multipart/form-data

filestring binary required

Response

Successful Response

source_type'file' | 'url'

Type of knowledge source.

source_urlstring nullable
last_scraped_at_unixinteger nullable
original_filenamestring
content_typestring
file_size_bytesinteger
status'processing' | 'ready' | 'error'

Processing status for knowledge sources.

Simple three-state machine:

  • PROCESSING: Any active work (uploading, crawling, extracting, etc.)
  • READY: Processing complete, results available
  • ERROR: Something went wrong (user can retry)

Detailed progress is tracked via the progress field.

error_messagestring nullable
failure_reason'blocked_url' | 'dns_failure' | 'host_unreachable' | 'access_refused' | 'crawl_timeout' | 'no_pages' | 'no_content' | 'upstream_timeout' | 'upstream_error' | 'unknown'

Why a run failed, as a bounded taxonomy.

Set explicitly at each raise site rather than recovered from the message text, so rewording a user-facing string cannot silently reshape the metric. The UPSTREAM_* causes are the exception: an unclassified escape is sorted by its type in ScrapeRun.failed, so a dependency outage (the agents knowledge-base routes, the sandbox) is not filed as UNKNOWN.

crawl_entire_siteboolean
scraped_pages_countinteger
content_previewstring nullable
processing_started_at_unixinteger nullable
_idstring required
created_at_unixinteger

Unix timestamp (seconds since epoch)

updated_at_unixinteger

Unix timestamp (seconds since epoch)

Changes