Upload Document (url)

Request Fields

Property	Description & Example
Content-Type (header)	application/json; charset=utf-8
overwrite (query parameter)	Optional - Specify whether to overwrite existing data (optional). "True" means you want to overwrite.
maxChunkSize (query parameter)	Optional - Determine how granularly each document is broken up. Max chunk size affects the total amount of chunks parsed from a document. (i.e. larger chunks means less chunks retrieved) Smaller chunk size means: narrower context faster response less tokens consumed greater risk of less accurate answerstype: integer ; default: 1000; Range available is 500-1500 tokens. Once uploaded, you can view the chunks using the GET Document Chunk Retrieval Knowledge Base API.

Property

Description & Example

Content-Type (header)

application/json; charset=utf-8

overwrite (query parameter)

Optional - Specify whether to overwrite existing data (optional). "True" means you want to overwrite.

maxChunkSize (query parameter)

Optional - Determine how granularly each document is broken up. Max chunk size affects the total amount of chunks parsed from a document. (i.e. larger chunks means less chunks retrieved)

Smaller chunk size means:

narrower context
faster response
less tokens consumed
greater risk of less accurate answerstype: integer ; default: 1000; Range available is 500-1500 tokens. Once uploaded, you can view the chunks using the GET Document Chunk Retrieval Knowledge Base API.

👨‍💻
Tags API has been deprecated
Tags API stills offers legacy support, subject to change. For the latest tag functionality, you can now use file metadata when uploading files.

Example

Sample Request

{
	"data": {
		"type": "url",
    "url": "https://www.familyhandyman.com/article/simple-step-stool/",
    "metadata":
    {
      "website_name": "family handman",
      "info_type": "article"
		}
	}
}

Sample Response

{
  	"data": {
			"documentID": "6515dccab4bc5400060fbc6a",
			"data": {
				"type": "url",
				"name": "familyhandyman.com/article/simple-step-stool/"
			},
			"updatedAt": "2025-06-28T20:06:34.049Z",
			"status": {
				"type": "PENDING"
			},
			"tags": []
		}
}