---
title: "Refresh Url Document Content"
method: POST
path: "/v1/convai/knowledge-base/{documentation_id}/refresh"
tags: ["Agents Platform"]
---

# Refresh Url Document Content

`POST /v1/convai/knowledge-base/{documentation_id}/refresh`

Manually refresh a URL document by re-fetching its content from the source URL.

## Path parameters

- `documentation_id` string, required — The id of a document from the knowledge base. This is returned on document addition.

## 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.

## Response `200`

Successful Response

- union
  - GetKnowledgeBaseURLResponseModel
    - `id` string, required
    - `name` string, required
    - `metadata` KnowledgeBaseDocumentMetadataResponseModel, required
      - `created_at_unix_secs` integer, required
      - `last_updated_at_unix_secs` integer, required
      - `size_bytes` integer, required
    - `supported_usages` DocumentUsageModeEnum[], required
    - `access_info` ResourceAccessInfo, required
      - `is_creator` boolean, required — Whether the user making the request is the creator of the agent
      - `creator_name` string, required — Name of the agent's creator
      - `creator_email` string, required — Email of the agent's creator
      - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required — The role of the user making the request
      - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable — The access level for anonymous users. If None, the resource is not shared publicly.
      - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable — Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them.
    - `folder_parent_id` string, nullable — The ID of the parent folder, or null if the document is at the root level.
    - `folder_path` KnowledgeBaseFolderPathSegmentResponseModel[] — The folder path segments leading to this entity, from root to parent folder.
      - `id` string, required
      - `name` string, nullable, required
    - `type` 'url', required
    - `url` string, required
    - `extracted_inner_html` string, required
    - `content_format` 'html' | 'markdown' — Canonical representation of a knowledge base document's stored content. HTML is the legacy default; documents created before this field existed are interpreted as HTML.
    - `auto_sync_info` AutoSyncInfo
      - `minimum_frequency_days` integer — Maximum number of days between automatic syncs
      - `auto_remove` boolean — Whether to remove the document if the URL becomes unavailable
      - `consec_failures` integer — Number of consecutive sync failures
      - `next_refresh_by` integer, nullable — Unix timestamp for the next scheduled sync or None (in case of folders)
  - GetKnowledgeBaseFileResponseModel
    - `id` string, required
    - `name` string, required
    - `metadata` KnowledgeBaseDocumentMetadataResponseModel, required
      - `created_at_unix_secs` integer, required
      - `last_updated_at_unix_secs` integer, required
      - `size_bytes` integer, required
    - `supported_usages` DocumentUsageModeEnum[], required
    - `access_info` ResourceAccessInfo, required
      - `is_creator` boolean, required — Whether the user making the request is the creator of the agent
      - `creator_name` string, required — Name of the agent's creator
      - `creator_email` string, required — Email of the agent's creator
      - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required — The role of the user making the request
      - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable — The access level for anonymous users. If None, the resource is not shared publicly.
      - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable — Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them.
    - `folder_parent_id` string, nullable — The ID of the parent folder, or null if the document is at the root level.
    - `folder_path` KnowledgeBaseFolderPathSegmentResponseModel[] — The folder path segments leading to this entity, from root to parent folder.
      - `id` string, required
      - `name` string, nullable, required
    - `type` 'file', required
    - `extracted_inner_html` string, required
    - `content_format` 'html' | 'markdown' — Canonical representation of a knowledge base document's stored content. HTML is the legacy default; documents created before this field existed are interpreted as HTML.
    - `filename` string, required
    - `external_sync_info` ExternalFileSyncInfo — Tracks the link back to the original file in an external source.
      - `type` 'google_drive', required
      - `source_entity_id` string, required — Entity ID in the external system
      - `integration_connection_id` string, required — Integration connection instance ID
      - `source_parent_entity_id` string, required — Folder ID in the external system this file was synced from
      - `source_mime_type` string, required — Original MIME type in the external system
      - `source_modified_time` string, date-time, required — Last modified time from the external system
      - `root_folder_id` string, nullable — KB folder ID of the sync root, used to query all entities under a sync tree
    - `auto_sync_info` AutoSyncInfo
      - `minimum_frequency_days` integer — Maximum number of days between automatic syncs
      - `auto_remove` boolean — Whether to remove the document if the URL becomes unavailable
      - `consec_failures` integer — Number of consecutive sync failures
      - `next_refresh_by` integer, nullable — Unix timestamp for the next scheduled sync or None (in case of folders)
    - `refresh_status` FileRefreshStatus — In-flight/last refresh state for an externally-synced KB file.
      - `status` 'queued' | 'processing' | 'succeeded' | 'failed' | 'skipped' | 'cancelled'
      - `enqueued_at` integer, nullable
      - `started_at` integer, nullable
      - `completed_at` integer, nullable
      - `last_synced_at` integer, nullable
      - `error_message` string, nullable
    - `is_frozen` boolean
  - GetKnowledgeBaseTextResponseModel
    - `id` string, required
    - `name` string, required
    - `metadata` KnowledgeBaseDocumentMetadataResponseModel, required
      - `created_at_unix_secs` integer, required
      - `last_updated_at_unix_secs` integer, required
      - `size_bytes` integer, required
    - `supported_usages` DocumentUsageModeEnum[], required
    - `access_info` ResourceAccessInfo, required
      - `is_creator` boolean, required — Whether the user making the request is the creator of the agent
      - `creator_name` string, required — Name of the agent's creator
      - `creator_email` string, required — Email of the agent's creator
      - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required — The role of the user making the request
      - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable — The access level for anonymous users. If None, the resource is not shared publicly.
      - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable — Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them.
    - `folder_parent_id` string, nullable — The ID of the parent folder, or null if the document is at the root level.
    - `folder_path` KnowledgeBaseFolderPathSegmentResponseModel[] — The folder path segments leading to this entity, from root to parent folder.
      - `id` string, required
      - `name` string, nullable, required
    - `type` 'text', required
    - `extracted_inner_html` string, required
    - `content_format` 'html' | 'markdown' — Canonical representation of a knowledge base document's stored content. HTML is the legacy default; documents created before this field existed are interpreted as HTML.
  - GetKnowledgeBaseFolderResponseModel
    - `id` string, required
    - `name` string, required
    - `metadata` KnowledgeBaseDocumentMetadataResponseModel, required
      - `created_at_unix_secs` integer, required
      - `last_updated_at_unix_secs` integer, required
      - `size_bytes` integer, required
    - `supported_usages` DocumentUsageModeEnum[], required
    - `access_info` ResourceAccessInfo, required
      - `is_creator` boolean, required — Whether the user making the request is the creator of the agent
      - `creator_name` string, required — Name of the agent's creator
      - `creator_email` string, required — Email of the agent's creator
      - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required — The role of the user making the request
      - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable — The access level for anonymous users. If None, the resource is not shared publicly.
      - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable — Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them.
    - `folder_parent_id` string, nullable — The ID of the parent folder, or null if the document is at the root level.
    - `folder_path` KnowledgeBaseFolderPathSegmentResponseModel[] — The folder path segments leading to this entity, from root to parent folder.
      - `id` string, required
      - `name` string, nullable, required
    - `type` 'folder', required
    - `children_count` integer, required
    - `document_count` integer, required — Number of non-folder documents anywhere in this folder's subtree (recursive). Counting stops past 1000;
    - `auto_sync_info` AutoSyncInfo
      - `minimum_frequency_days` integer — Maximum number of days between automatic syncs
      - `auto_remove` boolean — Whether to remove the document if the URL becomes unavailable
      - `consec_failures` integer — Number of consecutive sync failures
      - `next_refresh_by` integer, nullable — Unix timestamp for the next scheduled sync or None (in case of folders)
    - `external_sync_info` ExternalFolderSyncInfo — Metadata for a KB folder that mirrors an external source folder.
      - `type` 'google_drive', required
      - `source_entity_id` string, required — Entity ID in the external system
      - `integration_connection_id` string, required — Integration connection instance ID
      - `root_folder_id` string, nullable — KB folder ID of the sync root. None means this folder is the root.
      - `sync_cursor` string, nullable — Opaque cursor for incremental sync, interpreted by the provider
      - `last_sync_at` integer, nullable — Unix timestamp of last completed sync
    - `is_frozen` boolean
    - `active_sync_job` KbExternalSyncJob
      - `type` 'google_drive', required
      - `folder_id` string, required
      - `integration_connection_id` string, required
      - `triggered_by` 'on_demand' | 'on_connect' | 'auto', required
      - `status` 'queued' | 'processing' | 'succeeded' | 'failed' | 'skipped' | 'cancelled'
      - `sync_type` 'full' | 'incremental'
      - `items_identified` integer
      - `items_processed` integer
      - `error_message` string, nullable
      - `started_at` integer, nullable
      - `completed_at` integer, nullable
      - `updated_at` integer, required
      - `id` string, required
      - `created_at` integer, 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/versions/e77a0a530a82/schema)