---
title: "Add a knowledge URL"
method: POST
path: "/knowledge/urls"
tags: ["Knowledge"]
---

# Add a knowledge URL

`POST /knowledge/urls`

Adds a public HTTP or HTTPS URL and starts extraction and indexing. The returned document begins in processing status.

## Request body

- KnowledgeUrlCreate
  - `name` string
  - `refresh_interval_hours` 0 | 6 | 12 | 24 | 168
  - `url` string, required — An HTTP or HTTPS URL. A bare hostname is normalized to an HTTPS URL.

## Response `201`

The knowledge document was created and queued for processing.

- KnowledgeDocument
  - `character_count` integer, nullable, required
  - `created_at` string, date-time, required
  - `error_message` string, nullable, required
  - `file_name` string, nullable, required
  - `file_size_bytes` integer, nullable, required
  - `id` string, required
  - `is_enabled` boolean, required
  - `last_checked_at` string, date-time, nullable, required
  - `last_synced_at` string, date-time, nullable, required
  - `name` string, required
  - `next_refresh_at` string, date-time, nullable, required
  - `object` 'knowledge_document', required
  - `refresh_error_message` string, nullable, required
  - `refresh_interval_hours` 0 | 6 | 12 | 24 | 168 | null, nullable, required
  - `refresh_status` 'idle' | 'refreshing' | 'failed', required
  - `source_type` 'file' | 'url', required
  - `source_url` string, uri, nullable, required
  - `status` 'processing' | 'ready' | 'failed', required
  - `updated_at` string, date-time, required

## Other responses

- `400` — The request parameters are invalid.
- `401` — The Agent API key is missing, invalid, or revoked.
- `403` — The API key does not have the required permission.
- `409` — The operation conflicts with the resource's current state.
- `429` — Too many requests. Retry after the number of seconds in Retry-After.
- `500` — The request failed unexpectedly.
- `503` — The API is temporarily unavailable. The request was not processed.

---

[API](https://skmtc.dev/heroui/apis/heroui-agents-api.md) · [All operations](https://skmtc.dev/heroui/apis/heroui-agents-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/heroui/heroui-agents-api/revisions/b8efcc339d1b/schema)