Update managed sitemap
PATCH
Update managed sitemap

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

documentID
string
required

Query Parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Body

patterns
object

Replaces the stored patterns whole, so send both lists even when changing one. Matching is case-insensitive and unanchored: a pattern with no * matches any URL containing it as a substring (/blog/), while * matches any run of characters (*/tag/*, *.pdf).

refreshRate
enum<string>

How often the sitemap is re-read to add the pages it newly lists and remove the ones it no longer does. Its pages are re-crawled on the same schedule. Also applied to the pages it has already imported.

Available options: daily, weekly, monthly, never
markdownConversion
object

When enabled, HTML is automatically converted to markdown to generate better chunks.

llmBasedChunks
object

When enabled, an LLM groups the content into logical sections by topic instead of splitting it on a fixed size. Best for complex documents covering varied topics.

llmGeneratedQ
object

When enabled, an LLM will be used to generate a question based on the document context and specific chunk, then prepend it to the chunk. This enhances retrieval by aligning chunks with potential user queries.

llmContentSummarization
object

When enabled, an LLM summarizes and rewrites the content, removing unnecessary information and focusing on important parts to optimize for retrieval. Limited to 15 rows per table upload.

llmPrependContext
object

When enabled, an LLM generates a context summary based on the document and chunk context, and prepends it to each chunk. This improves retrieval by providing additional context to each chunk. Note: If both llmGeneratedQ and llmPrependContext are set to true, llmGeneratedQ takes precedence, and the context summarization will not be applied.

singleChunk
object

When enabled, the whole document is stored as a single chunk, so retrieval returns it in full. Documents above the embedding model input limit (about 30,000 characters) are split into chunks as usual. Takes precedence over llmBasedChunks.

Response

200 - application/json

Returns the updated sitemap document with its ID, status, data, smart chunking settings, and folder ID.

document
object
required
Voiceflow Documentation

    Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.