Skip to main content
POST
Process Document From Url

Headers

x-knowledge-base-config-id
string<uuid> | null

Body

application/json

Schema for processing document from URL

client_id
string<uuid>
required

Client ID that will own the knowledge

url
string<uri>
required

URL of the document to process

Required string length: 1 - 2083
title
string | null

Custom title for the document

description
string | null

Custom description for the document

tags
string[] | null

Custom tags for the document

include_sub_pages
boolean
default:false

Whether to crawl and process sub-pages found in the main page

max_pages
integer
default:1

Maximum number of pages to process (including main page)

Required range: 1 <= x <= 50

Response

Successful Response

data
any
required

Response payload

meta
any
required

Metadata

success
boolean
default:true

Success indicator

message
string | null

Optional success message