GET
/v1/replicas/{replicaUUID}
curl \
--request GET 'https://api.sensay.io/v1/replicas/03db5651-cb61-4bdf-9ef0-89561f7c9c53' \
--header "X-ORGANIZATION-SECRET: $API_KEY" \
--header "X-API-Version: 2025-03-25"
Response examples (200)
{
"name": "John Smith",
"purpose": "Acts as my AI twin for answering questions about my creative work.",
"shortDescription": "Accountant from Brooklyn who loves sports.",
"greeting": "What would you like to know?",
"type": "character",
"ownerID": "a-user-id",
"private": false,
"whitelistEmails": [
"user@domain.example"
],
"slug": "example-replica",
"tags": [
"male",
"italian"
],
"profileImage": "https://images.invalid/photo.jpeg",
"suggestedQuestions": [
"What is the meaning of life?"
],
"llm": {
"model": "gpt-4o",
"memoryMode": "rag-search",
"systemMessage": "Concise, knowledgeable, empathetic and cheerful.",
"tools": [
"getTokenInfo"
],
"embeddingModel": "multilingual-e5-large"
},
"voicePreviewText": "Hi, I'm your Sensay replica! How can I assist you today?",
"isEveryConversationAccessibleBySupport": true,
"uuid": "4830597b-f3be-42b4-9587-fa15299ccd63",
"distilledKnowledge": "This is the distilled knowledge of the replica.",
"success": true
}
Response examples (400)
{
"error": "Replica owner knowledge base entry custom quota exceeded. Current usage: 10/10. To fix this, either increase the totalUserQuota value in your request's usageLimits parameter or remove some existing Knowledge Base entries.",
"success": false,
"error_code": "KNOWLEDGE_BASE_CUSTOM_QUOTA_EXCEEDED",
"request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
"fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}
Response examples (401)
{
"error": "Replica owner knowledge base entry custom quota exceeded. Current usage: 10/10. To fix this, either increase the totalUserQuota value in your request's usageLimits parameter or remove some existing Knowledge Base entries.",
"success": false,
"error_code": "KNOWLEDGE_BASE_CUSTOM_QUOTA_EXCEEDED",
"request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
"fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}
Response examples (404)
{
"error": "A text representation of the error",
"success": false,
"request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab"
}
Response examples (415)
{
"error": "Replica owner knowledge base entry custom quota exceeded. Current usage: 10/10. To fix this, either increase the totalUserQuota value in your request's usageLimits parameter or remove some existing Knowledge Base entries.",
"success": false,
"error_code": "KNOWLEDGE_BASE_CUSTOM_QUOTA_EXCEEDED",
"request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
"fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}
Response examples (500)
{
"error": "A text representation of the error",
"success": false,
"request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
"fingerprint": "14fceadd84e74ec499afe9b0f7952d6b",
"inner_exception": {
"name": "Server overheated",
"cause": "Request too complicated",
"stack": "Error: Server overheated due to an unexpected situation\n at Object.eval (eval at <anonymous>...",
"message": "The server overheated due to an unexpected situation"
}
}