---
title: "Create Url Document"
method: POST
path: "/v1/convai/knowledge-base/url"
tags: ["Agents Platform"]
---

# Create Url Document

`POST /v1/convai/knowledge-base/url`

Create a knowledge base document generated by scraping the given webpage.

## Headers

- `xi-api-key` string, 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.

## Request body

- BodyCreateURLDocumentV1ConvaiKnowledgeBaseUrlPost
  - `url` string, required — URL to a page of documentation that the agent will have access to in order to interact with users.
  - `name` string, nullable — A custom, human-readable name for the document.
  - `parent_folder_id` string, nullable — If set, the created document or folder will be placed inside the given folder.
  - `enable_auto_sync` boolean — Whether to enable auto-sync for this URL document.
  - `auto_remove` boolean — Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled.
  - `minimum_frequency_days` integer, nullable — Minimum frequency (in days) at which the document is refreshed. The actual interval may be shorter, never longer. Defaults to 7, tightened to the parent folder's frequency if that is stricter. Only applicable when auto-sync is enabled.

## Response `200`

Successful Response

- AddKnowledgeBaseResponseModel
  - `id` string, required
  - `name` string, required
  - `folder_path` KnowledgeBaseFolderPathSegmentSummaryResponseModel[] — The folder path segments leading to this entity, from root to parent folder.
    - `id` string, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/revisions/db6eec599cbe/schema)