Import a public web page into a knowledge base

Fetches and indexes a URL rather than a file. Must be reachable from the open internet; private and link-local addresses are refused, and refused again after DNS resolution.

Requires the write scope. A key with less gets 403 insufficient_scope.

Authorization

AuthorizationBearer <token>

Authorization: Bearer tone_live_… or tone_test_…. The prefix IS the environment: a test key reaches only the sandbox, and no request field bridges the two.

In: header

Path Parameters

id*string

The knowledge base's id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

A public https:// page to fetch and index. Must be reachable from the open internet — private and link-local addresses are refused.

Length1 <= length <= 2000

Response Body

`application/json`

curl -X POST "https://example.com/v1/knowledge-bases/string/documents/url" \  -H "Content-Type: application/json" \  -d '{    "url": "https://example.com/help/returns"  }'

{  "data": {    "byteSize": 0,    "charCount": 0,    "createdAt": "2026-08-25T09:14:22Z",    "error": null,    "filename": "returns-policy.pdf",    "id": "9f1c2d84-4e3a-4f6c-b902-7d1e8a33c451",    "kind": "pdf",    "mimeType": "application/pdf",    "status": "awaiting_upload",    "updatedAt": "2026-08-25T09:14:22Z"  }}

Was this page helpful?

Import a public web page into a knowledge base

Authorization

Path Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`