Knowledge Bases

Edit a pasted-text document

Edit in place and re-ingest. Only documents added as pasted text (source: "api") can be edited; re-add files or URLs instead. Requires the kb:manage scope.

patch/v1/knowledgebases/{id}/documents/{docId}

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/knowledgebases/{id}/documents/{docId}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required
docIdstring required

Request body

textstring required
titlestring

Response

Updated and re-ingesting

idstring
kbIdstring
orgIdstring
source'upload' | 'url' | 'api'

upload = file, url = fetched page, api = pasted text.

uristring nullable
titlestring nullable
filenamestring nullable
mimestring nullable
sizeBytesinteger
chunksinteger

Indexed chunk count (0 until indexed).

status'pending' | 'indexed' | 'failed'
errorstring nullable

Human-readable failure/stall reason.

indexedAtinteger nullable

Unix ms.

createdAtinteger

Unix ms.

Changes

No recorded changes to this operation across all 1 revision of this API.