Knowledge & document review

Create a collection#

A collection groups related documents. A useful first collection might hold a service policy and its escalation guidance. Creating it requires write scope and an Idempotency-Key; reading it requires the independent read scope.

curl -X POST "$MUWKL_BASE_URL/v1/collections" \
  -H "Authorization: Bearer $MUWKL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $COLLECTION_REQUEST_ID" \
  -d '{"name":"Customer service policies"}'

Choose an ingestion profile#

Read the collection’s ingestion-options before uploading. Use an embedding_profile_id and representation returned for your environment. Supported source formats are txt and md; the request carries source text rather than a multipart file upload. The overall API body limit still applies.

POST /v1/collections/{collection_id}/documents accepts a title and upload fields and returns 202 with an ingestion job. TXT content uses text_metadata for language, rendering, support category and citation. A completed ingestion job does not approve the document.

curl "$MUWKL_BASE_URL/v1/collections/$COLLECTION_ID/ingestion-options" \
  -H "Authorization: Bearer $MUWKL_API_KEY"

Review the exact version#

Versions move through draft, approved, superseded and withdrawn. Read the review-packet for the exact version, including its content revision. Passage changes use content_revision to reject stale edits. Workspace API keys can prepare content; they do not grant human approval authority.

Use knowledge for reviewed policies and published information. Query your business provider for a request’s current status, availability or other changing records.

curl "$MUWKL_BASE_URL/v1/documents/$DOCUMENT_ID/versions/$VERSION/review-packet" \
  -H "Authorization: Bearer $MUWKL_API_KEY"

Endpoints#