/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */

export interface paths {
  '/{apiVersion}/context/knowledge-bases': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * List knowledge bases
     * @description Returns the knowledge bases you can access in the organization set by `organizationId`. Drafts are left out unless you set `includeDrafts` to `true`. Results are cursor-paginated, newest first.
     */
    get: operations['listKnowledgeBases']
    put?: never
    /**
     * Create a knowledge base
     * @description Creates a knowledge base in your organization. To add content to it, add a source. Set `draft` to `true` to create a draft, which needs no title or description until you finish it. If your organization's Context document store can't be used, the request returns `503` with code `contextStoreUnavailable` and you can retry.
     */
    post: operations['createKnowledgeBase']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get a knowledge base
     * @description Returns a knowledge base's metadata and state. `knowledgeBaseId` accepts the public ID (`kb...`) or the UUID, and you don't need to pass an organization. If you can't read the knowledge base, the request returns `404`. To read the built entries, query `sanity.context.entry` documents with GROQ from your organization's document store.
     */
    get: operations['getKnowledgeBase']
    put?: never
    post?: never
    /**
     * Delete a knowledge base
     * @description Deletes the knowledge base and everything it owns: its sources, revisions, stored source files, and its documents in your organization's document store. While a build, refresh, apply, or sync is running, the request returns `409` with code `buildInFlight`. Retry after that work finishes.
     */
    delete: operations['deleteKnowledgeBase']
    options?: never
    head?: never
    /**
     * Update a knowledge base
     * @description Updates the title or the description, or finishes a draft (`draft: false`). Fields equal to their current value are ignored, so sending the current values changes nothing. Finishing a draft with no title returns `422` with code `draftTitleRequired`. How often a website or dataset syncs is set on the source, with `PATCH .../sources/{sourceId}`.
     */
    patch: operations['updateKnowledgeBase']
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/build': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Start a knowledge base build
     * @description Queues a build over the knowledge base's current sources and returns a job ID immediately. If a build is already running, the response returns that build's job ID instead of starting a second build. A draft can't be built: the request returns `409` with code `knowledgeBaseIsDraft`.
     */
    post: operations['buildKnowledgeBase']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/build/cancel': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Cancel a knowledge base build
     * @description Cancels the running build and resets the knowledge base so you can build it again. Returns `cancelled: false` when no build is running.
     */
    post: operations['cancelKnowledgeBaseBuild']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/documents': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * List documents
     * @description Lists the documents in a knowledge base: the pages, dataset documents and files its sources yield, which builds read and cite. Results are cursor-paginated, and you can filter them by `source` and `state`.
     */
    get: operations['listDocuments']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/documents/{documentId}': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get a document
     * @description Returns a document with its conversion status and the chunks of its markdown. Entry citations point at a document's chunks.
     */
    get: operations['getDocument']
    put?: never
    post?: never
    /**
     * Delete a document
     * @description Deletes a document from its source. A page that is still on the website comes back on the next sync of its source unless the crawl options exclude it. Entries that cite the document stay the same until the next build or refresh, which removes the citations.
     */
    delete: operations['deleteDocument']
    options?: never
    head?: never
    /**
     * Keep a missing document
     * @description Keeps a `missing` web page in the knowledge base by setting its `state` back to `active`. A document that isn't `missing` returns `409` with code `documentInvalidState`.
     */
    patch: operations['updateDocument']
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/documents/{documentId}/content': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get a document's markdown
     * @description Returns the markdown a document converted to: the text builds read, and the line numbers citations use. Set `chunk` or `lines` to get part of it, and `format` to `markdown` or `plain` to get the text alone instead of JSON. Until the document is converted, the request returns `409` with code `documentNotConverted`. With `format=raw` it returns the document as its source gave it, as an attachment, or `409` with code `documentNotStored` when the document was too large to keep.
     */
    get: operations['getDocumentContent']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/entries/{entryPath}/rebuild': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Rebuild an entry from its sources
     * @description Queues a rewrite of the entry at `entryPath` from its cited sources and the active instructions, and returns a job ID immediately. The response also lists the other entries built from any of the same sources. An instruction applies to every entry built from its sources, so those entries can change too. Returns `422` with code `entryDocumentInvalid` if the entry document was edited into a shape the API cannot read.
     */
    post: operations['rebuildEntry']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/instructions': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Create an instruction
     * @description Creates a standing instruction for how entries built from its documents are written. Every instruction applies to specific documents, set in `scopeDocumentIds`. To rebuild entries under the new instruction right away, pass their paths in `rebuildPaths`. The response includes the rebuild job ID, or `null` if the rebuild could not start. The instruction is saved either way. After the instruction is saved, a background check files issues for entries that contradict it. If you already checked the instruction for contradictions, set `verified` to skip the background check. If the requested rebuild does not start, the background check runs even when `verified` is set.
     */
    post: operations['createInstruction']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/instructions/check': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Check an instruction for contradictions
     * @description Checks every entry built from any of the documents in `scopeDocumentIds` against `statement`, and returns the entries that contradict it. Nothing is saved. Run it before `POST .../instructions` to find the entries a new instruction would contradict, then pass their paths as `rebuildPaths` and set `verified`. Each checked entry is one model call that counts toward the organization's model spend, and the response waits for all of them, so a check over many entries can take a while. To list the entries without checking them, set `candidatesOnly`; this makes no model calls. To check only some entries, pass their paths in `paths`. Together, these let you check one entry per request and show progress.
     */
    post: operations['checkInstruction']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/instructions/draft': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Draft an instruction from feedback
     * @description Turns free-form feedback, such as "this is wrong" or "never say X", into a proposed instruction: a statement and the documents it applies to. The documents come from `scopeDocumentIds` if you set it, or otherwise from the documents of the entry in `entryId`. Nothing is saved. Review and edit the draft, then create it with `POST .../instructions`. Each draft is one model call that counts toward the organization's model spend. If the model call fails, the request returns `502` with code `instructionDraftFailed`; retry, or write the instruction yourself.
     */
    post: operations['draftInstruction']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/instructions/{instructionId}': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    post?: never
    /**
     * Delete an instruction
     * @description Deletes the instruction. Builds stop applying it from the next run. Entries already written under it keep their text until they are rebuilt; pass `rebuild=true` to rebuild every entry built from its documents right away.
     */
    delete: operations['deleteInstruction']
    options?: never
    head?: never
    /**
     * Update an instruction
     * @description Updates the instruction's statement or documents. The change applies from the next build. Any update also reactivates an archived instruction and ties it to the current content of its documents.
     */
    patch: operations['updateInstruction']
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/issues/apply': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Accept and apply issues
     * @description Accepts the issues in `issueIds`, then queues a job that applies them, rewrites the affected entries, and saves a new revision. Returns a job ID. IDs of issues that no longer exist are skipped. Returns `409` with code `issueNotAutoApplicable`, and accepts none of the issues, if any of them cannot be applied: a `conflict` (resolve it with `POST .../issues/{issueId}/resolve`), or an `update_required` issue whose `scopePath` is `*` or names an entry that no longer exists. Dismiss those instead.
     */
    post: operations['applyIssues']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/issues/{issueId}/dismiss': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Dismiss an issue
     * @description Marks the issue as rejected. If the issue already left triage, the request returns it unchanged. Returns `422` with code `issueDocumentInvalid` if the issue document was edited into a shape the API cannot verify. Returns `409` with code `issueTransitionConflict` if another change to the issue happened at the same time. You can safely retry a `409`.
     */
    post: operations['dismissIssue']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/issues/{issueId}/reopen': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Reopen an accepted conflict
     * @description Returns an accepted conflict issue to triage, clears its resolution, and deletes the instruction the resolution created. Reopening an open or dismissed conflict returns it unchanged. Other issue types return `422` with code `issueNotResolvable`.
     */
    post: operations['reopenIssue']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/issues/{issueId}/resolve': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Resolve a conflict issue
     * @description Resolves a conflict issue by choosing one of its sides. Set `resolution` to the index of a side in `content.sides`. For a conflict on a single entry, index `0` is the entry's current content, so choosing it keeps the entry as it is. Choosing any other side rewrites the entry, and the returned `jobId` tracks the rewrite. The decision becomes a standing instruction for every future build, and `resolvedBy` records who made it. To change a decision, resolve the accepted conflict again. Other issue types, dismissed conflicts, and out-of-range indexes return `422` with code `issueNotResolvable`.
     */
    post: operations['resolveIssue']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/jobs/{jobId}': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get a job
     * @description Returns the status of a background job, such as a build, sync, or refresh. The endpoint that starts the work returns the job ID. A job cancelled before it started never ran, so it returns 404.
     */
    get: operations['getJob']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/sources': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * List sources
     * @description Lists the sources of a knowledge base: the websites, Sanity datasets and files its documents come from, each with its document counts and its latest sync. Results are cursor-paginated.
     */
    get: operations['listSources']
    put?: never
    /**
     * Add a source
     * @description Adds a source to a knowledge base. Set `type` to choose what it reads:
     *
     *     - `web`: a website, crawled from `url`
     *     - `sanity-dataset`: the documents a GROQ query selects in a Sanity dataset
     *     - `files`: files you upload with `POST .../sources/{sourceId}/uploads`, or text you send in `content`
     *
     *     A website or dataset starts its first sync right away. A `files` source syncs when you upload a file, or right away when you send `content`: one request stores the text, adds the source and starts its sync. For a website, set `dryRun` to `true` to preview the crawl without adding the source.
     *
     *     Adding a website that is already a source returns `409` with code `webSourceRootConflict`, and adding more websites than your limit allows returns `409` with code `webSourceRootLimitExceeded`. When the organization's knowledge bases already hold as many source chunks as its plan allows, returns `403` with code `planLimitReached` and adds nothing. Supports the `Idempotency-Key` header.
     */
    post: operations['createSource']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/sources/{sourceId}': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get a source
     * @description Returns a source with its settings, document counts and latest sync.
     */
    get: operations['getSource']
    put?: never
    post?: never
    /**
     * Delete a source
     * @description Removes a source and its documents from the knowledge base, and starts a refresh that removes their citations from entries and deletes the entries left with none. A source no other knowledge base uses stops syncing and is deleted once that refresh has run.
     */
    delete: operations['deleteSource']
    options?: never
    head?: never
    /**
     * Update a source
     * @description Changes a source's title, a website's crawl options, a dataset's query, or how often a website or dataset syncs on its own. New crawl options delete the documents whose path they leave out. When that would delete all of the source's documents, or five or more that are over a fifth of them, the request returns `409` with code `sourceDeletionsUnconfirmed` until you send it again with `confirmDeletions` set to `true`. New crawl options sent while the source syncs return `409` with code `syncInProgress`; send them again once the sync finishes. A new query queues a sync, which removes the documents the query no longer selects.
     *
     *     Crawl options on a source that isn't a website, a query on one that isn't a dataset, or a sync frequency on a `files` source, return `422` with code `sourceTypeMismatch`. Setting a sync frequency on a plan without scheduled syncs returns `403` with code `featureNotInPlan`; setting it to `null` always works.
     */
    patch: operations['updateSource']
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/sources/{sourceId}/syncs': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * List a source's syncs
     * @description Lists the syncs of a source, newest first. Results are cursor-paginated.
     */
    get: operations['listSyncs']
    put?: never
    /**
     * Sync a source
     * @description Starts a sync of the source. A website or dataset is read again: its sync is queued, and starts once any sync of the source that is running ends, including the first one that started when it was added. Asking again while one waits queues nothing more. Follow it with the source's `latestSync`.
     *
     *     For a `files` source, set `uploadId` to the upload whose file the source should hold from now on; without it, the source reads its current file again. Its sync starts at once and returns a job ID to poll; the finished job's `result` names the sync and whether it is `held`. While a sync of a `files` source is running, including the first one, the request returns `409` with code `syncInProgress` and leaves the upload for a later request. An `uploadId` whose file never arrived returns `404` with code `uploadNotFound`, and an `uploadId` on a source that isn't `files` returns `422` with code `sourceTypeMismatch`.
     *
     *     Supports the `Idempotency-Key` header.
     */
    post: operations['startSync']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/sources/{sourceId}/syncs/{syncId}': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get a sync
     * @description Returns one sync of a source with its status and counts.
     */
    get: operations['getSync']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/sources/{sourceId}/syncs/{syncId}/confirm': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Confirm a held sync's deletions
     * @description Deletes the documents a `held` sync didn't find, unless a sync has found them since, completes the sync, and starts a refresh of each knowledge base that uses the source, which removes their citations from entries. A sync that isn't `held` returns `409` with code `syncNotHeld`.
     */
    post: operations['confirmSync']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/sources/{sourceId}/syncs/{syncId}/discard': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Discard a held sync's deletions
     * @description Completes a `held` sync without deleting anything: every document stays as it is. A sync that isn't `held` returns `409` with code `syncNotHeld`.
     */
    post: operations['discardSync']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/sources/{sourceId}/uploads': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Upload a file to a source
     * @description Returns a single-use signed URL for one file of a `files` source, valid for one hour. To add the file:
     *
     *     1. Send the file in a `PUT` request to `uploadUrl`.
     *     2. Call `POST .../sources/{sourceId}/syncs` with the `uploadId`.
     *
     *     The file can be a single document or a zip, tar or gzip archive of them. It replaces the source's current file when it syncs. An upload no sync takes within 24 hours is deleted. A source that isn't `files` returns `422` with code `sourceTypeMismatch`. When the organization's knowledge bases already hold as many source chunks as its plan allows, returns `403` with code `planLimitReached`. Supports the `Idempotency-Key` header.
     */
    post: operations['startSourceUpload']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/knowledge-bases/{knowledgeBaseId}/sync': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Sync every source
     * @description Queues a sync of every website and dataset source, which starts once any sync of the source that is running ends. `files` sources sync when you upload a file. New documents, from these syncs or waiting from earlier ones, are then placed in the knowledge base right away instead of waiting to be placed together with the documents that follow them. This covers the documents that arrive within an hour of the request. A refresh writes a limited number of entries, so a large batch is placed over several refreshes.
     */
    post: operations['syncAllSources']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/organizations/{organizationId}/conversations/{threadId}': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    /**
     * Record a conversation
     * @description Creates or updates the recorded conversation for one thread. `threadId` identifies the conversation within your organization, so saving with the same `threadId` updates the same conversation. Requires Context Editor access or higher.
     *
     *     Each save replaces the stored messages. `metadata`, `sharing`, and the model fields change only when you include them. `tokenUsage` is cumulative: send the usage for one generation call, and the API adds it to the conversation total. Usage is added only when the save changes the messages, so retries don't count it twice.
     *
     *     To report a failure, set `error` on the message where it happened: the tool result for a failed tool call, or the assistant message for a turn that failed instead of answering. The Insights dashboard highlights conversations with a failed turn and counts failed tool calls separately, because agents often recover from them.
     *
     *     The last write for a thread wins, so retries are safe. `sharing` records whether you share telemetry with Sanity: metrics only, or full transcripts.
     */
    put: operations['saveConversation']
    post?: never
    /**
     * Delete a conversation
     * @description Deletes the recorded conversation for one thread, including its messages and classification. Requires the same access as recording a conversation.
     *
     *     Saving with the same `threadId` afterwards records a new conversation.
     */
    delete: operations['deleteConversation']
    options?: never
    head?: never
    /**
     * Record a conversation classification
     * @description Records the classification your own model produced for one thread. Send exactly one of these fields:
     *
     *     - `coreMetrics`: the classification result. The API sets `classifiedAt` and clears any recorded failure.
     *     - `classificationError`: why classification failed. Any earlier result stays unchanged.
     *
     *     Requires the same access as recording a conversation. The last write wins, so a new classification replaces the previous one.
     */
    patch: operations['classifyConversation']
    trace?: never
  }
  '/{apiVersion}/context/organizations/{organizationId}/mcp': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Create an MCP endpoint
     * @description Creates an MCP endpoint with a title, a name, and the sources it serves. A source is a knowledge base, identified by its ID (`kb…`), or a dataset, identified as `<projectId>.<datasetName>`. An endpoint can serve any number of knowledge bases and at most one dataset, all at once. A GROQ filter is only kept when the endpoint has a dataset. The name must be unique in your organization, and you can't change it later. Duplicate sources with the same `type` and `id` are combined. The response includes the `url` agents connect to. To list or inspect endpoints, query `sanity.context.mcp` documents with GROQ from your organization's document store. Requires the `sanity.context.mcp.create` grant on the organization, which the Administrator and Developer roles have. Adding a dataset also requires full read access to the dataset and, on its project, the Administrator or Developer role or a custom role that can create datasets.
     *
     *     A taken name returns `409` with code `mcpEndpointNameConflict`. A knowledge base that doesn't exist in the organization returns `422` with code `mcpSourceKnowledgeBaseNotFound`, and an invalid GROQ filter returns `422` with code `invalidGroqFilter`.
     */
    post: operations['createMcpEndpoint']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/organizations/{organizationId}/mcp/{mcpEndpoint}': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Connect to an MCP endpoint
     * @description Receives Model Context Protocol (MCP) messages from agents over streamable HTTP (JSON-RPC 2.0). Agents send MCP messages in `POST` requests to this URL. `mcpEndpoint` is the permanent URL name of the endpoint. Errors are JSON-RPC error objects, not the standard error response.
     */
    post: operations['serveMcpEndpoint']
    /**
     * Delete an MCP endpoint
     * @description Deletes the MCP endpoint with that name or ID. Agents connected through it lose access, and its name can be used again. Requires the `sanity.context.mcp.delete` grant on the organization. An unknown endpoint returns `404` with code `mcpEndpointNotFound`.
     */
    delete: operations['deleteMcpEndpoint']
    options?: never
    head?: never
    /**
     * Update an MCP endpoint
     * @description Updates the title, sources, instructions, or GROQ filter of the endpoint with that name or ID. To clear an optional field, set it to `null`. An endpoint can have at most one dataset source, and removing it clears the GROQ filter. You can't change the name, so the endpoint URL stays the same. Requires the `sanity.context.mcp.update` grant on the organization. Adding a dataset source requires full read access to the dataset and, on its project, the Administrator or Developer role or a custom role that can create datasets. Changing the GROQ filter requires the same access for the endpoint's dataset. Sending the current values changes nothing.
     *
     *     An unknown endpoint returns `404` with code `mcpEndpointNotFound`. A knowledge base that doesn't exist in the organization returns `422` with code `mcpSourceKnowledgeBaseNotFound`, and an invalid GROQ filter returns `422` with code `invalidGroqFilter`. If the endpoint changed while the update was in progress, the update returns `409` with code `mcpEndpointEditConflict` and changes nothing. You can safely retry it.
     */
    patch: operations['updateMcpEndpoint']
    trace?: never
  }
  '/{apiVersion}/context/organizations/{organizationId}/mcp/{mcpEndpoint}/initial-context': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get an MCP endpoint's initial context
     * @description Returns the same text as the `initial_context` MCP tool, as plain text you can add to a system prompt. `heading_offset` shifts markdown headings down by that many levels. The default is `1`, so `#` becomes `##`.
     */
    get: operations['getMcpEndpointInitialContext']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/{apiVersion}/context/organizations/{organizationId}/mcp/{mcpEndpoint}/status': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Check an MCP endpoint
     * @description Checks whether the endpoint is ready for agents, and whether your credentials can read what it serves. A failed check returns `200` with that check's `ok` set to `false`, so you can see every problem at once. `ready` summarizes the result. Returns `404` if the endpoint doesn't exist.
     */
    get: operations['getMcpEndpointStatus']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
}
export type webhooks = Record<string, never>
export interface components {
  schemas: {
    /** @description The body of every error response. Branch on `code`, a stable identifier; `message` is human-readable and can change. */
    ApiErrorBody: {
      statusCode: number
      error: string
      /** @enum {string} */
      code:
        | 'knowledgeBaseNotFound'
        | 'jobNotFound'
        | 'sourceNotFound'
        | 'documentNotFound'
        | 'syncNotFound'
        | 'uploadNotFound'
        | 'chunkNotFound'
        | 'entryNotFound'
        | 'entryDocumentInvalid'
        | 'revisionNotFound'
        | 'revisionNotBrowsable'
        | 'revisionNotRestorable'
        | 'buildDecisionsNotFound'
        | 'issueNotFound'
        | 'instructionNotFound'
        | 'routeNotFound'
        | 'buildInFlight'
        | 'knowledgeBaseIsDraft'
        | 'webSourceRootConflict'
        | 'webSourceRootLimitExceeded'
        | 'preferenceLimitExceeded'
        | 'syncInProgress'
        | 'syncNotHeld'
        | 'sourceDeletionsUnconfirmed'
        | 'documentNotConverted'
        | 'documentNotStored'
        | 'documentInvalidState'
        | 'uploadTooLarge'
        | 'payloadTooLarge'
        | 'validationError'
        | 'unsupportedMediaType'
        | 'sourceTypeMismatch'
        | 'issueNotResolvable'
        | 'issueNotAutoApplicable'
        | 'issueDocumentInvalid'
        | 'issueTransitionConflict'
        | 'draftTitleRequired'
        | 'datasetSourceEmpty'
        | 'datasetAlreadyBound'
        | 'datasetSourceNotBound'
        | 'datasetReadAccessDenied'
        | 'invalidGroqFilter'
        | 'mcpEndpointNotFound'
        | 'mcpEndpointNameConflict'
        | 'mcpEndpointEditConflict'
        | 'mcpSourceKnowledgeBaseNotFound'
        | 'mcpEndpointNotServable'
        | 'conversationNotFound'
        | 'missingCredential'
        | 'invalidCredential'
        | 'missingOrganization'
        | 'organizationAccessDenied'
        | 'knowledgeBaseAccessDenied'
        | 'contextGrantRequired'
        | 'knowledgeBaseCreateAccessDenied'
        | 'mcpEndpointManageAccessDenied'
        | 'insightsWriteAccessDenied'
        | 'sharedOrgPreferencesWriteAccessDenied'
        | 'projectAdminRequired'
        | 'accessCheckFailed'
        | 'planLimitReached'
        | 'featureNotInPlan'
        | 'buildCapReached'
        | 'tooManyConnections'
        | 'jobsUnavailable'
        | 'contextStoreUnavailable'
        | 'crawlingUnavailable'
        | 'crawlPreviewUnavailable'
        | 'instructionDraftFailed'
        | 'instructionScopeVanished'
        | 'purposeDraftFailed'
        | 'noPurposeEvidence'
        | 'idempotencyKeyReused'
        | 'idempotencyRequestInFlight'
        | 'idempotencyParamsMismatch'
        | 'internal'
      message: string
      fields?: {
        [key: string]: unknown
      }
    }
    /** @description A `sanity.context.conversation` document: one agent conversation and its classification, stored in your organization's document store. No endpoint returns this document. Use this schema to type GROQ query results. To record conversations, use the conversations endpoints. */
    ConversationDoc: {
      /** @description The document ID. */
      _id: string
      /** @description The document revision. It changes on every write. */
      _rev: string
      /**
       * Format: date-time
       * @description When the document was created, as an ISO 8601 timestamp.
       */
      _createdAt: string
      /**
       * Format: date-time
       * @description When the document was last changed, as an ISO 8601 timestamp.
       */
      _updatedAt: string
      /**
       * @description The document type. Always `sanity.context.conversation`.
       * @enum {string}
       */
      _type: 'sanity.context.conversation'
      /**
       * @description The version of the document shape. Currently `1`.
       * @enum {number}
       */
      schemaVersion: 1
      /** @description The ID of the organization that owns the conversation. Filter on it in every query, because the document store also holds documents from other features. */
      organizationId: string
      /** @description Your identifier for the conversation thread, unique within the organization. It is the `threadId` in the conversations endpoint path and determines the document `_id`. */
      threadId: string
      /** @description Tags that describe the conversation, such as `mcpEndpoints`, `app`, and `environment`. Filter on them in GROQ queries. `null` until a save includes `metadata`. */
      metadata: {
        [key: string]: string | string[]
      } | null
      /**
       * Format: date-time
       * @description When the API received the first save for this thread, as an ISO 8601 timestamp.
       */
      startedAt: string
      /**
       * Format: date-time
       * @description When the conversation was last saved, as an ISO 8601 timestamp.
       */
      messagesUpdatedAt: string
      /** @description The conversation transcript, in order. Each save replaces it. */
      messages: {
        /**
         * @description Who sent the message. `user` is the person talking to the agent, `assistant` is the agent, `system` is a system prompt, and `tool` is a tool call or tool result.
         * @enum {string}
         */
        role: 'user' | 'assistant' | 'system' | 'tool'
        /**
         * @description The message text. `null` when the message has no text, such as a tool call.
         * @default null
         */
        content: string | null
        /**
         * @description The name of the tool for a `tool` message. `null` on other messages.
         * @default null
         */
        toolName: string | null
        /**
         * @description The kind of `tool` message. `call` is the agent calling the tool, and `result` is what the tool returned. `null` on other messages.
         * @default null
         * @enum {string|null}
         */
        toolType: 'call' | 'result' | null
        /**
         * @description Why this step failed, including any stack trace. Set it on the tool result for a failed tool call, or on the assistant message for a turn that failed instead of answering. `null` when the step succeeded.
         * @default null
         */
        error: string | null
        /**
         * Format: date-time
         * @description When the API first received this message, as an ISO 8601 timestamp. The API sets it. Resending an unchanged message at the same position keeps its timestamp. `null` for messages recorded before timestamps existed.
         * @default null
         */
        timestamp: string | null
      }[]
      /** @description The provider of the model the agent used. `null` until a save includes `modelProvider`. */
      modelProvider: string | null
      /** @description The ID of the model the agent used. `null` until a save includes `modelId`. */
      modelId: string | null
      /** @description The running total of token usage for the conversation. `null` until a save includes `tokenUsage`. */
      tokenUsage: {
        /** @description The number of input tokens. */
        inputTokens?: number
        /** @description The number of output tokens. */
        outputTokens?: number
        /** @description The total number of tokens. */
        totalTokens?: number
      } | null
      /** @description The latest classification result. `null` until you record one. */
      coreMetrics: {
        /** @description How well the agent resolved the user's needs, from 1 to 10. */
        successScore?: number
        /**
         * @description The overall sentiment of the conversation.
         * @enum {string}
         */
        sentiment?: 'positive' | 'neutral' | 'negative'
        /** @description Topics the agent couldn't answer because it lacked content. */
        contentGaps?: string[]
      } | null
      /**
       * Format: date-time
       * @description When the latest classification result was recorded, as an ISO 8601 timestamp. The API sets it. `null` until you record a result.
       */
      classifiedAt: string | null
      /** @description Why your classifier couldn't classify the conversation. `null` when no failure is recorded. Recording a result clears it. */
      classificationError: string | null
      /**
       * @description Your choice to share conversation telemetry with Sanity. `null` until a save includes `sharing`.
       * @default null
       */
      sharing: {
        /** @description Whether to share classification metrics with Sanity: scores, sentiment, content gap counts, message counts and sizes, tool names, and model and token usage. Message content is not included. */
        metrics?: boolean
        /** @description Whether to share full conversation transcripts with Sanity. When `true`, the API also sets `metrics` to `true`. */
        conversations?: boolean
        /** @description How the Sanity team can reach you about your agent, such as an email address or a Discord handle. */
        contact?: string
      } | null
      /**
       * Format: date-time
       * @description When the conversation was last saved, edited or classified through the API, as an ISO 8601 timestamp. Unlike `_updatedAt`, no other write to the document changes it.
       */
      updatedAt?: string
    }
    /** @description A `sanity.context.entry` document: one entry in a knowledge base outline, stored in your organization's document store. No endpoint returns this document. Use this schema to type GROQ query results. */
    EntryDoc: {
      /** @description The document ID. */
      _id: string
      /** @description The document revision. It changes on every write. */
      _rev: string
      /**
       * Format: date-time
       * @description When the document was created, as an ISO 8601 timestamp.
       */
      _createdAt: string
      /**
       * Format: date-time
       * @description When the document was last changed, as an ISO 8601 timestamp.
       */
      _updatedAt: string
      /** @description The ID (`kb…`) of the knowledge base this document belongs to. */
      knowledgeBaseId: string
      /**
       * @description The document type. Always `sanity.context.entry`.
       * @enum {string}
       */
      _type: 'sanity.context.entry'
      /** @description The version of the document shape. Currently `3`. */
      schemaVersion: number
      /** @description The ID of the build that last wrote this entry's content. An unchanged entry keeps its earlier value across builds. */
      revisionId: string
      /** @description The entry's slash-delimited path, such as `docs/api/webhooks`. Order entries by `path` to get the knowledge base outline. */
      path: string
      /** @description The entry title. */
      title: string
      /** @description The titles of the sections above the entry, top level first, one for each `path` segment before the last. For `groq/functions/math` it holds the titles of `groq` and `groq/functions`. Absent when the entry was written before section titles were recorded. */
      sectionTitles?: string[]
      /** @description A summary of the entry. `scope` is what the entry covers, and `excludes` is what it does not cover. `neighbors` lists the paths of related entries. */
      tldr?: {
        scope: string
        excludes: string
        neighbors?: string[]
      }
      /** @description The entry content in Markdown, with inline `[^key]` footnote markers. The text after `^` in each marker is the `_key` of one item in `citations`. Absent when the entry has no content of its own, such as a `virtual` entry. */
      body?: string
      /** @description The H2 and H3 heading titles in `body`. Absent when the entry has no `body`. */
      topicHeadings?: string[]
      /** @description The passages that back this entry, one item per quoted passage, in the order the body first uses them. A document cited twice with different quotes has two items. Empty when the entry has no `body` or the body cites nothing. */
      citations: {
        /** @description Stable ID of this citation: 10 lowercase letters and digits. An entry body points to it with a `[^key]` marker. */
        _key: string
        /** @enum {string} */
        _type: 'sanity.context.citation'
        /** @description ID of the document the quote comes from. Read it with `GET .../documents/{documentId}/content`. */
        documentId: string
        /** @description ID of the chunk of the document that holds the quote's first line. A chunk is the text under one heading, and keeps its ID across versions of the document while its headings stay the same. */
        chunkId: string
        /** @description The document's name when the entry was written. */
        title: string
        /** @description Where the document lives on the web. Absent for uploaded files and datasets. */
        url?: string
        /** @description The passage from the document that backs the claims, copied word for word. */
        quote: string
        /** @description Up to 32 characters of document text just before the quote, to tell repeats apart. */
        prefix: string
        /** @description Up to 32 characters of document text just after the quote, to tell repeats apart. */
        suffix: string
        /** @description First line of the quote in the document, counting from 1. Line numbers match `GET .../documents/{documentId}/content`. A hint: the quote is the stable locator. */
        lineStart: number
        /** @description Last line of the quote, inclusive. */
        lineEnd: number
        /** @description The statements in the entry body that this passage backs. */
        claims: string[]
      }[]
      /** @description The IDs of every document the entry was built from, cited or not, sorted. Every citation `documentId` is in this list. */
      documentIds: string[]
      /**
       * @description The entry state. Builds currently write only two values: `virtual` for an entry that groups child entries and has no `body`, and `filled` for an entry with a written `body`. The other values are reserved.
       * @enum {string}
       */
      status: 'virtual' | 'outlined' | 'filled' | 'stale' | 'generation_failed'
      /** @description When the build that last wrote this entry's content ran, as an ISO 8601 timestamp. */
      generatedAt: string
      /**
       * Format: date-time
       * @description When the entry's content last changed, by a build, a restore or a source being removed. A build that writes the same content leaves it alone, as an ISO 8601 timestamp. Unlike `_updatedAt`, no other write to the document changes it.
       */
      updatedAt?: string
    }
    /** @description A `sanity.context.instruction` document: a standing instruction that steers every build, stored in your organization's document store. No endpoint returns this document. Use this schema to type GROQ query results. To change instructions, use the instructions endpoints. */
    InstructionDoc:
      | {
          /** @description The document ID. */
          _id: string
          /** @description The document revision. It changes on every write. */
          _rev: string
          /**
           * Format: date-time
           * @description When the document was created, as an ISO 8601 timestamp.
           */
          _createdAt: string
          /**
           * Format: date-time
           * @description When the document was last changed, as an ISO 8601 timestamp.
           */
          _updatedAt: string
          /** @description The ID (`kb…`) of the knowledge base this document belongs to. */
          knowledgeBaseId: string
          /**
           * @description The document type. Always `sanity.context.instruction`.
           * @enum {string}
           */
          _type: 'sanity.context.instruction'
          /**
           * @description The version of the document shape. Currently `2`. An instruction without the current version doesn't appear in lists and doesn't affect builds.
           * @enum {number}
           */
          schemaVersion: 2
          /** @description The instruction, in plain language. Builds follow it over the raw sources. */
          statement: string
          /** @description The documents the instruction is tied to. The instruction affects the entries built from these documents. The API always sets at least one document. When `null`, the instruction isn't tied to any document and doesn't affect builds. */
          scopeDocuments:
            | {
                /** @description A unique key for this item in the array. It matches `documentId`. */
                _key: string
                /** @description The ID of the document the instruction is tied to. */
                documentId: string
                /** @description The document's content hash when the instruction was last checked against it. When the document's content changes, the instruction is checked again. */
                contentHash: string
              }[]
            | null
          /**
           * @description The instruction state. `active` instructions apply to every build. `archived` instructions don't apply: a document changed and no longer supports the instruction. Editing an archived instruction makes it `active` again.
           * @enum {string}
           */
          status: 'active' | 'archived'
          /** @description When the instruction was archived, as an ISO 8601 timestamp. `null` while `active`. */
          archivedAt: string | null
          /** @description Why the instruction was archived. `null` while `active`. */
          archivedReason: string | null
          /**
           * Format: date-time
           * @description When the instruction was last created or changed through the API, or archived or re-evaluated by a refresh, as an ISO 8601 timestamp. Unlike `_updatedAt`, no other write to the document changes it.
           */
          updatedAt?: string
          /**
           * @description Where the instruction came from. `conflict` means it was created when you resolved a conflict issue.
           * @enum {string}
           */
          origin: 'conflict'
          /** @description The `_id` of the conflict issue this instruction resolved. Reopening that issue deletes this instruction. */
          sourceIssueId: string
        }
      | {
          /** @description The document ID. */
          _id: string
          /** @description The document revision. It changes on every write. */
          _rev: string
          /**
           * Format: date-time
           * @description When the document was created, as an ISO 8601 timestamp.
           */
          _createdAt: string
          /**
           * Format: date-time
           * @description When the document was last changed, as an ISO 8601 timestamp.
           */
          _updatedAt: string
          /** @description The ID (`kb…`) of the knowledge base this document belongs to. */
          knowledgeBaseId: string
          /**
           * @description The document type. Always `sanity.context.instruction`.
           * @enum {string}
           */
          _type: 'sanity.context.instruction'
          /**
           * @description The version of the document shape. Currently `2`. An instruction without the current version doesn't appear in lists and doesn't affect builds.
           * @enum {number}
           */
          schemaVersion: 2
          /** @description The instruction, in plain language. Builds follow it over the raw sources. */
          statement: string
          /** @description The documents the instruction is tied to. The instruction affects the entries built from these documents. The API always sets at least one document. When `null`, the instruction isn't tied to any document and doesn't affect builds. */
          scopeDocuments:
            | {
                /** @description A unique key for this item in the array. It matches `documentId`. */
                _key: string
                /** @description The ID of the document the instruction is tied to. */
                documentId: string
                /** @description The document's content hash when the instruction was last checked against it. When the document's content changes, the instruction is checked again. */
                contentHash: string
              }[]
            | null
          /**
           * @description The instruction state. `active` instructions apply to every build. `archived` instructions don't apply: a document changed and no longer supports the instruction. Editing an archived instruction makes it `active` again.
           * @enum {string}
           */
          status: 'active' | 'archived'
          /** @description When the instruction was archived, as an ISO 8601 timestamp. `null` while `active`. */
          archivedAt: string | null
          /** @description Why the instruction was archived. `null` while `active`. */
          archivedReason: string | null
          /**
           * Format: date-time
           * @description When the instruction was last created or changed through the API, or archived or re-evaluated by a refresh, as an ISO 8601 timestamp. Unlike `_updatedAt`, no other write to the document changes it.
           */
          updatedAt?: string
          /**
           * @description Where the instruction came from. `human` means it was created directly through the API or the dashboard.
           * @enum {string}
           */
          origin: 'human'
          /**
           * @description Always `null` for a `human` instruction.
           * @enum {string|null}
           */
          sourceIssueId: null
        }
    /** @description A `sanity.context.issue` document: a build finding waiting for triage, stored in your organization's document store. No endpoint returns this document. Use this schema to type GROQ query results and Sanity Function filters. To change an issue's status, use the issues endpoints. Only a `conflict` issue can have a non-null `resolution`. */
    IssueDoc:
      | {
          /** @description The document ID. */
          _id: string
          /** @description The document revision. It changes on every write. */
          _rev: string
          /**
           * Format: date-time
           * @description When the document was created, as an ISO 8601 timestamp.
           */
          _createdAt: string
          /**
           * Format: date-time
           * @description When the document was last changed, as an ISO 8601 timestamp.
           */
          _updatedAt: string
          /** @description The ID (`kb…`) of the knowledge base this document belongs to. */
          knowledgeBaseId: string
          /**
           * @description The document type. Always `sanity.context.issue`.
           * @enum {string}
           */
          _type: 'sanity.context.issue'
          /**
           * @description The version of the document shape. Currently `2`.
           * @enum {number}
           */
          schemaVersion: 2
          /** @description What an issue found. The shape depends on `kind`. */
          content:
            | {
                /**
                 * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                 * @enum {string}
                 */
                severity: 'critical' | 'suggestion'
                /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                scopePath: string
                /** @description What the problem is, in one or two sentences. */
                issue: string
                /** @description What to do to fix the issue. */
                suggestedFix: string
                /**
                 * @description The issue type. `conflict` means two or more positions disagree on the same fact, and you choose which one is correct.
                 * @enum {string}
                 */
                kind: 'conflict'
                /** @description A key naming the disputed fact, such as `free_tier.request_limit`. It never includes the disputed value, so every side shares it. */
                claimKey: string
                /** @description One sentence that explains the question, when it needs one. */
                context?: string
                /** @description The conflicting positions, at least two. To resolve the conflict, pass the index of one side as `resolution`. */
                sides: {
                  /** @description The position as a self-contained sentence. This is the option you choose from. */
                  claim: string
                  /** @description The disputed value on its own, such as `10,000/month`, without the sentence. */
                  value?: string
                  /** @description Paths of the entries that state this position. */
                  entryPaths?: string[]
                  /** @description IDs of the documents that directly back this position. */
                  documentIds?: string[]
                  /** @description The documents that state this value, by the names you know them by. */
                  where?: string
                  /** @description Quotes from the documents that state this value, copied word for word and checked against each document. A document whose wording could not be checked has none. */
                  citations?: {
                    /** @description Stable ID of this citation: 10 lowercase letters and digits. An entry body points to it with a `[^key]` marker. */
                    _key: string
                    /** @enum {string} */
                    _type: 'sanity.context.citation'
                    /** @description ID of the document the quote comes from. Read it with `GET .../documents/{documentId}/content`. */
                    documentId: string
                    /** @description ID of the chunk of the document that holds the quote's first line. A chunk is the text under one heading, and keeps its ID across versions of the document while its headings stay the same. */
                    chunkId: string
                    /** @description The document's name when the entry was written. */
                    title: string
                    /** @description Where the document lives on the web. Absent for uploaded files and datasets. */
                    url?: string
                    /** @description The passage from the document that backs the claims, copied word for word. */
                    quote: string
                    /** @description Up to 32 characters of document text just before the quote, to tell repeats apart. */
                    prefix: string
                    /** @description Up to 32 characters of document text just after the quote, to tell repeats apart. */
                    suffix: string
                    /** @description First line of the quote in the document, counting from 1. Line numbers match `GET .../documents/{documentId}/content`. A hint: the quote is the stable locator. */
                    lineStart: number
                    /** @description Last line of the quote, inclusive. */
                    lineEnd: number
                  }[]
                  /**
                   * @description How much weight the sources behind this position carry. `primary`: your own content, such as uploaded files and pages on your own site. `secondary`: other sources. `community`: forums and Q&A sites.
                   * @enum {string}
                   */
                  authority?: 'primary' | 'secondary' | 'community'
                }[]
                /** @description Index in `sides` of the suggested side, when there is one. It is only a hint: nothing is chosen until you resolve the issue. */
                suggested?: number
              }
            | {
                /**
                 * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                 * @enum {string}
                 */
                severity: 'critical' | 'suggestion'
                /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                scopePath: string
                /** @description What the problem is, in one or two sentences. */
                issue: string
                /** @description What to do to fix the issue. */
                suggestedFix: string
                /**
                 * @description The issue type. `update_required` means an entry is out of date with its sources or contradicts an instruction, and needs a rewrite.
                 * @enum {string}
                 */
                kind: 'update_required'
                /** @description IDs of the documents that led to the issue. */
                citedDocumentIds?: string[]
                /** @description A key naming the specific finding, when the check that found it sets one. */
                claimKey?: string
                /** @description Paths of the entries the issue involves, when it spans more than one entry. */
                involvedScopes?: string[]
              }
          /** @description An identity for the finding that doesn't depend on its wording. It determines the issue's `_id`, so a reworded finding updates the same issue. */
          fingerprint: string
          /** @description The ID of the build that filed this issue. `null` when the issue was filed outside a build, such as when removing a document leaves an entry without documents. */
          revisionId: string | null
          /**
           * Format: date-time
           * @description When the issue was last filed, refiled or triaged, as an ISO 8601 timestamp. Unlike `_updatedAt`, no other write to the document changes it.
           */
          updatedAt?: string
          /**
           * @description The issue status. `open` means it is waiting for triage.
           * @enum {string}
           */
          status: 'open'
          /**
           * @description Always `null` while the issue is `open`.
           * @enum {string|null}
           */
          resolution: null
          /**
           * @description Always `null` while the issue is `open`.
           * @enum {string|null}
           */
          resolvedAt: null
          /**
           * @description Always `null` while the issue is `open`.
           * @enum {string|null}
           */
          resolvedBy: null
        }
      | {
          /** @description The document ID. */
          _id: string
          /** @description The document revision. It changes on every write. */
          _rev: string
          /**
           * Format: date-time
           * @description When the document was created, as an ISO 8601 timestamp.
           */
          _createdAt: string
          /**
           * Format: date-time
           * @description When the document was last changed, as an ISO 8601 timestamp.
           */
          _updatedAt: string
          /** @description The ID (`kb…`) of the knowledge base this document belongs to. */
          knowledgeBaseId: string
          /**
           * @description The document type. Always `sanity.context.issue`.
           * @enum {string}
           */
          _type: 'sanity.context.issue'
          /**
           * @description The version of the document shape. Currently `2`.
           * @enum {number}
           */
          schemaVersion: 2
          /** @description What an issue found. The shape depends on `kind`. */
          content:
            | {
                /**
                 * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                 * @enum {string}
                 */
                severity: 'critical' | 'suggestion'
                /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                scopePath: string
                /** @description What the problem is, in one or two sentences. */
                issue: string
                /** @description What to do to fix the issue. */
                suggestedFix: string
                /**
                 * @description The issue type. `conflict` means two or more positions disagree on the same fact, and you choose which one is correct.
                 * @enum {string}
                 */
                kind: 'conflict'
                /** @description A key naming the disputed fact, such as `free_tier.request_limit`. It never includes the disputed value, so every side shares it. */
                claimKey: string
                /** @description One sentence that explains the question, when it needs one. */
                context?: string
                /** @description The conflicting positions, at least two. To resolve the conflict, pass the index of one side as `resolution`. */
                sides: {
                  /** @description The position as a self-contained sentence. This is the option you choose from. */
                  claim: string
                  /** @description The disputed value on its own, such as `10,000/month`, without the sentence. */
                  value?: string
                  /** @description Paths of the entries that state this position. */
                  entryPaths?: string[]
                  /** @description IDs of the documents that directly back this position. */
                  documentIds?: string[]
                  /** @description The documents that state this value, by the names you know them by. */
                  where?: string
                  /** @description Quotes from the documents that state this value, copied word for word and checked against each document. A document whose wording could not be checked has none. */
                  citations?: {
                    /** @description Stable ID of this citation: 10 lowercase letters and digits. An entry body points to it with a `[^key]` marker. */
                    _key: string
                    /** @enum {string} */
                    _type: 'sanity.context.citation'
                    /** @description ID of the document the quote comes from. Read it with `GET .../documents/{documentId}/content`. */
                    documentId: string
                    /** @description ID of the chunk of the document that holds the quote's first line. A chunk is the text under one heading, and keeps its ID across versions of the document while its headings stay the same. */
                    chunkId: string
                    /** @description The document's name when the entry was written. */
                    title: string
                    /** @description Where the document lives on the web. Absent for uploaded files and datasets. */
                    url?: string
                    /** @description The passage from the document that backs the claims, copied word for word. */
                    quote: string
                    /** @description Up to 32 characters of document text just before the quote, to tell repeats apart. */
                    prefix: string
                    /** @description Up to 32 characters of document text just after the quote, to tell repeats apart. */
                    suffix: string
                    /** @description First line of the quote in the document, counting from 1. Line numbers match `GET .../documents/{documentId}/content`. A hint: the quote is the stable locator. */
                    lineStart: number
                    /** @description Last line of the quote, inclusive. */
                    lineEnd: number
                  }[]
                  /**
                   * @description How much weight the sources behind this position carry. `primary`: your own content, such as uploaded files and pages on your own site. `secondary`: other sources. `community`: forums and Q&A sites.
                   * @enum {string}
                   */
                  authority?: 'primary' | 'secondary' | 'community'
                }[]
                /** @description Index in `sides` of the suggested side, when there is one. It is only a hint: nothing is chosen until you resolve the issue. */
                suggested?: number
              }
            | {
                /**
                 * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                 * @enum {string}
                 */
                severity: 'critical' | 'suggestion'
                /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                scopePath: string
                /** @description What the problem is, in one or two sentences. */
                issue: string
                /** @description What to do to fix the issue. */
                suggestedFix: string
                /**
                 * @description The issue type. `update_required` means an entry is out of date with its sources or contradicts an instruction, and needs a rewrite.
                 * @enum {string}
                 */
                kind: 'update_required'
                /** @description IDs of the documents that led to the issue. */
                citedDocumentIds?: string[]
                /** @description A key naming the specific finding, when the check that found it sets one. */
                claimKey?: string
                /** @description Paths of the entries the issue involves, when it spans more than one entry. */
                involvedScopes?: string[]
              }
          /** @description An identity for the finding that doesn't depend on its wording. It determines the issue's `_id`, so a reworded finding updates the same issue. */
          fingerprint: string
          /** @description The ID of the build that filed this issue. `null` when the issue was filed outside a build, such as when removing a document leaves an entry without documents. */
          revisionId: string | null
          /**
           * Format: date-time
           * @description When the issue was last filed, refiled or triaged, as an ISO 8601 timestamp. Unlike `_updatedAt`, no other write to the document changes it.
           */
          updatedAt?: string
          /**
           * @description The issue status. `accepted` means the issue was resolved or its fix applied.
           * @enum {string}
           */
          status: 'accepted'
          /**
           * Format: date-time
           * @description When the issue left `open`, as an ISO 8601 timestamp.
           */
          resolvedAt: string
          /** @description Who triaged the issue. `null` while the issue is open, or when the caller could not be identified. */
          resolvedBy: {
            /** @description The ID of the Sanity user or robot token that triaged the issue. */
            id: string
            /**
             * @description What triaged the issue. `user` is a person, and `robot` is a robot token.
             * @enum {string}
             */
            kind: 'user' | 'robot'
          } | null
          /** @description The index of the chosen side in `content.sides`. For a conflict on one entry, index `0` is the entry's own position. `null` when the fix was applied without choosing a side. */
          resolution: number | null
        }
      | {
          /** @description The document ID. */
          _id: string
          /** @description The document revision. It changes on every write. */
          _rev: string
          /**
           * Format: date-time
           * @description When the document was created, as an ISO 8601 timestamp.
           */
          _createdAt: string
          /**
           * Format: date-time
           * @description When the document was last changed, as an ISO 8601 timestamp.
           */
          _updatedAt: string
          /** @description The ID (`kb…`) of the knowledge base this document belongs to. */
          knowledgeBaseId: string
          /**
           * @description The document type. Always `sanity.context.issue`.
           * @enum {string}
           */
          _type: 'sanity.context.issue'
          /**
           * @description The version of the document shape. Currently `2`.
           * @enum {number}
           */
          schemaVersion: 2
          /** @description What an issue found. The shape depends on `kind`. */
          content:
            | {
                /**
                 * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                 * @enum {string}
                 */
                severity: 'critical' | 'suggestion'
                /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                scopePath: string
                /** @description What the problem is, in one or two sentences. */
                issue: string
                /** @description What to do to fix the issue. */
                suggestedFix: string
                /**
                 * @description The issue type. `conflict` means two or more positions disagree on the same fact, and you choose which one is correct.
                 * @enum {string}
                 */
                kind: 'conflict'
                /** @description A key naming the disputed fact, such as `free_tier.request_limit`. It never includes the disputed value, so every side shares it. */
                claimKey: string
                /** @description One sentence that explains the question, when it needs one. */
                context?: string
                /** @description The conflicting positions, at least two. To resolve the conflict, pass the index of one side as `resolution`. */
                sides: {
                  /** @description The position as a self-contained sentence. This is the option you choose from. */
                  claim: string
                  /** @description The disputed value on its own, such as `10,000/month`, without the sentence. */
                  value?: string
                  /** @description Paths of the entries that state this position. */
                  entryPaths?: string[]
                  /** @description IDs of the documents that directly back this position. */
                  documentIds?: string[]
                  /** @description The documents that state this value, by the names you know them by. */
                  where?: string
                  /** @description Quotes from the documents that state this value, copied word for word and checked against each document. A document whose wording could not be checked has none. */
                  citations?: {
                    /** @description Stable ID of this citation: 10 lowercase letters and digits. An entry body points to it with a `[^key]` marker. */
                    _key: string
                    /** @enum {string} */
                    _type: 'sanity.context.citation'
                    /** @description ID of the document the quote comes from. Read it with `GET .../documents/{documentId}/content`. */
                    documentId: string
                    /** @description ID of the chunk of the document that holds the quote's first line. A chunk is the text under one heading, and keeps its ID across versions of the document while its headings stay the same. */
                    chunkId: string
                    /** @description The document's name when the entry was written. */
                    title: string
                    /** @description Where the document lives on the web. Absent for uploaded files and datasets. */
                    url?: string
                    /** @description The passage from the document that backs the claims, copied word for word. */
                    quote: string
                    /** @description Up to 32 characters of document text just before the quote, to tell repeats apart. */
                    prefix: string
                    /** @description Up to 32 characters of document text just after the quote, to tell repeats apart. */
                    suffix: string
                    /** @description First line of the quote in the document, counting from 1. Line numbers match `GET .../documents/{documentId}/content`. A hint: the quote is the stable locator. */
                    lineStart: number
                    /** @description Last line of the quote, inclusive. */
                    lineEnd: number
                  }[]
                  /**
                   * @description How much weight the sources behind this position carry. `primary`: your own content, such as uploaded files and pages on your own site. `secondary`: other sources. `community`: forums and Q&A sites.
                   * @enum {string}
                   */
                  authority?: 'primary' | 'secondary' | 'community'
                }[]
                /** @description Index in `sides` of the suggested side, when there is one. It is only a hint: nothing is chosen until you resolve the issue. */
                suggested?: number
              }
            | {
                /**
                 * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                 * @enum {string}
                 */
                severity: 'critical' | 'suggestion'
                /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                scopePath: string
                /** @description What the problem is, in one or two sentences. */
                issue: string
                /** @description What to do to fix the issue. */
                suggestedFix: string
                /**
                 * @description The issue type. `update_required` means an entry is out of date with its sources or contradicts an instruction, and needs a rewrite.
                 * @enum {string}
                 */
                kind: 'update_required'
                /** @description IDs of the documents that led to the issue. */
                citedDocumentIds?: string[]
                /** @description A key naming the specific finding, when the check that found it sets one. */
                claimKey?: string
                /** @description Paths of the entries the issue involves, when it spans more than one entry. */
                involvedScopes?: string[]
              }
          /** @description An identity for the finding that doesn't depend on its wording. It determines the issue's `_id`, so a reworded finding updates the same issue. */
          fingerprint: string
          /** @description The ID of the build that filed this issue. `null` when the issue was filed outside a build, such as when removing a document leaves an entry without documents. */
          revisionId: string | null
          /**
           * Format: date-time
           * @description When the issue was last filed, refiled or triaged, as an ISO 8601 timestamp. Unlike `_updatedAt`, no other write to the document changes it.
           */
          updatedAt?: string
          /**
           * @description The issue status. `rejected` means the issue was dismissed. Dismissal is final.
           * @enum {string}
           */
          status: 'rejected'
          /**
           * Format: date-time
           * @description When the issue left `open`, as an ISO 8601 timestamp.
           */
          resolvedAt: string
          /** @description Who triaged the issue. `null` while the issue is open, or when the caller could not be identified. */
          resolvedBy: {
            /** @description The ID of the Sanity user or robot token that triaged the issue. */
            id: string
            /**
             * @description What triaged the issue. `user` is a person, and `robot` is a robot token.
             * @enum {string}
             */
            kind: 'user' | 'robot'
          } | null
          /**
           * @description Always `null`, because a dismissal chooses no side.
           * @enum {string|null}
           */
          resolution: null
        }
    /** @description A `sanity.context.mcp` document: the configuration of one MCP endpoint, stored in your organization's document store. No endpoint returns this document. Use this schema to type GROQ query results and Sanity Function filters. Manage MCP endpoints in the Context dashboard. */
    McpDoc: {
      /** @description The document ID. */
      _id: string
      /** @description The document revision. It changes on every write. */
      _rev: string
      /**
       * Format: date-time
       * @description When the document was created, as an ISO 8601 timestamp.
       */
      _createdAt: string
      /**
       * Format: date-time
       * @description When the document was last changed, as an ISO 8601 timestamp.
       */
      _updatedAt: string
      /**
       * @description The document type. Always `sanity.context.mcp`.
       * @enum {string}
       */
      _type: 'sanity.context.mcp'
      /**
       * @description The version of the document shape. Currently `1`.
       * @enum {number}
       */
      schemaVersion: 1
      /** @description The ID of the organization that owns the MCP endpoint. Filter on it in every query, because the document store also holds documents from other features. */
      organizationId: string
      /** @description The MCP endpoint's public ID (`mcp…`). It is set once at creation, never changes, and determines the document `_id`. */
      publicId: string
      /** @description The MCP endpoint's display name. You can change it at any time. */
      title: string
      /** @description The MCP endpoint's name in its URL, in lowercase kebab case such as `my-endpoint`. It is unique within the organization and can't change after creation. */
      name: string
      /** @description The content sources the MCP endpoint serves, all at once. Each source appears once, there is at most one `dataset` source, and the order has no meaning. With no sources, agents can't connect until one is added. */
      sources: (
        | {
            /**
             * @description The source type. `knowledge-base` serves a whole knowledge base.
             * @enum {string}
             */
            type: 'knowledge-base'
            /** @description The knowledge base ID (`kb…`). */
            id: string
          }
        | {
            /**
             * @description The source type. `dataset` serves documents from a Sanity dataset, limited by the MCP endpoint's `groqFilter` when set.
             * @enum {string}
             */
            type: 'dataset'
            /** @description The dataset, as `<projectId>.<datasetName>`. */
            id: string
            /**
             * @description The studio workspace whose schema agents use, by name. `null` uses the studio's first workspace.
             * @default null
             */
            workspace: string | null
            /**
             * @description The perspective agents query the dataset with: `published`, `drafts`, or `raw`. `null` uses `published`.
             * @default null
             * @enum {string|null}
             */
            perspective: 'published' | 'drafts' | 'raw' | null
            /**
             * @description Whether agents can use semantic search on the dataset. `false` turns it off. `true` or `null` use it while the dataset has embeddings enabled and the organization has embeddings usage left.
             * @default null
             */
            semanticSearch: boolean | null
          }
      )[]
      /** @description Prompt text the MCP endpoint serves to connecting agents. `null` when unset. */
      instructions: string | null
      /** @description A GROQ filter that limits what the MCP endpoint's `dataset` source serves. It has no effect on `knowledge-base` sources. `null` when unset. The API clears it when the endpoint has no `dataset` source. */
      groqFilter: string | null
      /**
       * Format: date-time
       * @description When the MCP endpoint was last created or edited through the API, as an ISO 8601 timestamp. Agent use never changes it, unlike `_updatedAt`.
       */
      updatedAt?: string
      /**
       * Format: date-time
       * @description When an agent last used the MCP endpoint, as an ISO 8601 timestamp. Recorded at most once per UTC day. `null` when it has not been used since usage tracking started.
       */
      lastUsedAt?: string | null
    }
  }
  responses: never
  parameters: never
  requestBodies: never
  headers: never
  pathItems: never
}
export type $defs = Record<string, never>
export interface operations {
  listKnowledgeBases: {
    parameters: {
      query: {
        /** @description The `nextCursor` value from the previous page. Omit it to get the first page. */
        cursor?: string
        /** @description The maximum number of items to return. */
        limit?: number
        /** @description The organization to list knowledge bases for. */
        organizationId: string
        /** @description Set to `true` to also list the organization's drafts, which have `state` set to `draft`. Drafts count toward the plan's knowledge base limit, and `createdBy` says who started each one. */
        includeDrafts?: 'true' | 'false'
      }
      header?: never
      path: {
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description A page of knowledge bases. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The items on this page. */
            data: {
              /**
               * Format: uuid
               * @description An internal UUID for the knowledge base, still accepted wherever a `knowledgeBaseId` is expected. Use `publicId` instead.
               */
              id: string
              /** @description The knowledge base's ID, such as `kb3do82whm`. Store this one, and pass it as `knowledgeBaseId` in paths and filters. Treat it as an opaque string. */
              publicId: string
              /** @description The ID of the organization that owns the knowledge base. */
              organizationId: string
              /** @description The knowledge base's title. */
              title: string
              /** @description A short description of what the knowledge base covers. */
              description: string
              /**
               * @description The knowledge base's state. `draft`: still being set up, so it can't be built yet. `created`: not built yet. `ready`: built. Open issues and failed builds don't change the state. To check for open issues, use `openIssueCount`. To check for a running build, use `isBuilding`.
               * @enum {string}
               */
              state: 'draft' | 'created' | 'ready'
              /** @description The job ID of the most recent build, or `null` if no build has started. Check its progress with `GET .../jobs/{jobId}`. */
              activeJobId: string | null
              /** @description Whether a build is running now. */
              isBuilding: boolean
              /** @description Progress of the most recent build, by stage. `null` until a build reports progress. It can briefly belong to an earlier build, so use it only when its `jobId` matches `activeJobId`. */
              buildStageState: {
                /** @description The ID of the build job this progress belongs to. */
                jobId: string
                /** @description Every stage this build runs, in the order it runs them, with each stage's progress. */
                stages: {
                  /** @description The stage's ID, such as `tldr` or `write`. Which stages a build runs changes between builds and knowledge bases, so treat it as an open string and handle IDs you don't recognize. */
                  id: string
                  /** @description The stage's share of the whole build, from 0 to 1. The weights of a build's stages sum to 1. */
                  weight: number
                  /**
                   * @description The stage's status. `pending`: not started. `running`: in progress. `done`: finished. `failed`: the build ended before the stage finished.
                   * @enum {string}
                   */
                  status: 'pending' | 'running' | 'done' | 'failed'
                  /** @description The stage's progress counts. Absent when the stage hasn't reported counts. */
                  units?: {
                    /**
                     * @description What `done` and `total` count: `sources`, `groups` of related content, `entries`, or `rounds` of final fixes. A `rounds` stage has no `total`.
                     * @enum {string}
                     */
                    unit: 'sources' | 'groups' | 'entries' | 'rounds'
                    /** @description How many units the stage has finished. */
                    done: number
                    /** @description How many units the stage will process. Absent when `unit` is `rounds`. */
                    total?: number
                  }
                }[]
              } | null
              /**
               * Format: date-time
               * @description When a refresh last checked the knowledge base for changes, whether or not anything changed. `null` until the first refresh.
               */
              lastCheckedAt: string | null
              /**
               * Format: date-time
               * @description When the content last changed: the time of the most recent successful build. `null` if the knowledge base has never built.
               */
              lastChangedAt: string | null
              /** @description Whether sources were added, changed, or removed since the last successful build. A change a check already reviewed without filing an issue, or that a dismissed issue covered, no longer counts. Always `false` before the first build. */
              hasPendingChanges: boolean
              /** @description Counts of sources added, changed, and removed since the last successful build, excluding changes a check already reviewed without filing an issue or that a dismissed issue covered. Only `GET .../knowledge-bases/{knowledgeBaseId}` computes it. `null` in list responses and before the first build. */
              pendingChanges: {
                /** @description Sources added since the last successful build, including sources no successful build has included yet. */
                added: number
                /** @description Sources whose content changed since the last successful build. */
                changed: number
                /** @description Sources that recent refreshes no longer find. */
                removed: number
              } | null
              /** @description Whether Sanity Context has improved how it builds knowledge bases since the last successful build. Rebuild to apply the improvements. Always `false` before the first build. */
              pipelineOutdated: boolean
              /** @description A recommendation to rebuild, because new or changed content doesn't fit the current outline, or pages are out of date with changed sources and only a build updates them. `null` when there's no recommendation. A refresh where the content fits again, a successful build, or adding or removing sources clears it. */
              rebuildRecommended: {
                /** @description Why a rebuild is recommended, written to show to users. */
                reason: string
                /**
                 * Format: date-time
                 * @description When the recommendation was made.
                 */
                at: string
              } | null
              /** @description Whether the knowledge base has at least one website source. */
              hasWebSource: boolean
              /** @description Whether the knowledge base has at least one Sanity dataset source. */
              hasDatasetSource: boolean
              /** @description Whether the knowledge base has at least one uploaded file source. */
              hasFileSource: boolean
              /** @description The number of source chunks in the live documents of the knowledge base's sources, whether or not they have been built: the sum of its sources' `chunkCount`. It includes the chunks counted by `excludedSourceChunks`, and those of documents whose content another document repeats, which builds skip. Documents still being converted add theirs once converted. */
              sourceChunks: number
              /** @description The number of source chunks in documents the organization's source chunk limit left out of builds. They count toward no limit, and the next build includes them once the limit has room. */
              excludedSourceChunks: number
              /** @description Why a build request would be denied right now, or `null` if you can build. Only `GET .../knowledge-bases/{knowledgeBaseId}` checks it. List and create responses always return `null`. */
              buildRestriction: {
                /** @description A stable code for the restriction, such as `planLimitReached`. */
                code: string
                /** @description A readable explanation that you can show to users. */
                message: string
              } | null
              /** @description Whether a refresh is running now. While it's `true`, a new refresh request makes the running one run once more when it ends instead of starting another. Only `GET .../knowledge-bases/{knowledgeBaseId}` computes it, so list responses return `false`. */
              refreshInFlight: boolean
              /** @description The number of open issues waiting for review. Always `0` before the first build. */
              openIssueCount: number
              /** @description The number of active instructions for the knowledge base. */
              instructionCount: number
              /** @description Who created the knowledge base. `null` if unknown. */
              createdBy: {
                /** @description The Sanity user ID, or `sanity-system` when Sanity Context made the change. `null` if unknown. */
                id: string | null
                /** @description The user's name when the action happened. `null` if unknown. For the current name, look up the user by `id`. */
                displayName: string | null
              } | null
              /**
               * Format: date-time
               * @description When the knowledge base was created.
               */
              createdAt: string
              /**
               * Format: date-time
               * @description When the knowledge base was last updated.
               */
              updatedAt: string
            }[]
            /** @description The cursor for the next page. Pass it as `cursor` to get more results. `null` when there are no more pages. */
            nextCursor: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  createKnowledgeBase: {
    parameters: {
      query?: never
      header?: {
        /** @description A unique value, such as a UUID, that makes retries safe. A retry with the same key and body returns the first response instead of repeating the work. */
        'Idempotency-Key'?: string
      }
      path: {
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody: {
      content: {
        'application/json': {
          /** @description The ID of the organization to create the knowledge base in. */
          organizationId: string
          /** @description The knowledge base's title. Required unless `draft` is `true`. */
          title?: string
          /** @description A short description of what the knowledge base covers. Required unless `draft` is `true`. */
          description?: string
          /** @description Whether to create the knowledge base as a draft. You can add sources to a draft, and they sync right away, but you can't build it, and the list leaves it out unless you set `includeDrafts` to `true`. A draft counts toward your plan's knowledge base limit. To finish it, update it with `draft` set to `false`. */
          draft?: boolean
        }
      }
    }
    responses: {
      /** @description A knowledge base and its current state. */
      201: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description An internal UUID for the knowledge base, still accepted wherever a `knowledgeBaseId` is expected. Use `publicId` instead.
             */
            id: string
            /** @description The knowledge base's ID, such as `kb3do82whm`. Store this one, and pass it as `knowledgeBaseId` in paths and filters. Treat it as an opaque string. */
            publicId: string
            /** @description The ID of the organization that owns the knowledge base. */
            organizationId: string
            /** @description The knowledge base's title. */
            title: string
            /** @description A short description of what the knowledge base covers. */
            description: string
            /**
             * @description The knowledge base's state. `draft`: still being set up, so it can't be built yet. `created`: not built yet. `ready`: built. Open issues and failed builds don't change the state. To check for open issues, use `openIssueCount`. To check for a running build, use `isBuilding`.
             * @enum {string}
             */
            state: 'draft' | 'created' | 'ready'
            /** @description The job ID of the most recent build, or `null` if no build has started. Check its progress with `GET .../jobs/{jobId}`. */
            activeJobId: string | null
            /** @description Whether a build is running now. */
            isBuilding: boolean
            /** @description Progress of the most recent build, by stage. `null` until a build reports progress. It can briefly belong to an earlier build, so use it only when its `jobId` matches `activeJobId`. */
            buildStageState: {
              /** @description The ID of the build job this progress belongs to. */
              jobId: string
              /** @description Every stage this build runs, in the order it runs them, with each stage's progress. */
              stages: {
                /** @description The stage's ID, such as `tldr` or `write`. Which stages a build runs changes between builds and knowledge bases, so treat it as an open string and handle IDs you don't recognize. */
                id: string
                /** @description The stage's share of the whole build, from 0 to 1. The weights of a build's stages sum to 1. */
                weight: number
                /**
                 * @description The stage's status. `pending`: not started. `running`: in progress. `done`: finished. `failed`: the build ended before the stage finished.
                 * @enum {string}
                 */
                status: 'pending' | 'running' | 'done' | 'failed'
                /** @description The stage's progress counts. Absent when the stage hasn't reported counts. */
                units?: {
                  /**
                   * @description What `done` and `total` count: `sources`, `groups` of related content, `entries`, or `rounds` of final fixes. A `rounds` stage has no `total`.
                   * @enum {string}
                   */
                  unit: 'sources' | 'groups' | 'entries' | 'rounds'
                  /** @description How many units the stage has finished. */
                  done: number
                  /** @description How many units the stage will process. Absent when `unit` is `rounds`. */
                  total?: number
                }
              }[]
            } | null
            /**
             * Format: date-time
             * @description When a refresh last checked the knowledge base for changes, whether or not anything changed. `null` until the first refresh.
             */
            lastCheckedAt: string | null
            /**
             * Format: date-time
             * @description When the content last changed: the time of the most recent successful build. `null` if the knowledge base has never built.
             */
            lastChangedAt: string | null
            /** @description Whether sources were added, changed, or removed since the last successful build. A change a check already reviewed without filing an issue, or that a dismissed issue covered, no longer counts. Always `false` before the first build. */
            hasPendingChanges: boolean
            /** @description Counts of sources added, changed, and removed since the last successful build, excluding changes a check already reviewed without filing an issue or that a dismissed issue covered. Only `GET .../knowledge-bases/{knowledgeBaseId}` computes it. `null` in list responses and before the first build. */
            pendingChanges: {
              /** @description Sources added since the last successful build, including sources no successful build has included yet. */
              added: number
              /** @description Sources whose content changed since the last successful build. */
              changed: number
              /** @description Sources that recent refreshes no longer find. */
              removed: number
            } | null
            /** @description Whether Sanity Context has improved how it builds knowledge bases since the last successful build. Rebuild to apply the improvements. Always `false` before the first build. */
            pipelineOutdated: boolean
            /** @description A recommendation to rebuild, because new or changed content doesn't fit the current outline, or pages are out of date with changed sources and only a build updates them. `null` when there's no recommendation. A refresh where the content fits again, a successful build, or adding or removing sources clears it. */
            rebuildRecommended: {
              /** @description Why a rebuild is recommended, written to show to users. */
              reason: string
              /**
               * Format: date-time
               * @description When the recommendation was made.
               */
              at: string
            } | null
            /** @description Whether the knowledge base has at least one website source. */
            hasWebSource: boolean
            /** @description Whether the knowledge base has at least one Sanity dataset source. */
            hasDatasetSource: boolean
            /** @description Whether the knowledge base has at least one uploaded file source. */
            hasFileSource: boolean
            /** @description The number of source chunks in the live documents of the knowledge base's sources, whether or not they have been built: the sum of its sources' `chunkCount`. It includes the chunks counted by `excludedSourceChunks`, and those of documents whose content another document repeats, which builds skip. Documents still being converted add theirs once converted. */
            sourceChunks: number
            /** @description The number of source chunks in documents the organization's source chunk limit left out of builds. They count toward no limit, and the next build includes them once the limit has room. */
            excludedSourceChunks: number
            /** @description Why a build request would be denied right now, or `null` if you can build. Only `GET .../knowledge-bases/{knowledgeBaseId}` checks it. List and create responses always return `null`. */
            buildRestriction: {
              /** @description A stable code for the restriction, such as `planLimitReached`. */
              code: string
              /** @description A readable explanation that you can show to users. */
              message: string
            } | null
            /** @description Whether a refresh is running now. While it's `true`, a new refresh request makes the running one run once more when it ends instead of starting another. Only `GET .../knowledge-bases/{knowledgeBaseId}` computes it, so list responses return `false`. */
            refreshInFlight: boolean
            /** @description The number of open issues waiting for review. Always `0` before the first build. */
            openIssueCount: number
            /** @description The number of active instructions for the knowledge base. */
            instructionCount: number
            /** @description Who created the knowledge base. `null` if unknown. */
            createdBy: {
              /** @description The Sanity user ID, or `sanity-system` when Sanity Context made the change. `null` if unknown. */
              id: string | null
              /** @description The user's name when the action happened. `null` if unknown. For the current name, look up the user by `id`. */
              displayName: string | null
            } | null
            /**
             * Format: date-time
             * @description When the knowledge base was created.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the knowledge base was last updated.
             */
            updatedAt: string
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  getKnowledgeBase: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description A knowledge base and its current state. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description An internal UUID for the knowledge base, still accepted wherever a `knowledgeBaseId` is expected. Use `publicId` instead.
             */
            id: string
            /** @description The knowledge base's ID, such as `kb3do82whm`. Store this one, and pass it as `knowledgeBaseId` in paths and filters. Treat it as an opaque string. */
            publicId: string
            /** @description The ID of the organization that owns the knowledge base. */
            organizationId: string
            /** @description The knowledge base's title. */
            title: string
            /** @description A short description of what the knowledge base covers. */
            description: string
            /**
             * @description The knowledge base's state. `draft`: still being set up, so it can't be built yet. `created`: not built yet. `ready`: built. Open issues and failed builds don't change the state. To check for open issues, use `openIssueCount`. To check for a running build, use `isBuilding`.
             * @enum {string}
             */
            state: 'draft' | 'created' | 'ready'
            /** @description The job ID of the most recent build, or `null` if no build has started. Check its progress with `GET .../jobs/{jobId}`. */
            activeJobId: string | null
            /** @description Whether a build is running now. */
            isBuilding: boolean
            /** @description Progress of the most recent build, by stage. `null` until a build reports progress. It can briefly belong to an earlier build, so use it only when its `jobId` matches `activeJobId`. */
            buildStageState: {
              /** @description The ID of the build job this progress belongs to. */
              jobId: string
              /** @description Every stage this build runs, in the order it runs them, with each stage's progress. */
              stages: {
                /** @description The stage's ID, such as `tldr` or `write`. Which stages a build runs changes between builds and knowledge bases, so treat it as an open string and handle IDs you don't recognize. */
                id: string
                /** @description The stage's share of the whole build, from 0 to 1. The weights of a build's stages sum to 1. */
                weight: number
                /**
                 * @description The stage's status. `pending`: not started. `running`: in progress. `done`: finished. `failed`: the build ended before the stage finished.
                 * @enum {string}
                 */
                status: 'pending' | 'running' | 'done' | 'failed'
                /** @description The stage's progress counts. Absent when the stage hasn't reported counts. */
                units?: {
                  /**
                   * @description What `done` and `total` count: `sources`, `groups` of related content, `entries`, or `rounds` of final fixes. A `rounds` stage has no `total`.
                   * @enum {string}
                   */
                  unit: 'sources' | 'groups' | 'entries' | 'rounds'
                  /** @description How many units the stage has finished. */
                  done: number
                  /** @description How many units the stage will process. Absent when `unit` is `rounds`. */
                  total?: number
                }
              }[]
            } | null
            /**
             * Format: date-time
             * @description When a refresh last checked the knowledge base for changes, whether or not anything changed. `null` until the first refresh.
             */
            lastCheckedAt: string | null
            /**
             * Format: date-time
             * @description When the content last changed: the time of the most recent successful build. `null` if the knowledge base has never built.
             */
            lastChangedAt: string | null
            /** @description Whether sources were added, changed, or removed since the last successful build. A change a check already reviewed without filing an issue, or that a dismissed issue covered, no longer counts. Always `false` before the first build. */
            hasPendingChanges: boolean
            /** @description Counts of sources added, changed, and removed since the last successful build, excluding changes a check already reviewed without filing an issue or that a dismissed issue covered. Only `GET .../knowledge-bases/{knowledgeBaseId}` computes it. `null` in list responses and before the first build. */
            pendingChanges: {
              /** @description Sources added since the last successful build, including sources no successful build has included yet. */
              added: number
              /** @description Sources whose content changed since the last successful build. */
              changed: number
              /** @description Sources that recent refreshes no longer find. */
              removed: number
            } | null
            /** @description Whether Sanity Context has improved how it builds knowledge bases since the last successful build. Rebuild to apply the improvements. Always `false` before the first build. */
            pipelineOutdated: boolean
            /** @description A recommendation to rebuild, because new or changed content doesn't fit the current outline, or pages are out of date with changed sources and only a build updates them. `null` when there's no recommendation. A refresh where the content fits again, a successful build, or adding or removing sources clears it. */
            rebuildRecommended: {
              /** @description Why a rebuild is recommended, written to show to users. */
              reason: string
              /**
               * Format: date-time
               * @description When the recommendation was made.
               */
              at: string
            } | null
            /** @description Whether the knowledge base has at least one website source. */
            hasWebSource: boolean
            /** @description Whether the knowledge base has at least one Sanity dataset source. */
            hasDatasetSource: boolean
            /** @description Whether the knowledge base has at least one uploaded file source. */
            hasFileSource: boolean
            /** @description The number of source chunks in the live documents of the knowledge base's sources, whether or not they have been built: the sum of its sources' `chunkCount`. It includes the chunks counted by `excludedSourceChunks`, and those of documents whose content another document repeats, which builds skip. Documents still being converted add theirs once converted. */
            sourceChunks: number
            /** @description The number of source chunks in documents the organization's source chunk limit left out of builds. They count toward no limit, and the next build includes them once the limit has room. */
            excludedSourceChunks: number
            /** @description Why a build request would be denied right now, or `null` if you can build. Only `GET .../knowledge-bases/{knowledgeBaseId}` checks it. List and create responses always return `null`. */
            buildRestriction: {
              /** @description A stable code for the restriction, such as `planLimitReached`. */
              code: string
              /** @description A readable explanation that you can show to users. */
              message: string
            } | null
            /** @description Whether a refresh is running now. While it's `true`, a new refresh request makes the running one run once more when it ends instead of starting another. Only `GET .../knowledge-bases/{knowledgeBaseId}` computes it, so list responses return `false`. */
            refreshInFlight: boolean
            /** @description The number of open issues waiting for review. Always `0` before the first build. */
            openIssueCount: number
            /** @description The number of active instructions for the knowledge base. */
            instructionCount: number
            /** @description Who created the knowledge base. `null` if unknown. */
            createdBy: {
              /** @description The Sanity user ID, or `sanity-system` when Sanity Context made the change. `null` if unknown. */
              id: string | null
              /** @description The user's name when the action happened. `null` if unknown. For the current name, look up the user by `id`. */
              displayName: string | null
            } | null
            /**
             * Format: date-time
             * @description When the knowledge base was created.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the knowledge base was last updated.
             */
            updatedAt: string
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  deleteKnowledgeBase: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description The knowledge base was deleted. */
      204: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': null
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  updateKnowledgeBase: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody: {
      content: {
        'application/json': {
          /** @description The knowledge base's new title. */
          title?: string
          /** @description The knowledge base's new description. */
          description?: string
          /**
           * @description Set to `false` to finish a draft, so it can be built and is listed with your other knowledge bases. The knowledge base needs a title, sent here or set before. Ignored when the knowledge base isn't a draft. A finished knowledge base can't become a draft again.
           * @enum {boolean}
           */
          draft?: false
        }
      }
    }
    responses: {
      /** @description A knowledge base and its current state. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description An internal UUID for the knowledge base, still accepted wherever a `knowledgeBaseId` is expected. Use `publicId` instead.
             */
            id: string
            /** @description The knowledge base's ID, such as `kb3do82whm`. Store this one, and pass it as `knowledgeBaseId` in paths and filters. Treat it as an opaque string. */
            publicId: string
            /** @description The ID of the organization that owns the knowledge base. */
            organizationId: string
            /** @description The knowledge base's title. */
            title: string
            /** @description A short description of what the knowledge base covers. */
            description: string
            /**
             * @description The knowledge base's state. `draft`: still being set up, so it can't be built yet. `created`: not built yet. `ready`: built. Open issues and failed builds don't change the state. To check for open issues, use `openIssueCount`. To check for a running build, use `isBuilding`.
             * @enum {string}
             */
            state: 'draft' | 'created' | 'ready'
            /** @description The job ID of the most recent build, or `null` if no build has started. Check its progress with `GET .../jobs/{jobId}`. */
            activeJobId: string | null
            /** @description Whether a build is running now. */
            isBuilding: boolean
            /** @description Progress of the most recent build, by stage. `null` until a build reports progress. It can briefly belong to an earlier build, so use it only when its `jobId` matches `activeJobId`. */
            buildStageState: {
              /** @description The ID of the build job this progress belongs to. */
              jobId: string
              /** @description Every stage this build runs, in the order it runs them, with each stage's progress. */
              stages: {
                /** @description The stage's ID, such as `tldr` or `write`. Which stages a build runs changes between builds and knowledge bases, so treat it as an open string and handle IDs you don't recognize. */
                id: string
                /** @description The stage's share of the whole build, from 0 to 1. The weights of a build's stages sum to 1. */
                weight: number
                /**
                 * @description The stage's status. `pending`: not started. `running`: in progress. `done`: finished. `failed`: the build ended before the stage finished.
                 * @enum {string}
                 */
                status: 'pending' | 'running' | 'done' | 'failed'
                /** @description The stage's progress counts. Absent when the stage hasn't reported counts. */
                units?: {
                  /**
                   * @description What `done` and `total` count: `sources`, `groups` of related content, `entries`, or `rounds` of final fixes. A `rounds` stage has no `total`.
                   * @enum {string}
                   */
                  unit: 'sources' | 'groups' | 'entries' | 'rounds'
                  /** @description How many units the stage has finished. */
                  done: number
                  /** @description How many units the stage will process. Absent when `unit` is `rounds`. */
                  total?: number
                }
              }[]
            } | null
            /**
             * Format: date-time
             * @description When a refresh last checked the knowledge base for changes, whether or not anything changed. `null` until the first refresh.
             */
            lastCheckedAt: string | null
            /**
             * Format: date-time
             * @description When the content last changed: the time of the most recent successful build. `null` if the knowledge base has never built.
             */
            lastChangedAt: string | null
            /** @description Whether sources were added, changed, or removed since the last successful build. A change a check already reviewed without filing an issue, or that a dismissed issue covered, no longer counts. Always `false` before the first build. */
            hasPendingChanges: boolean
            /** @description Counts of sources added, changed, and removed since the last successful build, excluding changes a check already reviewed without filing an issue or that a dismissed issue covered. Only `GET .../knowledge-bases/{knowledgeBaseId}` computes it. `null` in list responses and before the first build. */
            pendingChanges: {
              /** @description Sources added since the last successful build, including sources no successful build has included yet. */
              added: number
              /** @description Sources whose content changed since the last successful build. */
              changed: number
              /** @description Sources that recent refreshes no longer find. */
              removed: number
            } | null
            /** @description Whether Sanity Context has improved how it builds knowledge bases since the last successful build. Rebuild to apply the improvements. Always `false` before the first build. */
            pipelineOutdated: boolean
            /** @description A recommendation to rebuild, because new or changed content doesn't fit the current outline, or pages are out of date with changed sources and only a build updates them. `null` when there's no recommendation. A refresh where the content fits again, a successful build, or adding or removing sources clears it. */
            rebuildRecommended: {
              /** @description Why a rebuild is recommended, written to show to users. */
              reason: string
              /**
               * Format: date-time
               * @description When the recommendation was made.
               */
              at: string
            } | null
            /** @description Whether the knowledge base has at least one website source. */
            hasWebSource: boolean
            /** @description Whether the knowledge base has at least one Sanity dataset source. */
            hasDatasetSource: boolean
            /** @description Whether the knowledge base has at least one uploaded file source. */
            hasFileSource: boolean
            /** @description The number of source chunks in the live documents of the knowledge base's sources, whether or not they have been built: the sum of its sources' `chunkCount`. It includes the chunks counted by `excludedSourceChunks`, and those of documents whose content another document repeats, which builds skip. Documents still being converted add theirs once converted. */
            sourceChunks: number
            /** @description The number of source chunks in documents the organization's source chunk limit left out of builds. They count toward no limit, and the next build includes them once the limit has room. */
            excludedSourceChunks: number
            /** @description Why a build request would be denied right now, or `null` if you can build. Only `GET .../knowledge-bases/{knowledgeBaseId}` checks it. List and create responses always return `null`. */
            buildRestriction: {
              /** @description A stable code for the restriction, such as `planLimitReached`. */
              code: string
              /** @description A readable explanation that you can show to users. */
              message: string
            } | null
            /** @description Whether a refresh is running now. While it's `true`, a new refresh request makes the running one run once more when it ends instead of starting another. Only `GET .../knowledge-bases/{knowledgeBaseId}` computes it, so list responses return `false`. */
            refreshInFlight: boolean
            /** @description The number of open issues waiting for review. Always `0` before the first build. */
            openIssueCount: number
            /** @description The number of active instructions for the knowledge base. */
            instructionCount: number
            /** @description Who created the knowledge base. `null` if unknown. */
            createdBy: {
              /** @description The Sanity user ID, or `sanity-system` when Sanity Context made the change. `null` if unknown. */
              id: string | null
              /** @description The user's name when the action happened. `null` if unknown. For the current name, look up the user by `id`. */
              displayName: string | null
            } | null
            /**
             * Format: date-time
             * @description When the knowledge base was created.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the knowledge base was last updated.
             */
            updatedAt: string
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  buildKnowledgeBase: {
    parameters: {
      query?: never
      header?: {
        /** @description A unique value, such as a UUID, that makes retries safe. A retry with the same key and body returns the first response instead of repeating the work. */
        'Idempotency-Key'?: string
      }
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description A queued job that you can poll for progress. */
      202: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The queued job's ID. Check its progress with `GET .../jobs/{jobId}`. Treat it as an opaque string. Its format can change. */
            jobId: string
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  cancelKnowledgeBaseBuild: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description The result of the cancel request. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description Whether a running build was cancelled. `false` when no build was running. */
            cancelled: boolean
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  listDocuments: {
    parameters: {
      query?: {
        /** @description The `nextCursor` value from the previous page. Omit it to get the first page. */
        cursor?: string
        /** @description The maximum number of items to return. */
        limit?: number
        /** @description Return only the documents of this source. */
        source?: string
        /** @description Return only documents in this state. Without it, `deleted` documents are left out. */
        state?: 'active' | 'missing' | 'deleted'
        /** @description Comma-separated IDs of the documents to return, up to 200, in any state. Use it to look up the documents entry citations point at. */
        ids?: string
      }
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description A page of documents. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The items on this page. */
            data: {
              /**
               * Format: uuid
               * @description The document's ID. Entry citations point at it.
               */
              id: string
              /**
               * Format: uuid
               * @description The ID of the source the document comes from.
               */
              sourceId: string
              /**
               * @description The type of the source the document comes from.
               * @enum {string}
               */
              sourceType: 'web' | 'sanity-dataset' | 'files'
              /** @description The document's identity in its source: the page URL, the dataset document `_id`, or the file's path in the upload. */
              externalId: string
              /** @description The document's title, or its `externalId` when it has none. */
              title: string
              /** @description Where the document lives on the web. `null` for files and dataset documents. */
              url: string | null
              /**
               * @description The document's state. `active`: in the knowledge base. `missing`: several crawls in a row didn't find the page, but it stays in the knowledge base until you delete or keep it. `deleted`: removed from the source, or by you.
               * @enum {string}
               */
              state: 'active' | 'missing' | 'deleted'
              /** @description The media type of the document as read. `null` before its content was read. */
              mime: string | null
              /** @description The size of the document as read, in bytes. `null` before its content was read. */
              sizeBytes: number | null
              /**
               * @description How far the current content got through conversion to markdown, the text builds read and cite. `pending`: not converted yet. `converted`: ready. `unsupported`: the file type has no converter. `oversized`: too large to convert. `failed`: conversion failed, see `conversionError`.
               * @enum {string}
               */
              conversion: 'pending' | 'converted' | 'unsupported' | 'oversized' | 'failed'
              /** @description Why conversion failed. `null` unless `conversion` is `failed` or `oversized`. */
              conversionError: string | null
              /**
               * Format: date-time
               * @description When a build left the document out because the organization's source chunk limit had no room for it. No build reads it until a later build finds room, which includes it automatically. `null` while builds include it.
               */
              excludedAt: string | null
              /**
               * Format: date-time
               * @description When the document says it was last updated: from a page's meta tags, a file's own metadata, or a dataset document's `_updatedAt`. `null` when it doesn't say.
               */
              documentUpdatedAt: string | null
              /**
               * Format: date-time
               * @description When a sync last found the document in its source.
               */
              lastSeenAt: string
              /**
               * Format: date-time
               * @description When the document was first read.
               */
              createdAt: string
              /**
               * Format: date-time
               * @description When the document last changed.
               */
              updatedAt: string
            }[]
            /** @description The cursor for the next page. Pass it as `cursor` to get more results. `null` when there are no more pages. */
            nextCursor: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  getDocument: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The document's ID. */
        documentId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description A document with the chunks of its markdown. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description The document's ID. Entry citations point at it.
             */
            id: string
            /**
             * Format: uuid
             * @description The ID of the source the document comes from.
             */
            sourceId: string
            /**
             * @description The type of the source the document comes from.
             * @enum {string}
             */
            sourceType: 'web' | 'sanity-dataset' | 'files'
            /** @description The document's identity in its source: the page URL, the dataset document `_id`, or the file's path in the upload. */
            externalId: string
            /** @description The document's title, or its `externalId` when it has none. */
            title: string
            /** @description Where the document lives on the web. `null` for files and dataset documents. */
            url: string | null
            /**
             * @description The document's state. `active`: in the knowledge base. `missing`: several crawls in a row didn't find the page, but it stays in the knowledge base until you delete or keep it. `deleted`: removed from the source, or by you.
             * @enum {string}
             */
            state: 'active' | 'missing' | 'deleted'
            /** @description The media type of the document as read. `null` before its content was read. */
            mime: string | null
            /** @description The size of the document as read, in bytes. `null` before its content was read. */
            sizeBytes: number | null
            /**
             * @description How far the current content got through conversion to markdown, the text builds read and cite. `pending`: not converted yet. `converted`: ready. `unsupported`: the file type has no converter. `oversized`: too large to convert. `failed`: conversion failed, see `conversionError`.
             * @enum {string}
             */
            conversion: 'pending' | 'converted' | 'unsupported' | 'oversized' | 'failed'
            /** @description Why conversion failed. `null` unless `conversion` is `failed` or `oversized`. */
            conversionError: string | null
            /**
             * Format: date-time
             * @description When a build left the document out because the organization's source chunk limit had no room for it. No build reads it until a later build finds room, which includes it automatically. `null` while builds include it.
             */
            excludedAt: string | null
            /**
             * Format: date-time
             * @description When the document says it was last updated: from a page's meta tags, a file's own metadata, or a dataset document's `_updatedAt`. `null` when it doesn't say.
             */
            documentUpdatedAt: string | null
            /**
             * Format: date-time
             * @description When a sync last found the document in its source.
             */
            lastSeenAt: string
            /**
             * Format: date-time
             * @description When the document was first read.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the document last changed.
             */
            updatedAt: string
            /** @description The chunks of the document's current markdown, in order. Empty until `conversion` is `converted`. */
            chunks: {
              /**
               * Format: uuid
               * @description The chunk's ID. Entry citations point at it.
               */
              id: string
              /** @description The headings above the chunk, outermost first. Empty before the first heading. */
              headingPath: string[]
              /** @description The chunk's first line in the markdown, from 1. */
              lineStart: number
              /** @description The chunk's last line in the markdown, inclusive. */
              lineEnd: number
            }[]
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  deleteDocument: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The document's ID. */
        documentId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description The document was deleted. */
      204: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': null
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  updateDocument: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The document's ID. */
        documentId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    /** @description The changes to make to a document. */
    requestBody: {
      content: {
        'application/json': {
          /**
           * @description Set to `active` to keep a `missing` page in the knowledge base. The count of crawls that missed it starts again.
           * @enum {string}
           */
          state: 'active'
        }
      }
    }
    responses: {
      /** @description One page, dataset document or file that a source yields. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description The document's ID. Entry citations point at it.
             */
            id: string
            /**
             * Format: uuid
             * @description The ID of the source the document comes from.
             */
            sourceId: string
            /**
             * @description The type of the source the document comes from.
             * @enum {string}
             */
            sourceType: 'web' | 'sanity-dataset' | 'files'
            /** @description The document's identity in its source: the page URL, the dataset document `_id`, or the file's path in the upload. */
            externalId: string
            /** @description The document's title, or its `externalId` when it has none. */
            title: string
            /** @description Where the document lives on the web. `null` for files and dataset documents. */
            url: string | null
            /**
             * @description The document's state. `active`: in the knowledge base. `missing`: several crawls in a row didn't find the page, but it stays in the knowledge base until you delete or keep it. `deleted`: removed from the source, or by you.
             * @enum {string}
             */
            state: 'active' | 'missing' | 'deleted'
            /** @description The media type of the document as read. `null` before its content was read. */
            mime: string | null
            /** @description The size of the document as read, in bytes. `null` before its content was read. */
            sizeBytes: number | null
            /**
             * @description How far the current content got through conversion to markdown, the text builds read and cite. `pending`: not converted yet. `converted`: ready. `unsupported`: the file type has no converter. `oversized`: too large to convert. `failed`: conversion failed, see `conversionError`.
             * @enum {string}
             */
            conversion: 'pending' | 'converted' | 'unsupported' | 'oversized' | 'failed'
            /** @description Why conversion failed. `null` unless `conversion` is `failed` or `oversized`. */
            conversionError: string | null
            /**
             * Format: date-time
             * @description When a build left the document out because the organization's source chunk limit had no room for it. No build reads it until a later build finds room, which includes it automatically. `null` while builds include it.
             */
            excludedAt: string | null
            /**
             * Format: date-time
             * @description When the document says it was last updated: from a page's meta tags, a file's own metadata, or a dataset document's `_updatedAt`. `null` when it doesn't say.
             */
            documentUpdatedAt: string | null
            /**
             * Format: date-time
             * @description When a sync last found the document in its source.
             */
            lastSeenAt: string
            /**
             * Format: date-time
             * @description When the document was first read.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the document last changed.
             */
            updatedAt: string
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  getDocumentContent: {
    parameters: {
      query?: {
        /** @description Response format. `json` (default) returns the markdown with its line numbers. `markdown` and `plain` return the markdown alone, ready to pass to a model. `raw` returns the bytes the source gave, before conversion: the uploaded file, the crawled page, the dataset document as JSON. */
        format?: 'json' | 'markdown' | 'plain' | 'raw'
        /** @description Return only this chunk's lines. Citations name the chunk they quote. */
        chunk?: string
        /** @description Return only these lines, from 1 and inclusive: `10-20`, or `10` for line 10 to the end. A range past the end returns up to the last line. */
        lines?: string
      }
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The document's ID. */
        documentId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description A document's markdown, or a range of its lines. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description The document's ID.
             */
            documentId: string
            /**
             * Format: uuid
             * @description The chunk the content was limited to. `null` when no `chunk` was requested.
             */
            chunkId: string | null
            /** @description The document's markdown, or the requested lines of it. */
            content: string
            /** @description The number of lines in the whole markdown. */
            totalLines: number
            /** @description The lines returned, from 1 and inclusive. Shorter than requested when the range runs past the end. Both are `0` when no lines are returned. */
            slice: {
              /** @description The first line returned. */
              start: number
              /** @description The last line returned. */
              end: number
            }
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  rebuildEntry: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The entry's slash-delimited path, such as `pricing/plans/free`, URL-encoded. */
        entryPath: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description The job that rebuilds the entry, and the other entries that share its sources. */
      202: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description ID of the job that rebuilds the entry. Poll it with `GET .../jobs/{jobId}`. */
            jobId: string
            /** @description Other entries built from any of this entry's sources. An instruction applies to every entry built from its sources, so these entries can change when they are next rebuilt. */
            affectedEntries: {
              /** @description The entry's document ID. */
              id: string
              /** @description The entry's path, such as `products/api/webhooks`. */
              path: string
              /** @description The entry's title. */
              title: string
            }[]
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  createInstruction: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    /** @description The instruction to create, and any entries to rebuild under it. */
    requestBody: {
      content: {
        'application/json': {
          /** @description The instruction in plain language. Builds follow it over what the sources say. */
          statement: string
          /** @description IDs of the documents the instruction applies to. Builds apply it when they write entries built from these documents. IDs of documents that no longer exist are dropped. If none exist, the request returns `422` with code `instructionScopeVanished`. */
          scopeDocumentIds: string[]
          /** @description Paths of entries to rebuild under the new instruction right away. The response returns the rebuild job ID in `rebuildJobId`. */
          rebuildPaths?: string[]
          /** @description Whether you already checked the instruction for entries that contradict it. When `true`, the background check that files issues for those entries is skipped. It still runs if the rebuild you requested in `rebuildPaths` does not start. */
          verified?: boolean
        }
      }
    }
    responses: {
      /** @description The created instruction, and the rebuild it started. */
      201: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The created instruction. */
            instruction: {
              /** @description The instruction's document ID. */
              id: string
              /** @description The ID (`kb...`) of the knowledge base the instruction belongs to. */
              knowledgeBaseId: string
              /**
               * @description How the instruction was created. `human`: someone wrote it. `conflict`: it records the side chosen when a conflict issue was resolved. Both kinds work the same way in builds.
               * @enum {string}
               */
              origin: 'conflict' | 'human'
              /**
               * @description Whether builds apply the instruction. `active`: builds apply it. `archived`: a refresh found that its documents no longer support it, so builds stop applying it. To reactivate an archived instruction, update it.
               * @enum {string}
               */
              status: 'active' | 'archived'
              /** @description The instruction in plain language. Builds follow it over what the sources say. */
              statement: string
              /** @description IDs of the documents the instruction applies to. Builds apply it when they write entries built from these documents. An empty array means all of its documents were removed, so it applies to no entries. */
              scopeDocumentIds: string[]
              /**
               * Format: date-time
               * @description When a refresh archived the instruction. `null` while it is active.
               */
              archivedAt: string | null
              /** @description Why the instruction was archived. `null` while it is active. */
              archivedReason: string | null
              /** @description ID of the conflict issue this instruction records. `null` when `origin` is `human`. */
              sourceIssueId: string | null
              /** @description Who created the instruction. `null` for instructions created by resolving a conflict, and when the creator is unknown. */
              createdBy: {
                /** @description The Sanity user ID, or `sanity-system` when Sanity Context made the change. `null` if unknown. */
                id: string | null
                /** @description The user's name when the action happened. `null` if unknown. For the current name, look up the user by `id`. */
                displayName: string | null
              } | null
              /** @description Who last updated the instruction through the API. `null` when it was never updated, or when the person is unknown. */
              updatedBy: {
                /** @description The Sanity user ID, or `sanity-system` when Sanity Context made the change. `null` if unknown. */
                id: string | null
                /** @description The user's name when the action happened. `null` if unknown. For the current name, look up the user by `id`. */
                displayName: string | null
              } | null
              /**
               * Format: date-time
               * @description When the instruction was created.
               */
              createdAt: string
              /**
               * Format: date-time
               * @description When the instruction last changed, including changes a refresh makes. `null` when the time is unknown.
               */
              updatedAt: string | null
            }
            /** @description ID of the job that rebuilds the entries in `rebuildPaths`. Poll it with `GET .../jobs/{jobId}`. `null` when you didn't pass `rebuildPaths` or the rebuild could not start. The instruction is saved either way. */
            rebuildJobId: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  checkInstruction: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    /** @description An instruction to check before creating it. */
    requestBody: {
      content: {
        'application/json': {
          /** @description The instruction in plain language, as you would pass it to create. */
          statement: string
          /** @description IDs of the documents the instruction will be tied to. The check covers every entry built from any of them. */
          scopeDocumentIds: string[]
          /** @description ID of an entry to leave out of the check, such as the entry the instruction was drafted from. */
          excludeEntryId?: string
          /** @description Set to `true` to list the entries the check would cover in `candidates` without checking them. This makes no model calls. */
          candidatesOnly?: boolean
          /** @description Paths of the entries to check. Paths of entries the check would not cover are ignored. Omit it to check every entry built from the documents. */
          paths?: string[]
        }
      }
    }
    responses: {
      /** @description The result of checking an instruction. Nothing is saved. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description How many entries were checked. Entries with no text, and entries whose check failed, are not counted and not reported. `0` when `candidatesOnly` is set. */
            checked: number
            /** @description The entries that contradict the instruction, ordered by path. Empty when `candidatesOnly` is set. */
            contradictions: {
              /** @description The entry's document ID. */
              id: string
              /** @description The entry's path, such as `products/api/webhooks`. */
              path: string
              /** @description The entry's title. */
              title: string
              /** @description What the entry says now, and why it contradicts the instruction. */
              issue: string
            }[]
            /** @description The entries the check covers, ordered by path. Only present when `candidatesOnly` is set. */
            candidates?: {
              /** @description The entry's document ID. */
              id: string
              /** @description The entry's path, such as `products/api/webhooks`. */
              path: string
              /** @description The entry's title. */
              title: string
            }[]
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  draftInstruction: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    /** @description Feedback to turn into a proposed instruction. */
    requestBody: {
      content: {
        'application/json': {
          /** @description What should change, in your own words, such as "this is wrong" or "never say X". */
          feedback: string
          /** @description ID of the entry the feedback is about. The draft reads the entry and its documents for context. If the entry doesn't exist, the request returns `404` with code `entryNotFound`. */
          entryId?: string
          /** @description The passage of the entry the feedback is about, so the draft addresses that claim. */
          excerpt?: string
          /** @description IDs of the documents to tie the instruction to. Omit it to use the documents of the entry in `entryId`. If neither gives any documents, the request returns `422` with code `instructionScopeVanished`. */
          scopeDocumentIds?: string[]
        }
      }
    }
    responses: {
      /** @description A proposed instruction. Nothing is saved: pass it to `POST .../instructions` to create it. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The proposed instruction in plain language, written as a standing rule. */
            statement: string
            /** @description IDs of the documents the instruction should be tied to: `scopeDocumentIds` from the request, or the documents of the entry in `entryId`. Always at least one. */
            scopeDocumentIds: string[]
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  deleteInstruction: {
    parameters: {
      query?: {
        /** @description Set to `true` to rebuild every entry built from the instruction's documents once it is deleted, so pages written under the instruction reflect their documents again. The response returns the rebuild job ID in `rebuildJobId`. */
        rebuild?: 'true' | 'false'
      }
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The instruction's ID. */
        instructionId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description The rebuild the delete started, if any. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description ID of the job that rebuilds the entries built from the instruction's documents. Poll it with `GET .../jobs/{jobId}`. `null` when you didn't pass `rebuild=true`, no entry is built from those documents, or the rebuild could not start. The instruction is deleted either way. */
            rebuildJobId: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  updateInstruction: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The instruction's ID. */
        instructionId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    /** @description The changes to make to an instruction. Set `statement`, `scopeDocumentIds`, or both. Any update also reactivates an archived instruction. */
    requestBody: {
      content: {
        'application/json': {
          /** @description The new instruction text. Omit it to keep the current text. */
          statement?: string
          /** @description IDs of the documents the instruction applies to. Replaces the current list. Omit it to keep the current documents. IDs of documents that no longer exist are dropped. If none exist, the request returns `422` with code `instructionScopeVanished`. */
          scopeDocumentIds?: string[]
        }
      }
    }
    responses: {
      /** @description A standing instruction that shapes how entries built from its documents are written. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The instruction's document ID. */
            id: string
            /** @description The ID (`kb...`) of the knowledge base the instruction belongs to. */
            knowledgeBaseId: string
            /**
             * @description How the instruction was created. `human`: someone wrote it. `conflict`: it records the side chosen when a conflict issue was resolved. Both kinds work the same way in builds.
             * @enum {string}
             */
            origin: 'conflict' | 'human'
            /**
             * @description Whether builds apply the instruction. `active`: builds apply it. `archived`: a refresh found that its documents no longer support it, so builds stop applying it. To reactivate an archived instruction, update it.
             * @enum {string}
             */
            status: 'active' | 'archived'
            /** @description The instruction in plain language. Builds follow it over what the sources say. */
            statement: string
            /** @description IDs of the documents the instruction applies to. Builds apply it when they write entries built from these documents. An empty array means all of its documents were removed, so it applies to no entries. */
            scopeDocumentIds: string[]
            /**
             * Format: date-time
             * @description When a refresh archived the instruction. `null` while it is active.
             */
            archivedAt: string | null
            /** @description Why the instruction was archived. `null` while it is active. */
            archivedReason: string | null
            /** @description ID of the conflict issue this instruction records. `null` when `origin` is `human`. */
            sourceIssueId: string | null
            /** @description Who created the instruction. `null` for instructions created by resolving a conflict, and when the creator is unknown. */
            createdBy: {
              /** @description The Sanity user ID, or `sanity-system` when Sanity Context made the change. `null` if unknown. */
              id: string | null
              /** @description The user's name when the action happened. `null` if unknown. For the current name, look up the user by `id`. */
              displayName: string | null
            } | null
            /** @description Who last updated the instruction through the API. `null` when it was never updated, or when the person is unknown. */
            updatedBy: {
              /** @description The Sanity user ID, or `sanity-system` when Sanity Context made the change. `null` if unknown. */
              id: string | null
              /** @description The user's name when the action happened. `null` if unknown. For the current name, look up the user by `id`. */
              displayName: string | null
            } | null
            /**
             * Format: date-time
             * @description When the instruction was created.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the instruction last changed, including changes a refresh makes. `null` when the time is unknown.
             */
            updatedAt: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  applyIssues: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody: {
      content: {
        'application/json': {
          /** @description The IDs of the issues to accept and apply. */
          issueIds: string[]
        }
      }
    }
    responses: {
      /** @description A queued job that you can poll for progress. */
      202: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The queued job's ID. Check its progress with `GET .../jobs/{jobId}`. Treat it as an opaque string. Its format can change. */
            jobId: string
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  dismissIssue: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The issue's document ID. */
        issueId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description An issue found in a knowledge base, and its triage status. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The issue's document ID. A later build that finds the same issue in unchanged sources reuses this ID, so your triage decision is kept. */
            id: string
            /** @description The ID (`kb...`) of the knowledge base the issue belongs to. */
            knowledgeBaseId: string
            /** @description What the issue found. The shape depends on `kind`. */
            content:
              | {
                  /**
                   * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                   * @enum {string}
                   */
                  severity: 'critical' | 'suggestion'
                  /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                  scopePath: string
                  /** @description What the problem is, in one or two sentences. */
                  issue: string
                  /** @description What to do to fix the issue. */
                  suggestedFix: string
                  /**
                   * @description The issue type. `conflict` means two or more positions disagree on the same fact, and you choose which one is correct.
                   * @enum {string}
                   */
                  kind: 'conflict'
                  /** @description A key naming the disputed fact, such as `free_tier.request_limit`. It never includes the disputed value, so every side shares it. */
                  claimKey: string
                  /** @description One sentence that explains the question, when it needs one. */
                  context?: string
                  /** @description The conflicting positions, at least two. To resolve the conflict, pass the index of one side as `resolution`. */
                  sides: {
                    /** @description The position as a self-contained sentence. This is the option you choose from. */
                    claim: string
                    /** @description The disputed value on its own, such as `10,000/month`, without the sentence. */
                    value?: string
                    /** @description Paths of the entries that state this position. */
                    entryPaths?: string[]
                    /** @description IDs of the documents that directly back this position. */
                    documentIds?: string[]
                    /** @description The documents that state this value, by the names you know them by. */
                    where?: string
                    /** @description Quotes from the documents that state this value, copied word for word and checked against each document. A document whose wording could not be checked has none. */
                    citations?: {
                      /** @description Stable ID of this citation: 10 lowercase letters and digits. An entry body points to it with a `[^key]` marker. */
                      _key: string
                      /** @enum {string} */
                      _type: 'sanity.context.citation'
                      /** @description ID of the document the quote comes from. Read it with `GET .../documents/{documentId}/content`. */
                      documentId: string
                      /** @description ID of the chunk of the document that holds the quote's first line. A chunk is the text under one heading, and keeps its ID across versions of the document while its headings stay the same. */
                      chunkId: string
                      /** @description The document's name when the entry was written. */
                      title: string
                      /** @description Where the document lives on the web. Absent for uploaded files and datasets. */
                      url?: string
                      /** @description The passage from the document that backs the claims, copied word for word. */
                      quote: string
                      /** @description Up to 32 characters of document text just before the quote, to tell repeats apart. */
                      prefix: string
                      /** @description Up to 32 characters of document text just after the quote, to tell repeats apart. */
                      suffix: string
                      /** @description First line of the quote in the document, counting from 1. Line numbers match `GET .../documents/{documentId}/content`. A hint: the quote is the stable locator. */
                      lineStart: number
                      /** @description Last line of the quote, inclusive. */
                      lineEnd: number
                    }[]
                    /**
                     * @description How much weight the sources behind this position carry. `primary`: your own content, such as uploaded files and pages on your own site. `secondary`: other sources. `community`: forums and Q&A sites.
                     * @enum {string}
                     */
                    authority?: 'primary' | 'secondary' | 'community'
                  }[]
                  /** @description Index in `sides` of the suggested side, when there is one. It is only a hint: nothing is chosen until you resolve the issue. */
                  suggested?: number
                }
              | {
                  /**
                   * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                   * @enum {string}
                   */
                  severity: 'critical' | 'suggestion'
                  /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                  scopePath: string
                  /** @description What the problem is, in one or two sentences. */
                  issue: string
                  /** @description What to do to fix the issue. */
                  suggestedFix: string
                  /**
                   * @description The issue type. `update_required` means an entry is out of date with its sources or contradicts an instruction, and needs a rewrite.
                   * @enum {string}
                   */
                  kind: 'update_required'
                  /** @description IDs of the documents that led to the issue. */
                  citedDocumentIds?: string[]
                  /** @description A key naming the specific finding, when the check that found it sets one. */
                  claimKey?: string
                  /** @description Paths of the entries the issue involves, when it spans more than one entry. */
                  involvedScopes?: string[]
                }
            /**
             * @description The triage status. `open`: waiting for triage. `accepted`: accepted with `POST .../issues/apply`, or a conflict resolved to one side. `rejected`: dismissed. A rejected issue stays rejected. You can return an accepted conflict to `open` with `POST .../issues/{issueId}/reopen`.
             * @enum {string}
             */
            status: 'open' | 'accepted' | 'rejected'
            /** @description Index in `content.sides` of the side chosen when the conflict was resolved. For a conflict on a single entry, index `0` is the entry's current content. `null` until a conflict is resolved, and always `null` for other issue types. */
            resolution: number | null
            /** @description Who triaged the issue, so you can review what your agents decided. `null` while the issue is open, or when the caller could not be identified. */
            resolvedBy: {
              /** @description Sanity user ID of the person or robot that triaged the issue. */
              id: string
              /**
               * @description `user` when a person made the decision. `robot` when a robot token did, such as an agent.
               * @enum {string}
               */
              kind: 'user' | 'robot'
            } | null
            /**
             * Format: date-time
             * @description When the issue was first filed.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the issue left `open`. `null` while the issue is open.
             */
            resolvedAt: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  reopenIssue: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The issue's document ID. */
        issueId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description An issue found in a knowledge base, and its triage status. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The issue's document ID. A later build that finds the same issue in unchanged sources reuses this ID, so your triage decision is kept. */
            id: string
            /** @description The ID (`kb...`) of the knowledge base the issue belongs to. */
            knowledgeBaseId: string
            /** @description What the issue found. The shape depends on `kind`. */
            content:
              | {
                  /**
                   * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                   * @enum {string}
                   */
                  severity: 'critical' | 'suggestion'
                  /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                  scopePath: string
                  /** @description What the problem is, in one or two sentences. */
                  issue: string
                  /** @description What to do to fix the issue. */
                  suggestedFix: string
                  /**
                   * @description The issue type. `conflict` means two or more positions disagree on the same fact, and you choose which one is correct.
                   * @enum {string}
                   */
                  kind: 'conflict'
                  /** @description A key naming the disputed fact, such as `free_tier.request_limit`. It never includes the disputed value, so every side shares it. */
                  claimKey: string
                  /** @description One sentence that explains the question, when it needs one. */
                  context?: string
                  /** @description The conflicting positions, at least two. To resolve the conflict, pass the index of one side as `resolution`. */
                  sides: {
                    /** @description The position as a self-contained sentence. This is the option you choose from. */
                    claim: string
                    /** @description The disputed value on its own, such as `10,000/month`, without the sentence. */
                    value?: string
                    /** @description Paths of the entries that state this position. */
                    entryPaths?: string[]
                    /** @description IDs of the documents that directly back this position. */
                    documentIds?: string[]
                    /** @description The documents that state this value, by the names you know them by. */
                    where?: string
                    /** @description Quotes from the documents that state this value, copied word for word and checked against each document. A document whose wording could not be checked has none. */
                    citations?: {
                      /** @description Stable ID of this citation: 10 lowercase letters and digits. An entry body points to it with a `[^key]` marker. */
                      _key: string
                      /** @enum {string} */
                      _type: 'sanity.context.citation'
                      /** @description ID of the document the quote comes from. Read it with `GET .../documents/{documentId}/content`. */
                      documentId: string
                      /** @description ID of the chunk of the document that holds the quote's first line. A chunk is the text under one heading, and keeps its ID across versions of the document while its headings stay the same. */
                      chunkId: string
                      /** @description The document's name when the entry was written. */
                      title: string
                      /** @description Where the document lives on the web. Absent for uploaded files and datasets. */
                      url?: string
                      /** @description The passage from the document that backs the claims, copied word for word. */
                      quote: string
                      /** @description Up to 32 characters of document text just before the quote, to tell repeats apart. */
                      prefix: string
                      /** @description Up to 32 characters of document text just after the quote, to tell repeats apart. */
                      suffix: string
                      /** @description First line of the quote in the document, counting from 1. Line numbers match `GET .../documents/{documentId}/content`. A hint: the quote is the stable locator. */
                      lineStart: number
                      /** @description Last line of the quote, inclusive. */
                      lineEnd: number
                    }[]
                    /**
                     * @description How much weight the sources behind this position carry. `primary`: your own content, such as uploaded files and pages on your own site. `secondary`: other sources. `community`: forums and Q&A sites.
                     * @enum {string}
                     */
                    authority?: 'primary' | 'secondary' | 'community'
                  }[]
                  /** @description Index in `sides` of the suggested side, when there is one. It is only a hint: nothing is chosen until you resolve the issue. */
                  suggested?: number
                }
              | {
                  /**
                   * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                   * @enum {string}
                   */
                  severity: 'critical' | 'suggestion'
                  /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                  scopePath: string
                  /** @description What the problem is, in one or two sentences. */
                  issue: string
                  /** @description What to do to fix the issue. */
                  suggestedFix: string
                  /**
                   * @description The issue type. `update_required` means an entry is out of date with its sources or contradicts an instruction, and needs a rewrite.
                   * @enum {string}
                   */
                  kind: 'update_required'
                  /** @description IDs of the documents that led to the issue. */
                  citedDocumentIds?: string[]
                  /** @description A key naming the specific finding, when the check that found it sets one. */
                  claimKey?: string
                  /** @description Paths of the entries the issue involves, when it spans more than one entry. */
                  involvedScopes?: string[]
                }
            /**
             * @description The triage status. `open`: waiting for triage. `accepted`: accepted with `POST .../issues/apply`, or a conflict resolved to one side. `rejected`: dismissed. A rejected issue stays rejected. You can return an accepted conflict to `open` with `POST .../issues/{issueId}/reopen`.
             * @enum {string}
             */
            status: 'open' | 'accepted' | 'rejected'
            /** @description Index in `content.sides` of the side chosen when the conflict was resolved. For a conflict on a single entry, index `0` is the entry's current content. `null` until a conflict is resolved, and always `null` for other issue types. */
            resolution: number | null
            /** @description Who triaged the issue, so you can review what your agents decided. `null` while the issue is open, or when the caller could not be identified. */
            resolvedBy: {
              /** @description Sanity user ID of the person or robot that triaged the issue. */
              id: string
              /**
               * @description `user` when a person made the decision. `robot` when a robot token did, such as an agent.
               * @enum {string}
               */
              kind: 'user' | 'robot'
            } | null
            /**
             * Format: date-time
             * @description When the issue was first filed.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the issue left `open`. `null` while the issue is open.
             */
            resolvedAt: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  resolveIssue: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The issue's document ID. */
        issueId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody: {
      content: {
        'application/json': {
          /** @description The index of the chosen side in the issue's `content.sides`. */
          resolution: number
        }
      }
    }
    responses: {
      /** @description The resolved issue, plus the job that rewrites the entry when the decision changes it. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The resolved conflict issue, now `accepted`. */
            issue: {
              /** @description The issue's document ID. A later build that finds the same issue in unchanged sources reuses this ID, so your triage decision is kept. */
              id: string
              /** @description The ID (`kb...`) of the knowledge base the issue belongs to. */
              knowledgeBaseId: string
              /** @description What the issue found. The shape depends on `kind`. */
              content:
                | {
                    /**
                     * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                     * @enum {string}
                     */
                    severity: 'critical' | 'suggestion'
                    /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                    scopePath: string
                    /** @description What the problem is, in one or two sentences. */
                    issue: string
                    /** @description What to do to fix the issue. */
                    suggestedFix: string
                    /**
                     * @description The issue type. `conflict` means two or more positions disagree on the same fact, and you choose which one is correct.
                     * @enum {string}
                     */
                    kind: 'conflict'
                    /** @description A key naming the disputed fact, such as `free_tier.request_limit`. It never includes the disputed value, so every side shares it. */
                    claimKey: string
                    /** @description One sentence that explains the question, when it needs one. */
                    context?: string
                    /** @description The conflicting positions, at least two. To resolve the conflict, pass the index of one side as `resolution`. */
                    sides: {
                      /** @description The position as a self-contained sentence. This is the option you choose from. */
                      claim: string
                      /** @description The disputed value on its own, such as `10,000/month`, without the sentence. */
                      value?: string
                      /** @description Paths of the entries that state this position. */
                      entryPaths?: string[]
                      /** @description IDs of the documents that directly back this position. */
                      documentIds?: string[]
                      /** @description The documents that state this value, by the names you know them by. */
                      where?: string
                      /** @description Quotes from the documents that state this value, copied word for word and checked against each document. A document whose wording could not be checked has none. */
                      citations?: {
                        /** @description Stable ID of this citation: 10 lowercase letters and digits. An entry body points to it with a `[^key]` marker. */
                        _key: string
                        /** @enum {string} */
                        _type: 'sanity.context.citation'
                        /** @description ID of the document the quote comes from. Read it with `GET .../documents/{documentId}/content`. */
                        documentId: string
                        /** @description ID of the chunk of the document that holds the quote's first line. A chunk is the text under one heading, and keeps its ID across versions of the document while its headings stay the same. */
                        chunkId: string
                        /** @description The document's name when the entry was written. */
                        title: string
                        /** @description Where the document lives on the web. Absent for uploaded files and datasets. */
                        url?: string
                        /** @description The passage from the document that backs the claims, copied word for word. */
                        quote: string
                        /** @description Up to 32 characters of document text just before the quote, to tell repeats apart. */
                        prefix: string
                        /** @description Up to 32 characters of document text just after the quote, to tell repeats apart. */
                        suffix: string
                        /** @description First line of the quote in the document, counting from 1. Line numbers match `GET .../documents/{documentId}/content`. A hint: the quote is the stable locator. */
                        lineStart: number
                        /** @description Last line of the quote, inclusive. */
                        lineEnd: number
                      }[]
                      /**
                       * @description How much weight the sources behind this position carry. `primary`: your own content, such as uploaded files and pages on your own site. `secondary`: other sources. `community`: forums and Q&A sites.
                       * @enum {string}
                       */
                      authority?: 'primary' | 'secondary' | 'community'
                    }[]
                    /** @description Index in `sides` of the suggested side, when there is one. It is only a hint: nothing is chosen until you resolve the issue. */
                    suggested?: number
                  }
                | {
                    /**
                     * @description How serious the issue is. `critical`: content is wrong or missing in a way that can mislead an agent. `suggestion`: a change that improves quality.
                     * @enum {string}
                     */
                    severity: 'critical' | 'suggestion'
                    /** @description Path of the entry the issue is about, or `*` when it applies to the whole knowledge base. */
                    scopePath: string
                    /** @description What the problem is, in one or two sentences. */
                    issue: string
                    /** @description What to do to fix the issue. */
                    suggestedFix: string
                    /**
                     * @description The issue type. `update_required` means an entry is out of date with its sources or contradicts an instruction, and needs a rewrite.
                     * @enum {string}
                     */
                    kind: 'update_required'
                    /** @description IDs of the documents that led to the issue. */
                    citedDocumentIds?: string[]
                    /** @description A key naming the specific finding, when the check that found it sets one. */
                    claimKey?: string
                    /** @description Paths of the entries the issue involves, when it spans more than one entry. */
                    involvedScopes?: string[]
                  }
              /**
               * @description The triage status. `open`: waiting for triage. `accepted`: accepted with `POST .../issues/apply`, or a conflict resolved to one side. `rejected`: dismissed. A rejected issue stays rejected. You can return an accepted conflict to `open` with `POST .../issues/{issueId}/reopen`.
               * @enum {string}
               */
              status: 'open' | 'accepted' | 'rejected'
              /** @description Index in `content.sides` of the side chosen when the conflict was resolved. For a conflict on a single entry, index `0` is the entry's current content. `null` until a conflict is resolved, and always `null` for other issue types. */
              resolution: number | null
              /** @description Who triaged the issue, so you can review what your agents decided. `null` while the issue is open, or when the caller could not be identified. */
              resolvedBy: {
                /** @description Sanity user ID of the person or robot that triaged the issue. */
                id: string
                /**
                 * @description `user` when a person made the decision. `robot` when a robot token did, such as an agent.
                 * @enum {string}
                 */
                kind: 'user' | 'robot'
              } | null
              /**
               * Format: date-time
               * @description When the issue was first filed.
               */
              createdAt: string
              /**
               * Format: date-time
               * @description When the issue left `open`. `null` while the issue is open.
               */
              resolvedAt: string | null
            }
            /** @description ID of the job that rewrites the entry to match the chosen side. Poll it with `GET .../jobs/{jobId}`. `null` when nothing is rewritten: you chose index `0`, or the conflict applies to the whole knowledge base. */
            jobId: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  getJob: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The job ID returned by the endpoint that started the work. */
        jobId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description A background job, such as a build, an update or a sync, and its status. `kind` says which, and determines the shape of `result`. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json':
            | {
                /** @description The job's ID. Treat it as an opaque string. Its format can change. */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the job belongs to. */
                knowledgeBaseId: string
                /**
                 * @description The job's status. `queued`: waiting for build capacity. `running`: in progress. `succeeded`: finished successfully. `failed`: stopped with an error. `cancelled`: stopped before it finished. `pending` isn't currently returned.
                 * @enum {string}
                 */
                status: 'pending' | 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled'
                /**
                 * Format: date-time
                 * @description When the job started.
                 */
                startedAt: string | null
                /**
                 * Format: date-time
                 * @description When the job finished. `null` while the job is queued or running.
                 */
                completedAt: string | null
                /** @description A readable reason the job failed or was cancelled. `null` for any other status. */
                error?: string | null
                /** @enum {string} */
                kind: 'build'
                /** @description The job's output. Only present when `status` is `succeeded`. */
                result?: {
                  /** @description The revision the build produced. */
                  revisionId: string
                  /** @description How many entries the built outline has. */
                  entryCount: number
                  /** @description How many issues the build filed. */
                  issuesCreated: number
                  /** @description How many of those issues are critical. */
                  criticalIssueCount: number
                }
              }
            | {
                /** @description The job's ID. Treat it as an opaque string. Its format can change. */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the job belongs to. */
                knowledgeBaseId: string
                /**
                 * @description The job's status. `queued`: waiting for build capacity. `running`: in progress. `succeeded`: finished successfully. `failed`: stopped with an error. `cancelled`: stopped before it finished. `pending` isn't currently returned.
                 * @enum {string}
                 */
                status: 'pending' | 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled'
                /**
                 * Format: date-time
                 * @description When the job started.
                 */
                startedAt: string | null
                /**
                 * Format: date-time
                 * @description When the job finished. `null` while the job is queued or running.
                 */
                completedAt: string | null
                /** @description A readable reason the job failed or was cancelled. `null` for any other status. */
                error?: string | null
                /** @enum {string} */
                kind: 'update'
                /** @description The job's output. Only present when `status` is `succeeded`. */
                result?: {
                  /** @description The revision the update produced. `null` when no entry changed. */
                  revisionId: string | null
                  /** @description How many entries were rewritten. */
                  entriesRewritten: number
                }
              }
            | {
                /** @description The job's ID. Treat it as an opaque string. Its format can change. */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the job belongs to. */
                knowledgeBaseId: string
                /**
                 * @description The job's status. `queued`: waiting for build capacity. `running`: in progress. `succeeded`: finished successfully. `failed`: stopped with an error. `cancelled`: stopped before it finished. `pending` isn't currently returned.
                 * @enum {string}
                 */
                status: 'pending' | 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled'
                /**
                 * Format: date-time
                 * @description When the job started.
                 */
                startedAt: string | null
                /**
                 * Format: date-time
                 * @description When the job finished. `null` while the job is queued or running.
                 */
                completedAt: string | null
                /** @description A readable reason the job failed or was cancelled. `null` for any other status. */
                error?: string | null
                /** @enum {string} */
                kind: 'sync'
                /** @description The job's output. Only present when `status` is `succeeded`. A job can succeed with its sync `held`: check `result.status`. */
                result?: {
                  /**
                   * Format: uuid
                   * @description The ID of the source the job synced.
                   */
                  sourceId: string
                  /**
                   * Format: uuid
                   * @description The ID of the sync the job ran. Follow it with `GET .../sources/{sourceId}/syncs/{syncId}`.
                   */
                  syncId: string
                  /**
                   * @description The sync's status when the job finished. `completed`: the sync applied every change. `held`: the sync would delete many documents and waits for you to confirm or discard the deletion (`POST .../syncs/{syncId}/confirm` or `.../discard`). The sync's own `status` shows whether that has happened since.
                   * @enum {string}
                   */
                  status: 'completed' | 'held'
                  /** @description How many documents the held deletion would remove. `null` unless `status` is `held`. */
                  heldDeletions: number | null
                }
              }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  listSources: {
    parameters: {
      query?: {
        /** @description The `nextCursor` value from the previous page. Omit it to get the first page. */
        cursor?: string
        /** @description The maximum number of items to return. */
        limit?: number
      }
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description A page of sources. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The items on this page. */
            data: (
              | {
                  /**
                   * Format: uuid
                   * @description The source's ID.
                   */
                  id: string
                  /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                  knowledgeBaseId: string
                  /** @description The source's title. */
                  title: string
                  /** @description The number of `active` and `missing` documents. */
                  documentCount: number
                  /** @description How many of those documents are converted to markdown, ready for builds. */
                  convertedDocumentCount: number
                  /** @description How many of those documents have a file type that can't be converted. */
                  skippedDocumentCount: number
                  /** @description How many of those documents failed to convert or were too large to. */
                  failedDocumentCount: number
                  /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                  chunkCount: number
                  /**
                   * Format: date-time
                   * @description When a sync of the source last finished. `null` before the first one.
                   */
                  lastSyncedAt: string | null
                  /** @description The most recent sync, running or finished. `null` before the first one. */
                  latestSync: {
                    /**
                     * Format: uuid
                     * @description The sync's ID.
                     */
                    id: string
                    /**
                     * Format: uuid
                     * @description The ID of the source the sync read.
                     */
                    sourceId: string
                    /**
                     * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                     * @enum {string}
                     */
                    mode: 'full' | 'incremental'
                    /**
                     * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                     * @enum {string}
                     */
                    trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                    /**
                     * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                     * @enum {string}
                     */
                    status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                    /** @description The number of documents the sync read. */
                    documentsSeen: number
                    /** @description The number of documents the sync added or changed. */
                    documentsUpserted: number
                    /** @description The number of documents the sync read that had not changed. */
                    documentsUnchanged: number
                    /** @description The number of documents the sync deleted. */
                    documentsDeleted: number
                    /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                    documentsMissing: number
                    /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                    heldDeletions: number | null
                    /**
                     * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                     * @enum {string|null}
                     */
                    partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                    /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                    error: string | null
                    /**
                     * Format: date-time
                     * @description When the sync started.
                     */
                    createdAt: string
                    /**
                     * Format: date-time
                     * @description When the sync finished. `null` while it is `running` or `held`.
                     */
                    finishedAt: string | null
                  } | null
                  /**
                   * Format: date-time
                   * @description When the source was added.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the source last changed.
                   */
                  updatedAt: string
                  /**
                   * @description The source type. `web` is a crawled website.
                   * @enum {string}
                   */
                  type: 'web'
                  /** @description The URL the crawl starts from. */
                  url: string
                  /** @description Options that control how a website is crawled. */
                  crawlOptions: {
                    /** @description Regular expressions for URL paths to crawl. When set, the crawl only includes pages whose path matches one of them. */
                    includePaths?: string[]
                    /** @description Regular expressions for URL paths to skip. Pages whose path matches one of them aren't crawled. */
                    excludePaths?: string[]
                    /** @description How many levels deep the crawl goes from the root URL. */
                    maxDepth?: number
                    /** @description Whether to crawl only the pages listed in the site's sitemap. */
                    sitemapOnly?: boolean
                    /** @description Whether to treat URLs that differ only by query string as one page. New crawls set it to `true` unless you set it. Set it to `false` when the query string selects different content, such as pagination. */
                    ignoreQueryParameters?: boolean
                    /** @description The maximum number of pages to crawl. The crawl can stop sooner when the knowledge base reaches its source limit. */
                    pageLimit?: number
                  }
                  /**
                   * @description How often the source syncs on its own: `weekly` or `monthly`. `null` when it syncs only when asked to.
                   * @enum {string|null}
                   */
                  syncFrequency: 'weekly' | 'monthly' | null
                }
              | {
                  /**
                   * Format: uuid
                   * @description The source's ID.
                   */
                  id: string
                  /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                  knowledgeBaseId: string
                  /** @description The source's title. */
                  title: string
                  /** @description The number of `active` and `missing` documents. */
                  documentCount: number
                  /** @description How many of those documents are converted to markdown, ready for builds. */
                  convertedDocumentCount: number
                  /** @description How many of those documents have a file type that can't be converted. */
                  skippedDocumentCount: number
                  /** @description How many of those documents failed to convert or were too large to. */
                  failedDocumentCount: number
                  /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                  chunkCount: number
                  /**
                   * Format: date-time
                   * @description When a sync of the source last finished. `null` before the first one.
                   */
                  lastSyncedAt: string | null
                  /** @description The most recent sync, running or finished. `null` before the first one. */
                  latestSync: {
                    /**
                     * Format: uuid
                     * @description The sync's ID.
                     */
                    id: string
                    /**
                     * Format: uuid
                     * @description The ID of the source the sync read.
                     */
                    sourceId: string
                    /**
                     * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                     * @enum {string}
                     */
                    mode: 'full' | 'incremental'
                    /**
                     * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                     * @enum {string}
                     */
                    trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                    /**
                     * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                     * @enum {string}
                     */
                    status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                    /** @description The number of documents the sync read. */
                    documentsSeen: number
                    /** @description The number of documents the sync added or changed. */
                    documentsUpserted: number
                    /** @description The number of documents the sync read that had not changed. */
                    documentsUnchanged: number
                    /** @description The number of documents the sync deleted. */
                    documentsDeleted: number
                    /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                    documentsMissing: number
                    /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                    heldDeletions: number | null
                    /**
                     * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                     * @enum {string|null}
                     */
                    partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                    /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                    error: string | null
                    /**
                     * Format: date-time
                     * @description When the sync started.
                     */
                    createdAt: string
                    /**
                     * Format: date-time
                     * @description When the sync finished. `null` while it is `running` or `held`.
                     */
                    finishedAt: string | null
                  } | null
                  /**
                   * Format: date-time
                   * @description When the source was added.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the source last changed.
                   */
                  updatedAt: string
                  /**
                   * @description The source type. `sanity-dataset` is a GROQ query over a Sanity dataset.
                   * @enum {string}
                   */
                  type: 'sanity-dataset'
                  /** @description The ID of the Sanity project the documents come from. */
                  sanityProjectId: string
                  /** @description The dataset the documents come from. */
                  sanityDatasetId: string
                  /** @description The GROQ query that selects the documents. */
                  query: string
                  /**
                   * @description How often the source syncs on its own: `weekly` or `monthly`. `null` when it syncs only when asked to.
                   * @enum {string|null}
                   */
                  syncFrequency: 'weekly' | 'monthly' | null
                }
              | {
                  /**
                   * Format: uuid
                   * @description The source's ID.
                   */
                  id: string
                  /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                  knowledgeBaseId: string
                  /** @description The source's title. */
                  title: string
                  /** @description The number of `active` and `missing` documents. */
                  documentCount: number
                  /** @description How many of those documents are converted to markdown, ready for builds. */
                  convertedDocumentCount: number
                  /** @description How many of those documents have a file type that can't be converted. */
                  skippedDocumentCount: number
                  /** @description How many of those documents failed to convert or were too large to. */
                  failedDocumentCount: number
                  /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                  chunkCount: number
                  /**
                   * Format: date-time
                   * @description When a sync of the source last finished. `null` before the first one.
                   */
                  lastSyncedAt: string | null
                  /** @description The most recent sync, running or finished. `null` before the first one. */
                  latestSync: {
                    /**
                     * Format: uuid
                     * @description The sync's ID.
                     */
                    id: string
                    /**
                     * Format: uuid
                     * @description The ID of the source the sync read.
                     */
                    sourceId: string
                    /**
                     * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                     * @enum {string}
                     */
                    mode: 'full' | 'incremental'
                    /**
                     * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                     * @enum {string}
                     */
                    trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                    /**
                     * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                     * @enum {string}
                     */
                    status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                    /** @description The number of documents the sync read. */
                    documentsSeen: number
                    /** @description The number of documents the sync added or changed. */
                    documentsUpserted: number
                    /** @description The number of documents the sync read that had not changed. */
                    documentsUnchanged: number
                    /** @description The number of documents the sync deleted. */
                    documentsDeleted: number
                    /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                    documentsMissing: number
                    /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                    heldDeletions: number | null
                    /**
                     * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                     * @enum {string|null}
                     */
                    partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                    /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                    error: string | null
                    /**
                     * Format: date-time
                     * @description When the sync started.
                     */
                    createdAt: string
                    /**
                     * Format: date-time
                     * @description When the sync finished. `null` while it is `running` or `held`.
                     */
                    finishedAt: string | null
                  } | null
                  /**
                   * Format: date-time
                   * @description When the source was added.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the source last changed.
                   */
                  updatedAt: string
                  /**
                   * @description The source type. `files` is an uploaded file or archive of files.
                   * @enum {string}
                   */
                  type: 'files'
                  /** @description The name of the file last synced. `null` before the first upload. */
                  filename: string | null
                  /** @description The size of the file last synced, in bytes. `null` before the first upload. */
                  sizeBytes: number | null
                }
            )[]
            /** @description The cursor for the next page. Pass it as `cursor` to get more results. `null` when there are no more pages. */
            nextCursor: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  createSource: {
    parameters: {
      query?: never
      header?: {
        /** @description A unique value, such as a UUID, that makes retries safe. A retry with the same key and body returns the first response instead of repeating the work. */
        'Idempotency-Key'?: string
      }
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    /** @description The source to add. The `type` field sets its kind. */
    requestBody: {
      content: {
        'application/json':
          | {
              /**
               * @description The source type. `web` crawls a website.
               * @enum {string}
               */
              type: 'web'
              /**
               * Format: uri
               * @description The URL to start crawling from. It must be a public `http` or `https` URL.
               */
              url: string
              /** @description Options for the crawl. Options you omit use the defaults. */
              crawlOptions?: {
                /** @description Regular expressions for URL paths to crawl. When set, the crawl only includes pages whose path matches one of them. */
                includePaths?: string[]
                /** @description Regular expressions for URL paths to skip. Pages whose path matches one of them aren't crawled. */
                excludePaths?: string[]
                /** @description How many levels deep the crawl goes from the root URL. */
                maxDepth?: number
                /** @description Whether to crawl only the pages listed in the site's sitemap. */
                sitemapOnly?: boolean
                /** @description Whether to treat URLs that differ only by query string as one page. New crawls set it to `true` unless you set it. Set it to `false` when the query string selects different content, such as pagination. */
                ignoreQueryParameters?: boolean
                /** @description The maximum number of pages to crawl. The crawl can stop sooner when the knowledge base reaches its source limit. */
                pageLimit?: number
              }
              /** @description Set to `true` to estimate what a crawl would fetch without adding the source. The response is then `200` with a preview of the pages the site has, grouped by path. */
              dryRun?: boolean
            }
          | {
              /**
               * @description The source type. `sanity-dataset` reads documents from a Sanity dataset.
               * @enum {string}
               */
              type: 'sanity-dataset'
              /** @description The ID of the Sanity project to read documents from. You need full read access to the dataset and, on its project, the Administrator or Developer role or a custom role that can create datasets. */
              sanityProjectId: string
              /** @description The dataset to read documents from. */
              sanityDatasetId: string
              /** @description A GROQ query that selects the documents, with an optional projection. Each sync runs it again. */
              query: string
            }
          | {
              /**
               * @description The source type. `files` holds an uploaded file, or text sent with `content`.
               * @enum {string}
               */
              type: 'files'
              /** @description The source's title. */
              title: string
              /** @description Text or markdown for the source to hold, up to 1,000,000 bytes of UTF-8. The source syncs it at once, with no upload. Larger content goes through `POST .../sources/{sourceId}/uploads`. */
              content?: string
              /**
               * @description The format of `content`: `text/markdown` (the default) or `text/plain`. Only with `content`.
               * @enum {string}
               */
              contentType?: 'text/markdown' | 'text/plain'
            }
      }
    }
    responses: {
      /** @description The preview of a crawl, when `dryRun` is `true`. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description How many pages the crawl would fetch, roughly. */
            totalPages: number
            /** @description Whether the site has more pages than the preview counted. */
            truncated: boolean
            /** @description The largest groups of pages by path, largest first. */
            groups: {
              /** @description The path the pages in the group share, such as `/docs/`. */
              prefix: string
              /** @description How many pages the group has. */
              count: number
            }[]
            /** @description How many pages are outside `groups`. */
            otherCount: number
          }
        }
      }
      /** @description Something that yields documents for a knowledge base: a website, a dataset or files. */
      201: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json':
            | {
                /**
                 * Format: uuid
                 * @description The source's ID.
                 */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                knowledgeBaseId: string
                /** @description The source's title. */
                title: string
                /** @description The number of `active` and `missing` documents. */
                documentCount: number
                /** @description How many of those documents are converted to markdown, ready for builds. */
                convertedDocumentCount: number
                /** @description How many of those documents have a file type that can't be converted. */
                skippedDocumentCount: number
                /** @description How many of those documents failed to convert or were too large to. */
                failedDocumentCount: number
                /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                chunkCount: number
                /**
                 * Format: date-time
                 * @description When a sync of the source last finished. `null` before the first one.
                 */
                lastSyncedAt: string | null
                /** @description The most recent sync, running or finished. `null` before the first one. */
                latestSync: {
                  /**
                   * Format: uuid
                   * @description The sync's ID.
                   */
                  id: string
                  /**
                   * Format: uuid
                   * @description The ID of the source the sync read.
                   */
                  sourceId: string
                  /**
                   * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                   * @enum {string}
                   */
                  mode: 'full' | 'incremental'
                  /**
                   * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                   * @enum {string}
                   */
                  trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                  /**
                   * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                   * @enum {string}
                   */
                  status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                  /** @description The number of documents the sync read. */
                  documentsSeen: number
                  /** @description The number of documents the sync added or changed. */
                  documentsUpserted: number
                  /** @description The number of documents the sync read that had not changed. */
                  documentsUnchanged: number
                  /** @description The number of documents the sync deleted. */
                  documentsDeleted: number
                  /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                  documentsMissing: number
                  /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                  heldDeletions: number | null
                  /**
                   * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                   * @enum {string|null}
                   */
                  partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                  /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                  error: string | null
                  /**
                   * Format: date-time
                   * @description When the sync started.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the sync finished. `null` while it is `running` or `held`.
                   */
                  finishedAt: string | null
                } | null
                /**
                 * Format: date-time
                 * @description When the source was added.
                 */
                createdAt: string
                /**
                 * Format: date-time
                 * @description When the source last changed.
                 */
                updatedAt: string
                /**
                 * @description The source type. `web` is a crawled website.
                 * @enum {string}
                 */
                type: 'web'
                /** @description The URL the crawl starts from. */
                url: string
                /** @description Options that control how a website is crawled. */
                crawlOptions: {
                  /** @description Regular expressions for URL paths to crawl. When set, the crawl only includes pages whose path matches one of them. */
                  includePaths?: string[]
                  /** @description Regular expressions for URL paths to skip. Pages whose path matches one of them aren't crawled. */
                  excludePaths?: string[]
                  /** @description How many levels deep the crawl goes from the root URL. */
                  maxDepth?: number
                  /** @description Whether to crawl only the pages listed in the site's sitemap. */
                  sitemapOnly?: boolean
                  /** @description Whether to treat URLs that differ only by query string as one page. New crawls set it to `true` unless you set it. Set it to `false` when the query string selects different content, such as pagination. */
                  ignoreQueryParameters?: boolean
                  /** @description The maximum number of pages to crawl. The crawl can stop sooner when the knowledge base reaches its source limit. */
                  pageLimit?: number
                }
                /**
                 * @description How often the source syncs on its own: `weekly` or `monthly`. `null` when it syncs only when asked to.
                 * @enum {string|null}
                 */
                syncFrequency: 'weekly' | 'monthly' | null
              }
            | {
                /**
                 * Format: uuid
                 * @description The source's ID.
                 */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                knowledgeBaseId: string
                /** @description The source's title. */
                title: string
                /** @description The number of `active` and `missing` documents. */
                documentCount: number
                /** @description How many of those documents are converted to markdown, ready for builds. */
                convertedDocumentCount: number
                /** @description How many of those documents have a file type that can't be converted. */
                skippedDocumentCount: number
                /** @description How many of those documents failed to convert or were too large to. */
                failedDocumentCount: number
                /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                chunkCount: number
                /**
                 * Format: date-time
                 * @description When a sync of the source last finished. `null` before the first one.
                 */
                lastSyncedAt: string | null
                /** @description The most recent sync, running or finished. `null` before the first one. */
                latestSync: {
                  /**
                   * Format: uuid
                   * @description The sync's ID.
                   */
                  id: string
                  /**
                   * Format: uuid
                   * @description The ID of the source the sync read.
                   */
                  sourceId: string
                  /**
                   * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                   * @enum {string}
                   */
                  mode: 'full' | 'incremental'
                  /**
                   * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                   * @enum {string}
                   */
                  trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                  /**
                   * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                   * @enum {string}
                   */
                  status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                  /** @description The number of documents the sync read. */
                  documentsSeen: number
                  /** @description The number of documents the sync added or changed. */
                  documentsUpserted: number
                  /** @description The number of documents the sync read that had not changed. */
                  documentsUnchanged: number
                  /** @description The number of documents the sync deleted. */
                  documentsDeleted: number
                  /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                  documentsMissing: number
                  /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                  heldDeletions: number | null
                  /**
                   * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                   * @enum {string|null}
                   */
                  partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                  /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                  error: string | null
                  /**
                   * Format: date-time
                   * @description When the sync started.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the sync finished. `null` while it is `running` or `held`.
                   */
                  finishedAt: string | null
                } | null
                /**
                 * Format: date-time
                 * @description When the source was added.
                 */
                createdAt: string
                /**
                 * Format: date-time
                 * @description When the source last changed.
                 */
                updatedAt: string
                /**
                 * @description The source type. `sanity-dataset` is a GROQ query over a Sanity dataset.
                 * @enum {string}
                 */
                type: 'sanity-dataset'
                /** @description The ID of the Sanity project the documents come from. */
                sanityProjectId: string
                /** @description The dataset the documents come from. */
                sanityDatasetId: string
                /** @description The GROQ query that selects the documents. */
                query: string
                /**
                 * @description How often the source syncs on its own: `weekly` or `monthly`. `null` when it syncs only when asked to.
                 * @enum {string|null}
                 */
                syncFrequency: 'weekly' | 'monthly' | null
              }
            | {
                /**
                 * Format: uuid
                 * @description The source's ID.
                 */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                knowledgeBaseId: string
                /** @description The source's title. */
                title: string
                /** @description The number of `active` and `missing` documents. */
                documentCount: number
                /** @description How many of those documents are converted to markdown, ready for builds. */
                convertedDocumentCount: number
                /** @description How many of those documents have a file type that can't be converted. */
                skippedDocumentCount: number
                /** @description How many of those documents failed to convert or were too large to. */
                failedDocumentCount: number
                /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                chunkCount: number
                /**
                 * Format: date-time
                 * @description When a sync of the source last finished. `null` before the first one.
                 */
                lastSyncedAt: string | null
                /** @description The most recent sync, running or finished. `null` before the first one. */
                latestSync: {
                  /**
                   * Format: uuid
                   * @description The sync's ID.
                   */
                  id: string
                  /**
                   * Format: uuid
                   * @description The ID of the source the sync read.
                   */
                  sourceId: string
                  /**
                   * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                   * @enum {string}
                   */
                  mode: 'full' | 'incremental'
                  /**
                   * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                   * @enum {string}
                   */
                  trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                  /**
                   * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                   * @enum {string}
                   */
                  status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                  /** @description The number of documents the sync read. */
                  documentsSeen: number
                  /** @description The number of documents the sync added or changed. */
                  documentsUpserted: number
                  /** @description The number of documents the sync read that had not changed. */
                  documentsUnchanged: number
                  /** @description The number of documents the sync deleted. */
                  documentsDeleted: number
                  /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                  documentsMissing: number
                  /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                  heldDeletions: number | null
                  /**
                   * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                   * @enum {string|null}
                   */
                  partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                  /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                  error: string | null
                  /**
                   * Format: date-time
                   * @description When the sync started.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the sync finished. `null` while it is `running` or `held`.
                   */
                  finishedAt: string | null
                } | null
                /**
                 * Format: date-time
                 * @description When the source was added.
                 */
                createdAt: string
                /**
                 * Format: date-time
                 * @description When the source last changed.
                 */
                updatedAt: string
                /**
                 * @description The source type. `files` is an uploaded file or archive of files.
                 * @enum {string}
                 */
                type: 'files'
                /** @description The name of the file last synced. `null` before the first upload. */
                filename: string | null
                /** @description The size of the file last synced, in bytes. `null` before the first upload. */
                sizeBytes: number | null
              }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  getSource: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The source's ID. */
        sourceId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Something that yields documents for a knowledge base: a website, a dataset or files. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json':
            | {
                /**
                 * Format: uuid
                 * @description The source's ID.
                 */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                knowledgeBaseId: string
                /** @description The source's title. */
                title: string
                /** @description The number of `active` and `missing` documents. */
                documentCount: number
                /** @description How many of those documents are converted to markdown, ready for builds. */
                convertedDocumentCount: number
                /** @description How many of those documents have a file type that can't be converted. */
                skippedDocumentCount: number
                /** @description How many of those documents failed to convert or were too large to. */
                failedDocumentCount: number
                /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                chunkCount: number
                /**
                 * Format: date-time
                 * @description When a sync of the source last finished. `null` before the first one.
                 */
                lastSyncedAt: string | null
                /** @description The most recent sync, running or finished. `null` before the first one. */
                latestSync: {
                  /**
                   * Format: uuid
                   * @description The sync's ID.
                   */
                  id: string
                  /**
                   * Format: uuid
                   * @description The ID of the source the sync read.
                   */
                  sourceId: string
                  /**
                   * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                   * @enum {string}
                   */
                  mode: 'full' | 'incremental'
                  /**
                   * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                   * @enum {string}
                   */
                  trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                  /**
                   * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                   * @enum {string}
                   */
                  status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                  /** @description The number of documents the sync read. */
                  documentsSeen: number
                  /** @description The number of documents the sync added or changed. */
                  documentsUpserted: number
                  /** @description The number of documents the sync read that had not changed. */
                  documentsUnchanged: number
                  /** @description The number of documents the sync deleted. */
                  documentsDeleted: number
                  /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                  documentsMissing: number
                  /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                  heldDeletions: number | null
                  /**
                   * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                   * @enum {string|null}
                   */
                  partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                  /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                  error: string | null
                  /**
                   * Format: date-time
                   * @description When the sync started.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the sync finished. `null` while it is `running` or `held`.
                   */
                  finishedAt: string | null
                } | null
                /**
                 * Format: date-time
                 * @description When the source was added.
                 */
                createdAt: string
                /**
                 * Format: date-time
                 * @description When the source last changed.
                 */
                updatedAt: string
                /**
                 * @description The source type. `web` is a crawled website.
                 * @enum {string}
                 */
                type: 'web'
                /** @description The URL the crawl starts from. */
                url: string
                /** @description Options that control how a website is crawled. */
                crawlOptions: {
                  /** @description Regular expressions for URL paths to crawl. When set, the crawl only includes pages whose path matches one of them. */
                  includePaths?: string[]
                  /** @description Regular expressions for URL paths to skip. Pages whose path matches one of them aren't crawled. */
                  excludePaths?: string[]
                  /** @description How many levels deep the crawl goes from the root URL. */
                  maxDepth?: number
                  /** @description Whether to crawl only the pages listed in the site's sitemap. */
                  sitemapOnly?: boolean
                  /** @description Whether to treat URLs that differ only by query string as one page. New crawls set it to `true` unless you set it. Set it to `false` when the query string selects different content, such as pagination. */
                  ignoreQueryParameters?: boolean
                  /** @description The maximum number of pages to crawl. The crawl can stop sooner when the knowledge base reaches its source limit. */
                  pageLimit?: number
                }
                /**
                 * @description How often the source syncs on its own: `weekly` or `monthly`. `null` when it syncs only when asked to.
                 * @enum {string|null}
                 */
                syncFrequency: 'weekly' | 'monthly' | null
              }
            | {
                /**
                 * Format: uuid
                 * @description The source's ID.
                 */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                knowledgeBaseId: string
                /** @description The source's title. */
                title: string
                /** @description The number of `active` and `missing` documents. */
                documentCount: number
                /** @description How many of those documents are converted to markdown, ready for builds. */
                convertedDocumentCount: number
                /** @description How many of those documents have a file type that can't be converted. */
                skippedDocumentCount: number
                /** @description How many of those documents failed to convert or were too large to. */
                failedDocumentCount: number
                /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                chunkCount: number
                /**
                 * Format: date-time
                 * @description When a sync of the source last finished. `null` before the first one.
                 */
                lastSyncedAt: string | null
                /** @description The most recent sync, running or finished. `null` before the first one. */
                latestSync: {
                  /**
                   * Format: uuid
                   * @description The sync's ID.
                   */
                  id: string
                  /**
                   * Format: uuid
                   * @description The ID of the source the sync read.
                   */
                  sourceId: string
                  /**
                   * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                   * @enum {string}
                   */
                  mode: 'full' | 'incremental'
                  /**
                   * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                   * @enum {string}
                   */
                  trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                  /**
                   * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                   * @enum {string}
                   */
                  status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                  /** @description The number of documents the sync read. */
                  documentsSeen: number
                  /** @description The number of documents the sync added or changed. */
                  documentsUpserted: number
                  /** @description The number of documents the sync read that had not changed. */
                  documentsUnchanged: number
                  /** @description The number of documents the sync deleted. */
                  documentsDeleted: number
                  /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                  documentsMissing: number
                  /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                  heldDeletions: number | null
                  /**
                   * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                   * @enum {string|null}
                   */
                  partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                  /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                  error: string | null
                  /**
                   * Format: date-time
                   * @description When the sync started.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the sync finished. `null` while it is `running` or `held`.
                   */
                  finishedAt: string | null
                } | null
                /**
                 * Format: date-time
                 * @description When the source was added.
                 */
                createdAt: string
                /**
                 * Format: date-time
                 * @description When the source last changed.
                 */
                updatedAt: string
                /**
                 * @description The source type. `sanity-dataset` is a GROQ query over a Sanity dataset.
                 * @enum {string}
                 */
                type: 'sanity-dataset'
                /** @description The ID of the Sanity project the documents come from. */
                sanityProjectId: string
                /** @description The dataset the documents come from. */
                sanityDatasetId: string
                /** @description The GROQ query that selects the documents. */
                query: string
                /**
                 * @description How often the source syncs on its own: `weekly` or `monthly`. `null` when it syncs only when asked to.
                 * @enum {string|null}
                 */
                syncFrequency: 'weekly' | 'monthly' | null
              }
            | {
                /**
                 * Format: uuid
                 * @description The source's ID.
                 */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                knowledgeBaseId: string
                /** @description The source's title. */
                title: string
                /** @description The number of `active` and `missing` documents. */
                documentCount: number
                /** @description How many of those documents are converted to markdown, ready for builds. */
                convertedDocumentCount: number
                /** @description How many of those documents have a file type that can't be converted. */
                skippedDocumentCount: number
                /** @description How many of those documents failed to convert or were too large to. */
                failedDocumentCount: number
                /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                chunkCount: number
                /**
                 * Format: date-time
                 * @description When a sync of the source last finished. `null` before the first one.
                 */
                lastSyncedAt: string | null
                /** @description The most recent sync, running or finished. `null` before the first one. */
                latestSync: {
                  /**
                   * Format: uuid
                   * @description The sync's ID.
                   */
                  id: string
                  /**
                   * Format: uuid
                   * @description The ID of the source the sync read.
                   */
                  sourceId: string
                  /**
                   * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                   * @enum {string}
                   */
                  mode: 'full' | 'incremental'
                  /**
                   * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                   * @enum {string}
                   */
                  trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                  /**
                   * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                   * @enum {string}
                   */
                  status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                  /** @description The number of documents the sync read. */
                  documentsSeen: number
                  /** @description The number of documents the sync added or changed. */
                  documentsUpserted: number
                  /** @description The number of documents the sync read that had not changed. */
                  documentsUnchanged: number
                  /** @description The number of documents the sync deleted. */
                  documentsDeleted: number
                  /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                  documentsMissing: number
                  /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                  heldDeletions: number | null
                  /**
                   * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                   * @enum {string|null}
                   */
                  partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                  /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                  error: string | null
                  /**
                   * Format: date-time
                   * @description When the sync started.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the sync finished. `null` while it is `running` or `held`.
                   */
                  finishedAt: string | null
                } | null
                /**
                 * Format: date-time
                 * @description When the source was added.
                 */
                createdAt: string
                /**
                 * Format: date-time
                 * @description When the source last changed.
                 */
                updatedAt: string
                /**
                 * @description The source type. `files` is an uploaded file or archive of files.
                 * @enum {string}
                 */
                type: 'files'
                /** @description The name of the file last synced. `null` before the first upload. */
                filename: string | null
                /** @description The size of the file last synced, in bytes. `null` before the first upload. */
                sizeBytes: number | null
              }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  deleteSource: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The source's ID. */
        sourceId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description The source was deleted. */
      204: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': null
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  updateSource: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The source's ID. */
        sourceId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    /** @description The changes to make to a source. */
    requestBody: {
      content: {
        'application/json': {
          /** @description The source's title. */
          title?: string
          /** @description For a `web` source, the crawl options, replacing the stored ones. Documents whose path the new include and exclude paths leave out are deleted. */
          crawlOptions?: {
            /** @description Regular expressions for URL paths to crawl. When set, the crawl only includes pages whose path matches one of them. */
            includePaths?: string[]
            /** @description Regular expressions for URL paths to skip. Pages whose path matches one of them aren't crawled. */
            excludePaths?: string[]
            /** @description How many levels deep the crawl goes from the root URL. */
            maxDepth?: number
            /** @description Whether to crawl only the pages listed in the site's sitemap. */
            sitemapOnly?: boolean
            /** @description Whether to treat URLs that differ only by query string as one page. New crawls set it to `true` unless you set it. Set it to `false` when the query string selects different content, such as pagination. */
            ignoreQueryParameters?: boolean
            /** @description The maximum number of pages to crawl. The crawl can stop sooner when the knowledge base reaches its source limit. */
            pageLimit?: number
          }
          /** @description For a `sanity-dataset` source, the GROQ query, replacing the stored one. A sync is queued, and removes the documents the query no longer returns. */
          query?: string
          /**
           * @description For a `web` or `sanity-dataset` source, how often it syncs on its own: `weekly` or `monthly`. `null` stops scheduled syncs, and you can still start a sync yourself. Setting a frequency requires a plan that includes scheduled syncs; without one, the request returns `403` with code `featureNotInPlan`.
           * @enum {string|null}
           */
          syncFrequency?: 'weekly' | 'monthly' | null
          /** @description Set to `true` to apply new crawl options that delete many documents. Without it, a change that would delete all of the documents, or five or more that are over a fifth of them, returns `409` with code `sourceDeletionsUnconfirmed`. */
          confirmDeletions?: boolean
        }
      }
    }
    responses: {
      /** @description Something that yields documents for a knowledge base: a website, a dataset or files. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json':
            | {
                /**
                 * Format: uuid
                 * @description The source's ID.
                 */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                knowledgeBaseId: string
                /** @description The source's title. */
                title: string
                /** @description The number of `active` and `missing` documents. */
                documentCount: number
                /** @description How many of those documents are converted to markdown, ready for builds. */
                convertedDocumentCount: number
                /** @description How many of those documents have a file type that can't be converted. */
                skippedDocumentCount: number
                /** @description How many of those documents failed to convert or were too large to. */
                failedDocumentCount: number
                /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                chunkCount: number
                /**
                 * Format: date-time
                 * @description When a sync of the source last finished. `null` before the first one.
                 */
                lastSyncedAt: string | null
                /** @description The most recent sync, running or finished. `null` before the first one. */
                latestSync: {
                  /**
                   * Format: uuid
                   * @description The sync's ID.
                   */
                  id: string
                  /**
                   * Format: uuid
                   * @description The ID of the source the sync read.
                   */
                  sourceId: string
                  /**
                   * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                   * @enum {string}
                   */
                  mode: 'full' | 'incremental'
                  /**
                   * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                   * @enum {string}
                   */
                  trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                  /**
                   * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                   * @enum {string}
                   */
                  status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                  /** @description The number of documents the sync read. */
                  documentsSeen: number
                  /** @description The number of documents the sync added or changed. */
                  documentsUpserted: number
                  /** @description The number of documents the sync read that had not changed. */
                  documentsUnchanged: number
                  /** @description The number of documents the sync deleted. */
                  documentsDeleted: number
                  /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                  documentsMissing: number
                  /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                  heldDeletions: number | null
                  /**
                   * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                   * @enum {string|null}
                   */
                  partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                  /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                  error: string | null
                  /**
                   * Format: date-time
                   * @description When the sync started.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the sync finished. `null` while it is `running` or `held`.
                   */
                  finishedAt: string | null
                } | null
                /**
                 * Format: date-time
                 * @description When the source was added.
                 */
                createdAt: string
                /**
                 * Format: date-time
                 * @description When the source last changed.
                 */
                updatedAt: string
                /**
                 * @description The source type. `web` is a crawled website.
                 * @enum {string}
                 */
                type: 'web'
                /** @description The URL the crawl starts from. */
                url: string
                /** @description Options that control how a website is crawled. */
                crawlOptions: {
                  /** @description Regular expressions for URL paths to crawl. When set, the crawl only includes pages whose path matches one of them. */
                  includePaths?: string[]
                  /** @description Regular expressions for URL paths to skip. Pages whose path matches one of them aren't crawled. */
                  excludePaths?: string[]
                  /** @description How many levels deep the crawl goes from the root URL. */
                  maxDepth?: number
                  /** @description Whether to crawl only the pages listed in the site's sitemap. */
                  sitemapOnly?: boolean
                  /** @description Whether to treat URLs that differ only by query string as one page. New crawls set it to `true` unless you set it. Set it to `false` when the query string selects different content, such as pagination. */
                  ignoreQueryParameters?: boolean
                  /** @description The maximum number of pages to crawl. The crawl can stop sooner when the knowledge base reaches its source limit. */
                  pageLimit?: number
                }
                /**
                 * @description How often the source syncs on its own: `weekly` or `monthly`. `null` when it syncs only when asked to.
                 * @enum {string|null}
                 */
                syncFrequency: 'weekly' | 'monthly' | null
              }
            | {
                /**
                 * Format: uuid
                 * @description The source's ID.
                 */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                knowledgeBaseId: string
                /** @description The source's title. */
                title: string
                /** @description The number of `active` and `missing` documents. */
                documentCount: number
                /** @description How many of those documents are converted to markdown, ready for builds. */
                convertedDocumentCount: number
                /** @description How many of those documents have a file type that can't be converted. */
                skippedDocumentCount: number
                /** @description How many of those documents failed to convert or were too large to. */
                failedDocumentCount: number
                /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                chunkCount: number
                /**
                 * Format: date-time
                 * @description When a sync of the source last finished. `null` before the first one.
                 */
                lastSyncedAt: string | null
                /** @description The most recent sync, running or finished. `null` before the first one. */
                latestSync: {
                  /**
                   * Format: uuid
                   * @description The sync's ID.
                   */
                  id: string
                  /**
                   * Format: uuid
                   * @description The ID of the source the sync read.
                   */
                  sourceId: string
                  /**
                   * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                   * @enum {string}
                   */
                  mode: 'full' | 'incremental'
                  /**
                   * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                   * @enum {string}
                   */
                  trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                  /**
                   * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                   * @enum {string}
                   */
                  status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                  /** @description The number of documents the sync read. */
                  documentsSeen: number
                  /** @description The number of documents the sync added or changed. */
                  documentsUpserted: number
                  /** @description The number of documents the sync read that had not changed. */
                  documentsUnchanged: number
                  /** @description The number of documents the sync deleted. */
                  documentsDeleted: number
                  /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                  documentsMissing: number
                  /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                  heldDeletions: number | null
                  /**
                   * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                   * @enum {string|null}
                   */
                  partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                  /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                  error: string | null
                  /**
                   * Format: date-time
                   * @description When the sync started.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the sync finished. `null` while it is `running` or `held`.
                   */
                  finishedAt: string | null
                } | null
                /**
                 * Format: date-time
                 * @description When the source was added.
                 */
                createdAt: string
                /**
                 * Format: date-time
                 * @description When the source last changed.
                 */
                updatedAt: string
                /**
                 * @description The source type. `sanity-dataset` is a GROQ query over a Sanity dataset.
                 * @enum {string}
                 */
                type: 'sanity-dataset'
                /** @description The ID of the Sanity project the documents come from. */
                sanityProjectId: string
                /** @description The dataset the documents come from. */
                sanityDatasetId: string
                /** @description The GROQ query that selects the documents. */
                query: string
                /**
                 * @description How often the source syncs on its own: `weekly` or `monthly`. `null` when it syncs only when asked to.
                 * @enum {string|null}
                 */
                syncFrequency: 'weekly' | 'monthly' | null
              }
            | {
                /**
                 * Format: uuid
                 * @description The source's ID.
                 */
                id: string
                /** @description The ID (`kb…`) of the knowledge base the source belongs to. */
                knowledgeBaseId: string
                /** @description The source's title. */
                title: string
                /** @description The number of `active` and `missing` documents. */
                documentCount: number
                /** @description How many of those documents are converted to markdown, ready for builds. */
                convertedDocumentCount: number
                /** @description How many of those documents have a file type that can't be converted. */
                skippedDocumentCount: number
                /** @description How many of those documents failed to convert or were too large to. */
                failedDocumentCount: number
                /** @description The number of chunks in its documents' markdown, the unit usage is counted in. */
                chunkCount: number
                /**
                 * Format: date-time
                 * @description When a sync of the source last finished. `null` before the first one.
                 */
                lastSyncedAt: string | null
                /** @description The most recent sync, running or finished. `null` before the first one. */
                latestSync: {
                  /**
                   * Format: uuid
                   * @description The sync's ID.
                   */
                  id: string
                  /**
                   * Format: uuid
                   * @description The ID of the source the sync read.
                   */
                  sourceId: string
                  /**
                   * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
                   * @enum {string}
                   */
                  mode: 'full' | 'incremental'
                  /**
                   * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
                   * @enum {string}
                   */
                  trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
                  /**
                   * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
                   * @enum {string}
                   */
                  status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
                  /** @description The number of documents the sync read. */
                  documentsSeen: number
                  /** @description The number of documents the sync added or changed. */
                  documentsUpserted: number
                  /** @description The number of documents the sync read that had not changed. */
                  documentsUnchanged: number
                  /** @description The number of documents the sync deleted. */
                  documentsDeleted: number
                  /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
                  documentsMissing: number
                  /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
                  heldDeletions: number | null
                  /**
                   * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
                   * @enum {string|null}
                   */
                  partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
                  /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
                  error: string | null
                  /**
                   * Format: date-time
                   * @description When the sync started.
                   */
                  createdAt: string
                  /**
                   * Format: date-time
                   * @description When the sync finished. `null` while it is `running` or `held`.
                   */
                  finishedAt: string | null
                } | null
                /**
                 * Format: date-time
                 * @description When the source was added.
                 */
                createdAt: string
                /**
                 * Format: date-time
                 * @description When the source last changed.
                 */
                updatedAt: string
                /**
                 * @description The source type. `files` is an uploaded file or archive of files.
                 * @enum {string}
                 */
                type: 'files'
                /** @description The name of the file last synced. `null` before the first upload. */
                filename: string | null
                /** @description The size of the file last synced, in bytes. `null` before the first upload. */
                sizeBytes: number | null
              }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  listSyncs: {
    parameters: {
      query?: {
        /** @description The `nextCursor` value from the previous page. Omit it to get the first page. */
        cursor?: string
        /** @description The maximum number of items to return. */
        limit?: number
      }
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The source's ID. */
        sourceId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description A page of syncs. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The items on this page. */
            data: {
              /**
               * Format: uuid
               * @description The sync's ID.
               */
              id: string
              /**
               * Format: uuid
               * @description The ID of the source the sync read.
               */
              sourceId: string
              /**
               * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
               * @enum {string}
               */
              mode: 'full' | 'incremental'
              /**
               * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
               * @enum {string}
               */
              trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
              /**
               * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
               * @enum {string}
               */
              status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
              /** @description The number of documents the sync read. */
              documentsSeen: number
              /** @description The number of documents the sync added or changed. */
              documentsUpserted: number
              /** @description The number of documents the sync read that had not changed. */
              documentsUnchanged: number
              /** @description The number of documents the sync deleted. */
              documentsDeleted: number
              /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
              documentsMissing: number
              /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
              heldDeletions: number | null
              /**
               * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
               * @enum {string|null}
               */
              partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
              /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
              error: string | null
              /**
               * Format: date-time
               * @description When the sync started.
               */
              createdAt: string
              /**
               * Format: date-time
               * @description When the sync finished. `null` while it is `running` or `held`.
               */
              finishedAt: string | null
            }[]
            /** @description The cursor for the next page. Pass it as `cursor` to get more results. `null` when there are no more pages. */
            nextCursor: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  startSync: {
    parameters: {
      query?: never
      header?: {
        /** @description A unique value, such as a UUID, that makes retries safe. A retry with the same key and body returns the first response instead of repeating the work. */
        'Idempotency-Key'?: string
      }
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The source's ID. */
        sourceId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    /** @description What a new sync reads. */
    requestBody: {
      content: {
        'application/json': {
          /**
           * Format: uuid
           * @description For a `files` source, the `uploadId` of the file to sync, from `POST .../sources/{sourceId}/uploads`. Without it, a `files` source reads its current file again. Not allowed for other types.
           */
          uploadId?: string
        } | null
      }
    }
    responses: {
      /** @description The sync that was started or queued. */
      202: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description The ID of the source that will sync.
             */
            sourceId: string
            /** @description For a `files` source, the ID of the sync's job. Check its progress with `GET .../jobs/{jobId}`; once it succeeds, its `result` names the sync and whether it is `held`. `null` for a website or dataset, whose sync is queued on the source: follow it with the source's `latestSync`. */
            jobId: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  getSync: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The source's ID. */
        sourceId: string
        /** @description The sync's ID. */
        syncId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description One run of a source's connector. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description The sync's ID.
             */
            id: string
            /**
             * Format: uuid
             * @description The ID of the source the sync read.
             */
            sourceId: string
            /**
             * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
             * @enum {string}
             */
            mode: 'full' | 'incremental'
            /**
             * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
             * @enum {string}
             */
            trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
            /**
             * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
             * @enum {string}
             */
            status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
            /** @description The number of documents the sync read. */
            documentsSeen: number
            /** @description The number of documents the sync added or changed. */
            documentsUpserted: number
            /** @description The number of documents the sync read that had not changed. */
            documentsUnchanged: number
            /** @description The number of documents the sync deleted. */
            documentsDeleted: number
            /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
            documentsMissing: number
            /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
            heldDeletions: number | null
            /**
             * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
             * @enum {string|null}
             */
            partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
            /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
            error: string | null
            /**
             * Format: date-time
             * @description When the sync started.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the sync finished. `null` while it is `running` or `held`.
             */
            finishedAt: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  confirmSync: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The source's ID. */
        sourceId: string
        /** @description The sync's ID. */
        syncId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description One run of a source's connector. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description The sync's ID.
             */
            id: string
            /**
             * Format: uuid
             * @description The ID of the source the sync read.
             */
            sourceId: string
            /**
             * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
             * @enum {string}
             */
            mode: 'full' | 'incremental'
            /**
             * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
             * @enum {string}
             */
            trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
            /**
             * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
             * @enum {string}
             */
            status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
            /** @description The number of documents the sync read. */
            documentsSeen: number
            /** @description The number of documents the sync added or changed. */
            documentsUpserted: number
            /** @description The number of documents the sync read that had not changed. */
            documentsUnchanged: number
            /** @description The number of documents the sync deleted. */
            documentsDeleted: number
            /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
            documentsMissing: number
            /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
            heldDeletions: number | null
            /**
             * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
             * @enum {string|null}
             */
            partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
            /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
            error: string | null
            /**
             * Format: date-time
             * @description When the sync started.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the sync finished. `null` while it is `running` or `held`.
             */
            finishedAt: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  discardSync: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The source's ID. */
        sourceId: string
        /** @description The sync's ID. */
        syncId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description One run of a source's connector. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description The sync's ID.
             */
            id: string
            /**
             * Format: uuid
             * @description The ID of the source the sync read.
             */
            sourceId: string
            /**
             * @description `full` reads the whole source and removes what it no longer finds. `incremental` reads only what changed since the last sync.
             * @enum {string}
             */
            mode: 'full' | 'incremental'
            /**
             * @description What started the sync: `schedule`, `manual` (an API call or the dashboard), `upload` (a new file), `event` or `push`.
             * @enum {string}
             */
            trigger: 'schedule' | 'manual' | 'upload' | 'event' | 'push'
            /**
             * @description The sync's status. `running`: still reading or converting. `held`: the sync would delete every document of the source, or five or more that are over a fifth of them, and waits for you to confirm or discard the deletion; the next sync of the source cancels it and holds again if the deletion still stands. `completed`, `failed` and `cancelled` are final.
             * @enum {string}
             */
            status: 'running' | 'held' | 'completed' | 'failed' | 'cancelled'
            /** @description The number of documents the sync read. */
            documentsSeen: number
            /** @description The number of documents the sync added or changed. */
            documentsUpserted: number
            /** @description The number of documents the sync read that had not changed. */
            documentsUnchanged: number
            /** @description The number of documents the sync deleted. */
            documentsDeleted: number
            /** @description The number of web pages the sync marked `missing` because several crawls in a row didn't find them. */
            documentsMissing: number
            /** @description How many documents the held deletion would remove. Set while the sync is `held`, and kept after you confirm or discard it. `null` when the sync was never held. */
            heldDeletions: number | null
            /**
             * @description Why the sync stopped before it read the whole source, so it removed nothing. `page-limit`: the crawl reached its page limit. `source-limit`: the knowledge base had no room for more documents. `stalled`: the crawl stopped making progress. `time-limit`: the crawl ran out of time. `null` when the sync read the whole source, or hasn't finished.
             * @enum {string|null}
             */
            partialReason: 'page-limit' | 'source-limit' | 'stalled' | 'time-limit' | null
            /** @description Why the sync failed, written to show to users. `null` unless `status` is `failed`. */
            error: string | null
            /**
             * Format: date-time
             * @description When the sync started.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the sync finished. `null` while it is `running` or `held`.
             */
            finishedAt: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  startSourceUpload: {
    parameters: {
      query?: never
      header?: {
        /** @description A unique value, such as a UUID, that makes retries safe. A retry with the same key and body returns the first response instead of repeating the work. */
        'Idempotency-Key'?: string
      }
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The source's ID. */
        sourceId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    /** @description The file to upload. */
    requestBody: {
      content: {
        'application/json': {
          /** @description The file's name. */
          filename: string
          /** @description The media type of the file. When set, the `PUT` request must send the same `Content-Type` header. */
          contentType?: string
        }
      }
    }
    responses: {
      /** @description Where to upload the file. */
      201: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /**
             * Format: uuid
             * @description The ID of the upload. Pass it to `POST .../syncs` once the file is uploaded.
             */
            uploadId: string
            /**
             * Format: uri
             * @description A signed URL to send the file to in one `PUT` request. It expires after one hour.
             */
            uploadUrl: string
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  syncAllSources: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The knowledge base's ID (`kb...`), its `publicId`. Its UUID `id` is also accepted. */
        knowledgeBaseId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description The syncs that were queued. */
      202: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The IDs of the sources that will sync. Follow each with the source's `latestSync`. `files` sources aren't included: they sync when you upload a file. */
            sourceIds: string[]
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  saveConversation: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description Your ID for the conversation thread, unique within your organization. Up to 200 characters. */
        threadId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
        /** @description The ID of the organization. */
        organizationId: string
      }
      cookie?: never
    }
    /** @description A conversation transcript to save for one thread. */
    requestBody: {
      content: {
        'application/json': {
          /** @description The full transcript so far, in order. It replaces the stored messages. */
          messages: {
            /**
             * @description Who sent the message. `user` is the person talking to the agent, `assistant` is the agent, `system` is a system prompt, and `tool` is a tool call or tool result.
             * @enum {string}
             */
            role: 'user' | 'assistant' | 'system' | 'tool'
            /**
             * @description The message text. `null` when the message has no text, such as a tool call.
             * @default null
             */
            content?: string | null
            /**
             * @description The name of the tool for a `tool` message. `null` on other messages.
             * @default null
             */
            toolName?: string | null
            /**
             * @description The kind of `tool` message. `call` is the agent calling the tool, and `result` is what the tool returned. `null` on other messages.
             * @default null
             * @enum {string|null}
             */
            toolType?: 'call' | 'result' | null
            /**
             * @description Why this step failed, including any stack trace. Set it on the tool result for a failed tool call, or on the assistant message for a turn that failed instead of answering. `null` when the step succeeded.
             * @default null
             */
            error?: string | null
          }[]
          /** @description The provider of the model the agent used. When absent, the stored value stays unchanged. */
          modelProvider?: string
          /** @description The ID of the model the agent used. When absent, the stored value stays unchanged. */
          modelId?: string
          /** @description Token usage for one generation call. The API adds it to the conversation total, but only when this save changes the messages. */
          tokenUsage?: {
            /** @description The number of input tokens. */
            inputTokens?: number
            /** @description The number of output tokens. */
            outputTokens?: number
            /** @description The total number of tokens. */
            totalTokens?: number
          }
          /** @description Up to 20 tags that describe the conversation. Well-known keys are `mcpEndpoints` (names of the MCP endpoints the conversation used), `app`, and `environment`. Add any other keys you need. Replaces the stored metadata. When absent, the stored value stays unchanged. */
          metadata?: {
            [key: string]: string | string[]
          }
          /** @description Your choice to share conversation telemetry with Sanity. Replaces the stored setting. When absent, the stored value stays unchanged. */
          sharing?: {
            /** @description Whether to share classification metrics with Sanity: scores, sentiment, content gap counts, message counts and sizes, tool names, and model and token usage. Message content is not included. */
            metrics?: boolean
            /** @description Whether to share full conversation transcripts with Sanity. When `true`, the API also sets `metrics` to `true`. */
            conversations?: boolean
            /** @description How the Sanity team can reach you about your agent, such as an email address or a Discord handle. */
            contact?: string
          }
        }
      }
    }
    responses: {
      /** @description A recorded agent conversation: its transcript, metadata, token usage, and classification. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The conversation ID, unique within the organization. It matches the `_id` of the conversation document in your document store. */
            id: string
            /** @description Your identifier for the conversation thread, unique within the organization. Saving with the same `threadId` updates the same conversation. */
            threadId: string
            /** @description Tags that describe the conversation, such as `mcpEndpoints`, `app`, and `environment`. Filter on them in GROQ queries. `null` until a save includes `metadata`. */
            metadata: {
              [key: string]: string | string[]
            } | null
            /**
             * Format: date-time
             * @description When the API received the first save for this thread, as an ISO 8601 timestamp.
             */
            startedAt: string
            /**
             * Format: date-time
             * @description When the conversation was last saved, as an ISO 8601 timestamp.
             */
            messagesUpdatedAt: string
            /** @description The conversation transcript, in order. Each save replaces it. */
            messages: {
              /**
               * @description Who sent the message. `user` is the person talking to the agent, `assistant` is the agent, `system` is a system prompt, and `tool` is a tool call or tool result.
               * @enum {string}
               */
              role: 'user' | 'assistant' | 'system' | 'tool'
              /**
               * @description The message text. `null` when the message has no text, such as a tool call.
               * @default null
               */
              content: string | null
              /**
               * @description The name of the tool for a `tool` message. `null` on other messages.
               * @default null
               */
              toolName: string | null
              /**
               * @description The kind of `tool` message. `call` is the agent calling the tool, and `result` is what the tool returned. `null` on other messages.
               * @default null
               * @enum {string|null}
               */
              toolType: 'call' | 'result' | null
              /**
               * @description Why this step failed, including any stack trace. Set it on the tool result for a failed tool call, or on the assistant message for a turn that failed instead of answering. `null` when the step succeeded.
               * @default null
               */
              error: string | null
              /**
               * Format: date-time
               * @description When the API first received this message, as an ISO 8601 timestamp. The API sets it. Resending an unchanged message at the same position keeps its timestamp. `null` for messages recorded before timestamps existed.
               * @default null
               */
              timestamp: string | null
            }[]
            /** @description The provider of the model the agent used. `null` until a save includes `modelProvider`. */
            modelProvider: string | null
            /** @description The ID of the model the agent used. `null` until a save includes `modelId`. */
            modelId: string | null
            /** @description The running total of token usage for the conversation. `null` until a save includes `tokenUsage`. */
            tokenUsage: {
              /** @description The number of input tokens. */
              inputTokens?: number
              /** @description The number of output tokens. */
              outputTokens?: number
              /** @description The total number of tokens. */
              totalTokens?: number
            } | null
            /** @description The latest classification result. `null` until you record one. */
            coreMetrics: {
              /** @description How well the agent resolved the user's needs, from 1 to 10. */
              successScore?: number
              /**
               * @description The overall sentiment of the conversation.
               * @enum {string}
               */
              sentiment?: 'positive' | 'neutral' | 'negative'
              /** @description Topics the agent couldn't answer because it lacked content. */
              contentGaps?: string[]
            } | null
            /**
             * Format: date-time
             * @description When the latest classification result was recorded, as an ISO 8601 timestamp. The API sets it. `null` until you record a result.
             */
            classifiedAt: string | null
            /** @description Why your classifier couldn't classify the conversation. `null` when no failure is recorded. Recording a result clears it. */
            classificationError: string | null
            /** @description Your choice to share conversation telemetry with Sanity. `null` until a save includes `sharing`. */
            sharing: {
              /** @description Whether to share classification metrics with Sanity: scores, sentiment, content gap counts, message counts and sizes, tool names, and model and token usage. Message content is not included. */
              metrics?: boolean
              /** @description Whether to share full conversation transcripts with Sanity. When `true`, the API also sets `metrics` to `true`. */
              conversations?: boolean
              /** @description How the Sanity team can reach you about your agent, such as an email address or a Discord handle. */
              contact?: string
            } | null
            /**
             * Format: date-time
             * @description When the conversation was created, as an ISO 8601 timestamp.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the conversation was last changed, as an ISO 8601 timestamp.
             */
            updatedAt: string
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  deleteConversation: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description Your ID for the conversation thread, unique within your organization. Up to 200 characters. */
        threadId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
        /** @description The ID of the organization. */
        organizationId: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Default Response */
      204: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': null
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  classifyConversation: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description Your ID for the conversation thread, unique within your organization. Up to 200 characters. */
        threadId: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
        /** @description The ID of the organization. */
        organizationId: string
      }
      cookie?: never
    }
    /** @description A classification result or failure for one conversation. Send exactly one of `coreMetrics` or `classificationError`. */
    requestBody: {
      content: {
        'application/json': {
          /** @description The classification result. The API sets `classifiedAt` and clears any recorded `classificationError`. */
          coreMetrics?: {
            /** @description How well the agent resolved the user's needs, as an integer from 1 to 10. */
            successScore: number
            /**
             * @description The overall sentiment of the conversation.
             * @enum {string}
             */
            sentiment: 'positive' | 'neutral' | 'negative'
            /** @description Topics the agent couldn't answer because it lacked content. */
            contentGaps: string[]
          }
          /** @description Why your classifier couldn't classify the conversation. Any earlier classification result stays unchanged. */
          classificationError?: string
        }
      }
    }
    responses: {
      /** @description A recorded agent conversation: its transcript, metadata, token usage, and classification. */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The conversation ID, unique within the organization. It matches the `_id` of the conversation document in your document store. */
            id: string
            /** @description Your identifier for the conversation thread, unique within the organization. Saving with the same `threadId` updates the same conversation. */
            threadId: string
            /** @description Tags that describe the conversation, such as `mcpEndpoints`, `app`, and `environment`. Filter on them in GROQ queries. `null` until a save includes `metadata`. */
            metadata: {
              [key: string]: string | string[]
            } | null
            /**
             * Format: date-time
             * @description When the API received the first save for this thread, as an ISO 8601 timestamp.
             */
            startedAt: string
            /**
             * Format: date-time
             * @description When the conversation was last saved, as an ISO 8601 timestamp.
             */
            messagesUpdatedAt: string
            /** @description The conversation transcript, in order. Each save replaces it. */
            messages: {
              /**
               * @description Who sent the message. `user` is the person talking to the agent, `assistant` is the agent, `system` is a system prompt, and `tool` is a tool call or tool result.
               * @enum {string}
               */
              role: 'user' | 'assistant' | 'system' | 'tool'
              /**
               * @description The message text. `null` when the message has no text, such as a tool call.
               * @default null
               */
              content: string | null
              /**
               * @description The name of the tool for a `tool` message. `null` on other messages.
               * @default null
               */
              toolName: string | null
              /**
               * @description The kind of `tool` message. `call` is the agent calling the tool, and `result` is what the tool returned. `null` on other messages.
               * @default null
               * @enum {string|null}
               */
              toolType: 'call' | 'result' | null
              /**
               * @description Why this step failed, including any stack trace. Set it on the tool result for a failed tool call, or on the assistant message for a turn that failed instead of answering. `null` when the step succeeded.
               * @default null
               */
              error: string | null
              /**
               * Format: date-time
               * @description When the API first received this message, as an ISO 8601 timestamp. The API sets it. Resending an unchanged message at the same position keeps its timestamp. `null` for messages recorded before timestamps existed.
               * @default null
               */
              timestamp: string | null
            }[]
            /** @description The provider of the model the agent used. `null` until a save includes `modelProvider`. */
            modelProvider: string | null
            /** @description The ID of the model the agent used. `null` until a save includes `modelId`. */
            modelId: string | null
            /** @description The running total of token usage for the conversation. `null` until a save includes `tokenUsage`. */
            tokenUsage: {
              /** @description The number of input tokens. */
              inputTokens?: number
              /** @description The number of output tokens. */
              outputTokens?: number
              /** @description The total number of tokens. */
              totalTokens?: number
            } | null
            /** @description The latest classification result. `null` until you record one. */
            coreMetrics: {
              /** @description How well the agent resolved the user's needs, from 1 to 10. */
              successScore?: number
              /**
               * @description The overall sentiment of the conversation.
               * @enum {string}
               */
              sentiment?: 'positive' | 'neutral' | 'negative'
              /** @description Topics the agent couldn't answer because it lacked content. */
              contentGaps?: string[]
            } | null
            /**
             * Format: date-time
             * @description When the latest classification result was recorded, as an ISO 8601 timestamp. The API sets it. `null` until you record a result.
             */
            classifiedAt: string | null
            /** @description Why your classifier couldn't classify the conversation. `null` when no failure is recorded. Recording a result clears it. */
            classificationError: string | null
            /** @description Your choice to share conversation telemetry with Sanity. `null` until a save includes `sharing`. */
            sharing: {
              /** @description Whether to share classification metrics with Sanity: scores, sentiment, content gap counts, message counts and sizes, tool names, and model and token usage. Message content is not included. */
              metrics?: boolean
              /** @description Whether to share full conversation transcripts with Sanity. When `true`, the API also sets `metrics` to `true`. */
              conversations?: boolean
              /** @description How the Sanity team can reach you about your agent, such as an email address or a Discord handle. */
              contact?: string
            } | null
            /**
             * Format: date-time
             * @description When the conversation was created, as an ISO 8601 timestamp.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the conversation was last changed, as an ISO 8601 timestamp.
             */
            updatedAt: string
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  createMcpEndpoint: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
        /** @description The ID of the organization. */
        organizationId: string
      }
      cookie?: never
    }
    /** @description CreateMcpEndpointInput */
    requestBody: {
      content: {
        'application/json': {
          /** @description The endpoint's display title, up to 100 characters. */
          title: string
          /** @description The endpoint's name, used in its URL. Lowercase letters, digits and single hyphens, up to 64 characters, unique in the organization. It can't be changed after the endpoint is created. `by-name` and names shaped like an endpoint ID are reserved. */
          name: string
          /** @description The content the endpoint serves: up to 100 sources, any number of knowledge bases and at most one dataset, served together. Order has no meaning. With no sources, agents can't connect until one is added. */
          sources: (
            | {
                /**
                 * @description The source type. `knowledge-base` serves a whole knowledge base.
                 * @enum {string}
                 */
                type: 'knowledge-base'
                /** @description The knowledge base ID (`kb…`). */
                id: string
              }
            | {
                /**
                 * @description The source type. `dataset` serves documents from a Sanity dataset, limited by the MCP endpoint's `groqFilter` when set.
                 * @enum {string}
                 */
                type: 'dataset'
                /** @description The dataset, as `<projectId>.<datasetName>`. */
                id: string
                /**
                 * @description The studio workspace whose schema agents use, by name. `null` uses the studio's first workspace.
                 * @default null
                 */
                workspace?: string | null
                /**
                 * @description The perspective agents query the dataset with: `published`, `drafts`, or `raw`. `null` uses `published`.
                 * @default null
                 * @enum {string|null}
                 */
                perspective?: 'published' | 'drafts' | 'raw' | null
                /**
                 * @description Whether agents can use semantic search on the dataset. `false` turns it off. `true` or `null` use it while the dataset has embeddings enabled and the organization has embeddings usage left.
                 * @default null
                 */
                semanticSearch?: boolean | null
              }
          )[]
          /** @description Instructions for connecting agents, up to 10,000 characters. */
          instructions?: string
          /** @description A GROQ filter that limits which documents the endpoint's dataset source serves, such as `_type in ["post", "author"]`. Knowledge base sources aren't filtered. Kept only while the endpoint has a dataset source. */
          groqFilter?: string
        }
      }
    }
    responses: {
      /** @description McpEndpoint */
      201: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The endpoint's ID (`mcp…`). Update and delete accept it or the endpoint's name. */
            id: string
            /** @description The ID of the organization that owns the endpoint. */
            organizationId: string
            /** @description The endpoint's display title. */
            title: string
            /** @description The endpoint's name, used in its URL. It can't be changed. */
            name: string
            /** @description The content the endpoint serves: any number of knowledge bases and at most one dataset, served together. With no sources, agents can't connect until one is added. */
            sources: (
              | {
                  /**
                   * @description The source type. `knowledge-base` serves a whole knowledge base.
                   * @enum {string}
                   */
                  type: 'knowledge-base'
                  /** @description The knowledge base ID (`kb…`). */
                  id: string
                }
              | {
                  /**
                   * @description The source type. `dataset` serves documents from a Sanity dataset, limited by the MCP endpoint's `groqFilter` when set.
                   * @enum {string}
                   */
                  type: 'dataset'
                  /** @description The dataset, as `<projectId>.<datasetName>`. */
                  id: string
                  /**
                   * @description The studio workspace whose schema agents use, by name. `null` uses the studio's first workspace.
                   * @default null
                   */
                  workspace: string | null
                  /**
                   * @description The perspective agents query the dataset with: `published`, `drafts`, or `raw`. `null` uses `published`.
                   * @default null
                   * @enum {string|null}
                   */
                  perspective: 'published' | 'drafts' | 'raw' | null
                  /**
                   * @description Whether agents can use semantic search on the dataset. `false` turns it off. `true` or `null` use it while the dataset has embeddings enabled and the organization has embeddings usage left.
                   * @default null
                   */
                  semanticSearch: boolean | null
                }
            )[]
            /** @description Instructions for connecting agents, or `null` if none are set. */
            instructions: string | null
            /** @description The GROQ filter that limits the endpoint's dataset source, or `null` if none is set or the endpoint has no dataset. */
            groqFilter: string | null
            /**
             * Format: uri
             * @description The URL agents connect to.
             */
            url: string
            /**
             * Format: date-time
             * @description When the endpoint was created, as an ISO 8601 timestamp.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the endpoint was last edited, as an ISO 8601 timestamp. Agents using the endpoint don't change it.
             */
            updatedAt: string
            /**
             * Format: date-time
             * @description When an agent last used the endpoint, as an ISO 8601 timestamp. It's recorded at most once a day, so it can be up to a day behind. `null` if the endpoint hasn't been used since usage tracking started.
             */
            lastUsedAt: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  serveMcpEndpoint: {
    parameters: {
      query?: {
        /**
         * @deprecated
         * @description Agent instructions that replace the endpoint's configured instructions for this request. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        instructions?: string
        /**
         * @deprecated
         * @description The perspective for GROQ queries: `published` (default), `previewDrafts`, `raw`, or a release. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        perspective?: string
        /**
         * @deprecated
         * @description Set to `true` or `false` to turn semantic search on or off. Omit it to use the dataset source setting. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        embeddings?: string
        /**
         * @deprecated
         * @description A GROQ filter that narrows the endpoint's configured content filter for this request. Documents must match both. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        groqFilter?: string
        /**
         * @deprecated
         * @description Serves only one side of the endpoint for this request: `knowledge_base` serves its knowledge bases and `groq` serves its dataset. Omit it to serve every source the endpoint has. A request whose chosen side the endpoint doesn't have is refused. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        mode?: 'knowledge_base' | 'groq'
        /**
         * @deprecated
         * @description Comma-separated knowledge base public IDs (`kb...`) that replace the endpoint's knowledge base sources for this request. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        knowledgeBases?: string
        /** @description A JSON array that adds `_url` fields to query results. Each item has `types` (document types), `baseUrl`, and an optional `slugExpression`, a GROQ expression that defaults to `slug.current`. Invalid JSON is ignored. */
        linkResolver?: string
        /**
         * @deprecated
         * @description The studio workspace to use. Replaces the dataset source's workspace for this request. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        workspace?: string
      }
      header?: never
      path: {
        /** @description The MCP endpoint's name, set when the endpoint was created. */
        mcpEndpoint: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
        /** @description The ID of the organization. */
        organizationId: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Default Response */
      200: {
        headers: {
          [name: string]: unknown
        }
        content?: never
      }
    }
  }
  deleteMcpEndpoint: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The MCP endpoint's name, as in its URL, or its ID (`mcp…`). Names can't take the shape of an ID, so either one identifies the endpoint. */
        mcpEndpoint: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
        /** @description The ID of the organization. */
        organizationId: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Default Response */
      204: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': null
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  updateMcpEndpoint: {
    parameters: {
      query?: never
      header?: never
      path: {
        /** @description The MCP endpoint's name, as in its URL, or its ID (`mcp…`). Names can't take the shape of an ID, so either one identifies the endpoint. */
        mcpEndpoint: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
        /** @description The ID of the organization. */
        organizationId: string
      }
      cookie?: never
    }
    /** @description UpdateMcpEndpointInput */
    requestBody: {
      content: {
        'application/json': {
          /** @description The endpoint's display title, up to 100 characters. */
          title?: string
          /** @description The content the endpoint serves: up to 100 sources, any number of knowledge bases and at most one dataset, served together. Order has no meaning. With no sources, agents can't connect until one is added. */
          sources?: (
            | {
                /**
                 * @description The source type. `knowledge-base` serves a whole knowledge base.
                 * @enum {string}
                 */
                type: 'knowledge-base'
                /** @description The knowledge base ID (`kb…`). */
                id: string
              }
            | {
                /**
                 * @description The source type. `dataset` serves documents from a Sanity dataset, limited by the MCP endpoint's `groqFilter` when set.
                 * @enum {string}
                 */
                type: 'dataset'
                /** @description The dataset, as `<projectId>.<datasetName>`. */
                id: string
                /**
                 * @description The studio workspace whose schema agents use, by name. `null` uses the studio's first workspace.
                 * @default null
                 */
                workspace?: string | null
                /**
                 * @description The perspective agents query the dataset with: `published`, `drafts`, or `raw`. `null` uses `published`.
                 * @default null
                 * @enum {string|null}
                 */
                perspective?: 'published' | 'drafts' | 'raw' | null
                /**
                 * @description Whether agents can use semantic search on the dataset. `false` turns it off. `true` or `null` use it while the dataset has embeddings enabled and the organization has embeddings usage left.
                 * @default null
                 */
                semanticSearch?: boolean | null
              }
          )[]
          /** @description Instructions for connecting agents, up to 10,000 characters. `null` removes them. */
          instructions?: string | null
          /** @description A GROQ filter that limits the endpoint's dataset source. `null` removes it. */
          groqFilter?: string | null
        }
      }
    }
    responses: {
      /** @description McpEndpoint */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description The endpoint's ID (`mcp…`). Update and delete accept it or the endpoint's name. */
            id: string
            /** @description The ID of the organization that owns the endpoint. */
            organizationId: string
            /** @description The endpoint's display title. */
            title: string
            /** @description The endpoint's name, used in its URL. It can't be changed. */
            name: string
            /** @description The content the endpoint serves: any number of knowledge bases and at most one dataset, served together. With no sources, agents can't connect until one is added. */
            sources: (
              | {
                  /**
                   * @description The source type. `knowledge-base` serves a whole knowledge base.
                   * @enum {string}
                   */
                  type: 'knowledge-base'
                  /** @description The knowledge base ID (`kb…`). */
                  id: string
                }
              | {
                  /**
                   * @description The source type. `dataset` serves documents from a Sanity dataset, limited by the MCP endpoint's `groqFilter` when set.
                   * @enum {string}
                   */
                  type: 'dataset'
                  /** @description The dataset, as `<projectId>.<datasetName>`. */
                  id: string
                  /**
                   * @description The studio workspace whose schema agents use, by name. `null` uses the studio's first workspace.
                   * @default null
                   */
                  workspace: string | null
                  /**
                   * @description The perspective agents query the dataset with: `published`, `drafts`, or `raw`. `null` uses `published`.
                   * @default null
                   * @enum {string|null}
                   */
                  perspective: 'published' | 'drafts' | 'raw' | null
                  /**
                   * @description Whether agents can use semantic search on the dataset. `false` turns it off. `true` or `null` use it while the dataset has embeddings enabled and the organization has embeddings usage left.
                   * @default null
                   */
                  semanticSearch: boolean | null
                }
            )[]
            /** @description Instructions for connecting agents, or `null` if none are set. */
            instructions: string | null
            /** @description The GROQ filter that limits the endpoint's dataset source, or `null` if none is set or the endpoint has no dataset. */
            groqFilter: string | null
            /**
             * Format: uri
             * @description The URL agents connect to.
             */
            url: string
            /**
             * Format: date-time
             * @description When the endpoint was created, as an ISO 8601 timestamp.
             */
            createdAt: string
            /**
             * Format: date-time
             * @description When the endpoint was last edited, as an ISO 8601 timestamp. Agents using the endpoint don't change it.
             */
            updatedAt: string
            /**
             * Format: date-time
             * @description When an agent last used the endpoint, as an ISO 8601 timestamp. It's recorded at most once a day, so it can be up to a day behind. `null` if the endpoint hasn't been used since usage tracking started.
             */
            lastUsedAt: string | null
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  getMcpEndpointInitialContext: {
    parameters: {
      query?: {
        /**
         * @deprecated
         * @description Agent instructions that replace the endpoint's configured instructions for this request. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        instructions?: string
        /**
         * @deprecated
         * @description The perspective for GROQ queries: `published` (default), `previewDrafts`, `raw`, or a release. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        perspective?: string
        /**
         * @deprecated
         * @description Set to `true` or `false` to turn semantic search on or off. Omit it to use the dataset source setting. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        embeddings?: string
        /**
         * @deprecated
         * @description A GROQ filter that narrows the endpoint's configured content filter for this request. Documents must match both. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        groqFilter?: string
        /**
         * @deprecated
         * @description Serves only one side of the endpoint for this request: `knowledge_base` serves its knowledge bases and `groq` serves its dataset. Omit it to serve every source the endpoint has. A request whose chosen side the endpoint doesn't have is refused. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        mode?: 'knowledge_base' | 'groq'
        /**
         * @deprecated
         * @description Comma-separated knowledge base public IDs (`kb...`) that replace the endpoint's knowledge base sources for this request. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        knowledgeBases?: string
        /** @description A JSON array that adds `_url` fields to query results. Each item has `types` (document types), `baseUrl`, and an optional `slugExpression`, a GROQ expression that defaults to `slug.current`. Invalid JSON is ignored. */
        linkResolver?: string
        /**
         * @deprecated
         * @description The studio workspace to use. Replaces the dataset source's workspace for this request. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        workspace?: string
        /** @description How many levels to shift markdown headings down, from `0` to `6`. Defaults to `1`, so `#` becomes `##`. */
        heading_offset?: string
      }
      header?: never
      path: {
        /** @description The MCP endpoint's name, set when the endpoint was created. */
        mcpEndpoint: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
        /** @description The ID of the organization. */
        organizationId: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Default Response */
      200: {
        headers: {
          [name: string]: unknown
        }
        content?: never
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
  getMcpEndpointStatus: {
    parameters: {
      query?: {
        /**
         * @deprecated
         * @description Agent instructions that replace the endpoint's configured instructions for this request. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        instructions?: string
        /**
         * @deprecated
         * @description The perspective for GROQ queries: `published` (default), `previewDrafts`, `raw`, or a release. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        perspective?: string
        /**
         * @deprecated
         * @description Set to `true` or `false` to turn semantic search on or off. Omit it to use the dataset source setting. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        embeddings?: string
        /**
         * @deprecated
         * @description A GROQ filter that narrows the endpoint's configured content filter for this request. Documents must match both. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        groqFilter?: string
        /**
         * @deprecated
         * @description Serves only one side of the endpoint for this request: `knowledge_base` serves its knowledge bases and `groq` serves its dataset. Omit it to serve every source the endpoint has. A request whose chosen side the endpoint doesn't have is refused. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        mode?: 'knowledge_base' | 'groq'
        /**
         * @deprecated
         * @description Comma-separated knowledge base public IDs (`kb...`) that replace the endpoint's knowledge base sources for this request. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        knowledgeBases?: string
        /** @description A JSON array that adds `_url` fields to query results. Each item has `types` (document types), `baseUrl`, and an optional `slugExpression`, a GROQ expression that defaults to `slug.current`. Invalid JSON is ignored. */
        linkResolver?: string
        /**
         * @deprecated
         * @description The studio workspace to use. Replaces the dataset source's workspace for this request. Deprecated: refused from API version `v2026-11-03`. Configure it on the MCP endpoint instead.
         */
        workspace?: string
      }
      header?: never
      path: {
        /** @description The MCP endpoint's name, set when the endpoint was created. */
        mcpEndpoint: string
        /** @description The API version: a date in the format `vYYYY-MM-DD`, for example `v2026-05-26`, or `vX` for the latest, unstable version. */
        apiVersion: string
        /** @description The ID of the organization. */
        organizationId: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Default Response */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': {
            /** @description Whether every check that applies to the connection passed, except `semanticSearch` and `access`. When `true`, the endpoint is ready for an agent whose credentials can read what it serves. */
            ready: boolean
            /**
             * @deprecated
             * @description Deprecated: use `ready`, which always has the same value.
             */
            requiredOk: boolean
            /** @description One result per check. A check is `null` when it doesn't apply to the connection. */
            checks: {
              /** @description Whether a deployed studio serves the endpoint's dataset. Its schema tells the agent which document types exist. `null` when the connection doesn't query a dataset. */
              studio:
                | (
                    | {
                        /**
                         * @description The check passed.
                         * @enum {boolean}
                         */
                        ok: true
                        /** @description The name of the studio workspace the connection uses. */
                        workspace: string
                        /** @description The workspace's title. */
                        workspaceTitle: string
                        /** @description Whether the workspace was picked automatically because none was set. It is `false` when the dataset source's `workspace` chose it, or a `workspace` query parameter on versions before `v2026-11-03`. */
                        workspaceAutoSelected: boolean
                        /** @description The deployed studio's workspaces for the endpoint's dataset. */
                        availableWorkspaces: {
                          /** @description The workspace's name. */
                          name: string
                          /** @description The workspace's title. */
                          title: string
                        }[]
                      }
                    | {
                        /**
                         * @description The check failed.
                         * @enum {boolean}
                         */
                        ok: false
                        /** @description Why the check failed, written to show to users. */
                        error: string
                      }
                  )
                | null
              /** @description Whether semantic search works on the endpoint's dataset. `null` when the connection doesn't query a dataset, or when semantic search is on but the dataset doesn't have embeddings enabled. It never affects `ready`: without it, the agent searches with GROQ only. */
              semanticSearch:
                | (
                    | {
                        /**
                         * @description The check passed.
                         * @enum {boolean}
                         */
                        ok: true
                        /** @description The dataset's embeddings index status, if known. */
                        status: string | null
                        /** @description Whether the project is within its embeddings usage limit, or `null` if it couldn't be checked. */
                        withinUsageLimit: boolean | null
                        /** @description Whether agents connecting now can use semantic search. On versions before `v2026-11-03`, `?embeddings=true` forces the tool on for agents even when this is `false`. */
                        active: boolean
                        /**
                         * @description Why semantic search isn't active: `turnedOff` when the dataset source has it off, `datasetEmbeddingsNotReady` while the dataset's embeddings are still being prepared, and `usageLimitReached` when the organization has no embeddings usage left. `null` when it is active.
                         * @enum {string|null}
                         */
                        inactiveReason:
                          | 'turnedOff'
                          | 'datasetEmbeddingsNotReady'
                          | 'usageLimitReached'
                          | null
                      }
                    | {
                        /**
                         * @description The check failed.
                         * @enum {boolean}
                         */
                        ok: false
                        /** @description Why the check failed, written to show to users. */
                        error: string
                      }
                  )
                | null
              /** @description Whether the studio's schema has document types the agent can query. `null` when the connection doesn't query a dataset. */
              schema:
                | (
                    | {
                        /**
                         * @description The check passed.
                         * @enum {boolean}
                         */
                        ok: true
                        /** @description The number of document types the agent can query, after the endpoint's GROQ filter. */
                        documentTypes: number
                        /** @description The perspective agents query the dataset with, such as `published` or `drafts`. */
                        perspective: string
                      }
                    | {
                        /**
                         * @description The check failed.
                         * @enum {boolean}
                         */
                        ok: false
                        /** @description Why the check failed, written to show to users. */
                        error: string
                      }
                  )
                | null
              /** @description Whether every knowledge base the connection serves exists and has been built. `null` when the connection doesn't serve knowledge bases. */
              knowledgeBases:
                | (
                    | {
                        /**
                         * @description The check passed.
                         * @enum {boolean}
                         */
                        ok: true
                        /** @description The IDs of the knowledge bases the connection serves. */
                        resolved: string[]
                      }
                    | {
                        /**
                         * @description The check failed.
                         * @enum {boolean}
                         */
                        ok: false
                        /** @description The IDs of the knowledge bases that exist. */
                        resolved: string[]
                        /** @description The IDs of knowledge bases that don't exist in the organization. */
                        missing: string[]
                        /** @description The IDs of knowledge bases that haven't been built yet. Build them before connecting an agent. */
                        unbuilt: string[]
                        /** @description Why the check failed, written to show to users. */
                        error: string
                      }
                  )
                | null
              /** @description Whether your credentials can read the knowledge bases the connection serves. It never affects `ready`: agents connect with their own credentials, so check with the agent's token to know whether that agent can connect. `null` when the connection serves no knowledge bases that exist. */
              access:
                | (
                    | {
                        /**
                         * @description You can read every knowledge base.
                         * @enum {boolean}
                         */
                        ok: true
                      }
                    | {
                        /**
                         * @description You can't read some of the knowledge bases.
                         * @enum {boolean}
                         */
                        ok: false
                        /** @description The IDs of knowledge bases your credentials can't read. */
                        denied: string[]
                        /** @description What you lack, written to show to users. */
                        error: string
                      }
                  )
                | null
            }
          }
        }
      }
      /** @description Error */
      default: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ApiErrorBody']
        }
      }
    }
  }
}
