Atmee.aiDocs
APIAPI referenceAvatars

The avatar's facts and knowledge files

GET
/v1/avatars/{avatarId}/knowledge

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

Response Body

The facts as set, the questionnaire's questions and answers, and the knowledge files, with presigned URLs.

application/json
  1. response
questions*array<string>

The questions of Creator Studio's knowledge questionnaire, in Studio's order; the keys knowledge.questionnaire takes.

questionnaire*

Creator Studio's knowledge questionnaire, question to answer.

integrationIds*array<string>
facts?string

The facts as set with knowledge.facts; null when none are.

files*array<>
expiresAt?string

When the file URLs stop working; GET again for fresh ones.

Formatdate-time
Example Request
curl -X GET 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge'
Example Response
{  "questions": [    "string"  ],  "questionnaire": {    "property1": "string",    "property2": "string"  },  "integrationIds": [    "string"  ],  "facts": "string",  "files": [    {      "id": "string",      "name": "string",      "description": "string",      "sizeBytes": 0,      "url": "string"    }  ],  "expiresAt": "2019-08-24T14:15:22Z"}