Atmee.aiDocs
APIAPI referenceAvatars

Replace the avatar's knowledge files

PUT
/v1/avatars/{avatarId}/knowledge

Replaces the whole knowledge set: repeat the files part for each document (pdf, docx, doc, txt, md, html, csv <= 50 MB each; up to 20 files). Send with no files to clear it. descriptions is an optional JSON object mapping a filename to a short description. Or, on an instance that keeps uploads (where POST /v1/uploads answers), application/json: {"files": ["<https URL | upload:<uploadId>>", ...], "descriptions": {...}}, the files by URL or by knowledge uploads (an empty list clears the set). A URL's file is named by its last path segment, an upload's by the fileName it was created with; descriptions uses those names. The uploads are consumed when the replacement succeeds. Re-runs only the build stages that depend on this part; poll GET /v1/avatars/{avatarId} for progress. Requires avatars:write. The knowledge.facts text and the knowledge.questionnaire answers keep their own files: replacing the files leaves them (change them with PATCH). Knowledge is not used in v2 conversations yet.

Authorization

headerX-Api-Key<token>

Secret embed API key (sk_atmee_...; keys minted before 2026-09 carry sk_live_...), held by the customer's own backend and never sent to a browser. Format: X-Api-Key: sk_atmee_....

Path Parameters

avatarId*string
Formatuuid

Request Body

  1. body
files*array<>
descriptions?string

JSON object, filename -> description (<= 500 chars each).

Response Body

Accepted; the affected build stages re-run.

application/json
  1. response
avatarId*string
Formatuuid
status*"building"
Value in"building"
Example Request
curl -X PUT 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge' \  -H 'Content-Type: application/json' \  -d '{  "files": [    "string"  ]}'
Example Response
{  "avatarId": "ac572b6e-802b-4b9e-a602-0786d4441e67",  "status": "building"}
Replace the avatar's knowledge files — Atmee Docs