{ "info": { "_postman_id": "2cd1f7bc-5dd0-4fe2-9138-93bae6c4e3be", "name": "Sensay API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "49231023", "_collection_link": "https://marco-61f57c5e-1369843.postman.co/workspace/Marco-Bettiolo's-Workspace~0659bf6d-0adf-48d3-89da-a41d6c0b2a04/collection/49231023-2cd1f7bc-5dd0-4fe2-9138-93bae6c4e3be?action=share&source=collection_link&creator=49231023" }, "item": [ { "name": "v1", "item": [ { "name": "api-keys", "item": [ { "name": "invites", "item": [ { "name": "{code}", "item": [ { "name": "redeem", "item": [ { "name": "Redeem an API key invitation", "request": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"string\",\n \"name\": \"string\",\n \"email\": \"mEjq6k@TAcBFtLUilmhGGdrWSOxtZbwqNb.qd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/api-keys/invites/:code/redeem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys", "invites", ":code", "redeem" ], "variable": [ { "key": "code", "value": "string", "description": "The code of the invite you want to redeem." } ] }, "description": "\n If you have an invitation code, you can redeem it to create an Organization and an API key associated with it.\n " }, "response": [ { "name": "Details about the created Organization and API Key.", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"string\",\n \"name\": \"string\",\n \"email\": \"mEjq6k@TAcBFtLUilmhGGdrWSOxtZbwqNb.qd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/api-keys/invites/:code/redeem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys", "invites", ":code", "redeem" ], "variable": [ { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"apiKey\": \"1234567890\",\n \"organizationID\": \"1234567890\",\n \"validUntil\": \"2021-01-01\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"string\",\n \"name\": \"string\",\n \"email\": \"mEjq6k@TAcBFtLUilmhGGdrWSOxtZbwqNb.qd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/api-keys/invites/:code/redeem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys", "invites", ":code", "redeem" ], "variable": [ { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"string\",\n \"name\": \"string\",\n \"email\": \"mEjq6k@TAcBFtLUilmhGGdrWSOxtZbwqNb.qd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/api-keys/invites/:code/redeem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys", "invites", ":code", "redeem" ], "variable": [ { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"string\",\n \"name\": \"string\",\n \"email\": \"mEjq6k@TAcBFtLUilmhGGdrWSOxtZbwqNb.qd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/api-keys/invites/:code/redeem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys", "invites", ":code", "redeem" ], "variable": [ { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"string\",\n \"name\": \"string\",\n \"email\": \"mEjq6k@TAcBFtLUilmhGGdrWSOxtZbwqNb.qd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/api-keys/invites/:code/redeem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys", "invites", ":code", "redeem" ], "variable": [ { "key": "code" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"string\",\n \"name\": \"string\",\n \"email\": \"mEjq6k@TAcBFtLUilmhGGdrWSOxtZbwqNb.qd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/api-keys/invites/:code/redeem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api-keys", "invites", ":code", "redeem" ], "variable": [ { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] } ] } ] } ] }, { "name": "replicas", "item": [ { "name": "{replicaUUID}", "item": [ { "name": "chat", "item": [ { "name": "history", "item": [ { "name": "telegram", "item": [ { "name": "Get Telegram chat history", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "telegram" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "List telegram chat history items of a Replica belonging to the logged in user." }, "response": [ { "name": "List the chat history of the replica by the currently logged in user", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"type\": \"string\",\n \"items\": [\n {\n \"content\": \"Hello\",\n \"created_at\": \"2024-09-24T09:09:55.66709+00:00\",\n \"id\": 1,\n \"is_private\": false,\n \"role\": \"user\",\n \"source\": \"web\",\n \"sources\": [\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n },\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n }\n ],\n \"user_uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"original_message_id\": \"msg-GbsIAyNcNZCMAaDET3zXhInw\"\n },\n {\n \"content\": \"Hello\",\n \"created_at\": \"2024-09-24T09:09:55.66709+00:00\",\n \"id\": 1,\n \"is_private\": false,\n \"role\": \"user\",\n \"source\": \"web\",\n \"sources\": [\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n },\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n }\n ],\n \"user_uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"original_message_id\": \"msg-GbsIAyNcNZCMAaDET3zXhInw\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "The replica specified could not be found or you do not have access to it", "originalRequest": { "method": "GET", "header": [ { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": null }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] }, { "name": "Create a Telegram chat history entry", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"telegram_data\": {\n \"chat_type\": \"string\",\n \"chat_id\": 3692.7312554139057,\n \"message_id\": 5235.548738376101,\n \"chat_name\": \"string\",\n \"user_id\": 3495.154135591747,\n \"username\": \"string\",\n \"message_thread_id\": 6295.875453089926\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "telegram" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Save chat history items of a Replica belonging to the logged in user." }, "response": [ { "name": "Saves the chat history of the replica by the currently logged in user.", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"telegram_data\": {\n \"chat_type\": \"string\",\n \"chat_id\": 3692.7312554139057,\n \"message_id\": 5235.548738376101,\n \"chat_name\": \"string\",\n \"user_id\": 3495.154135591747,\n \"username\": \"string\",\n \"message_thread_id\": 6295.875453089926\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true\n}" }, { "name": "The replica specified could not be found or you do not have access to it", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"telegram_data\": {\n \"chat_type\": \"string\",\n \"chat_id\": 3692.7312554139057,\n \"message_id\": 5235.548738376101,\n \"chat_name\": \"string\",\n \"user_id\": 3495.154135591747,\n \"username\": \"string\",\n \"message_thread_id\": 6295.875453089926\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": null } ] } ] }, { "name": "discord", "item": [ { "name": "Get Discord chat history", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/discord", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "discord" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "List discord chat history items of a Replica belonging to the logged in user." }, "response": [ { "name": "List the chat history of the replica by the currently logged in user", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/discord", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "discord" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"type\": \"string\",\n \"items\": [\n {\n \"content\": \"Hello\",\n \"created_at\": \"2024-09-24T09:09:55.66709+00:00\",\n \"id\": 1,\n \"is_private\": false,\n \"role\": \"user\",\n \"source\": \"web\",\n \"sources\": [\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n },\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n }\n ],\n \"user_uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"original_message_id\": \"msg-GbsIAyNcNZCMAaDET3zXhInw\"\n },\n {\n \"content\": \"Hello\",\n \"created_at\": \"2024-09-24T09:09:55.66709+00:00\",\n \"id\": 1,\n \"is_private\": false,\n \"role\": \"user\",\n \"source\": \"web\",\n \"sources\": [\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n },\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n }\n ],\n \"user_uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"original_message_id\": \"msg-GbsIAyNcNZCMAaDET3zXhInw\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/discord", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "discord" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/discord", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "discord" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "The replica specified could not be found or you do not have access to it", "originalRequest": { "method": "GET", "header": [ { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/discord", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "discord" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": null }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/discord", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "discord" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/discord", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "discord" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "web", "item": [ { "name": "Get Web chat history", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/web", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "web" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "List web chat history items of a Replica belonging to the logged in user." }, "response": [ { "name": "List the chat history of the replica by the currently logged in user", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/web", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "web" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"type\": \"string\",\n \"items\": [\n {\n \"content\": \"Hello\",\n \"created_at\": \"2024-09-24T09:09:55.66709+00:00\",\n \"id\": 1,\n \"is_private\": false,\n \"role\": \"user\",\n \"source\": \"web\",\n \"sources\": [\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n },\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n }\n ],\n \"user_uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"original_message_id\": \"msg-GbsIAyNcNZCMAaDET3zXhInw\"\n },\n {\n \"content\": \"Hello\",\n \"created_at\": \"2024-09-24T09:09:55.66709+00:00\",\n \"id\": 1,\n \"is_private\": false,\n \"role\": \"user\",\n \"source\": \"web\",\n \"sources\": [\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n },\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n }\n ],\n \"user_uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"original_message_id\": \"msg-GbsIAyNcNZCMAaDET3zXhInw\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/web", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "web" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/web", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "web" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "The replica specified could not be found or you do not have access to it", "originalRequest": { "method": "GET", "header": [ { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/web", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "web" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": null }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/web", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "web" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/web", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "web" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "embed", "item": [ { "name": "Get Embed chat history", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/embed", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "embed" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "List embed chat history items of a Replica belonging to the logged in user." }, "response": [ { "name": "List the chat history of the replica by the currently logged in user", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/embed", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "embed" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"type\": \"string\",\n \"items\": [\n {\n \"content\": \"Hello\",\n \"created_at\": \"2024-09-24T09:09:55.66709+00:00\",\n \"id\": 1,\n \"is_private\": false,\n \"role\": \"user\",\n \"source\": \"web\",\n \"sources\": [\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n },\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n }\n ],\n \"user_uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"original_message_id\": \"msg-GbsIAyNcNZCMAaDET3zXhInw\"\n },\n {\n \"content\": \"Hello\",\n \"created_at\": \"2024-09-24T09:09:55.66709+00:00\",\n \"id\": 1,\n \"is_private\": false,\n \"role\": \"user\",\n \"source\": \"web\",\n \"sources\": [\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n },\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n }\n ],\n \"user_uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"original_message_id\": \"msg-GbsIAyNcNZCMAaDET3zXhInw\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/embed", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "embed" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/embed", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "embed" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "The replica specified could not be found or you do not have access to it", "originalRequest": { "method": "GET", "header": [ { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/embed", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "embed" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": null }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/embed", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "embed" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history/embed", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history", "embed" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "Get chat history", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "List chat history items of a Replica belonging to the logged in user." }, "response": [ { "name": "List the chat history of the replica by the currently logged in user", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"type\": \"string\",\n \"items\": [\n {\n \"content\": \"Hello\",\n \"created_at\": \"2024-09-24T09:09:55.66709+00:00\",\n \"id\": 1,\n \"is_private\": false,\n \"role\": \"user\",\n \"source\": \"web\",\n \"sources\": [\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n },\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n }\n ],\n \"user_uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"original_message_id\": \"msg-GbsIAyNcNZCMAaDET3zXhInw\"\n },\n {\n \"content\": \"Hello\",\n \"created_at\": \"2024-09-24T09:09:55.66709+00:00\",\n \"id\": 1,\n \"is_private\": false,\n \"role\": \"user\",\n \"source\": \"web\",\n \"sources\": [\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n },\n {\n \"id\": 123,\n \"score\": 0.9,\n \"status\": \"scored\",\n \"created_at\": \"2024-03-15T14:30:00.000Z\",\n \"name\": \"Q: Next, what’s your nationality?\",\n \"content\": \"Next, what’s your nationality? Mars\"\n }\n ],\n \"user_uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"original_message_id\": \"msg-GbsIAyNcNZCMAaDET3zXhInw\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "The replica specified could not be found or you do not have access to it", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": null }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] }, { "name": "Create a chat history entry", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"source\": \"web\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Save chat history items of a Replica belonging to the logged in user." }, "response": [ { "name": "Saves the chat history of the replica by the currently logged in user.", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"source\": \"web\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true\n}" }, { "name": "The replica specified could not be found or you do not have access to it", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"source\": \"web\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "history" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": null } ] } ] }, { "name": "completions", "item": [ { "name": "telegram", "item": [ { "name": "Generate a Telegram completion", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"telegram_data\": {\n \"chat_type\": \"string\",\n \"chat_id\": 723.9973989721249,\n \"message_id\": 6983.602098055592,\n \"chat_name\": \"string\",\n \"user_id\": 9713.890323481071,\n \"username\": \"string\",\n \"message_thread_id\": 7645.70267383596\n },\n \"skip_chat_history\": false,\n \"imageURL\": \"https://images.invalid/photo.jpeg\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions", "telegram" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "\n Ask for a completion and stores the prompt in the chat history.\n\n Replica chat supports two response formats: streamed and JSON. To switch between these formats, use the 'Accept' header, specifying either 'text/event-stream' for streaming or 'application/json' for JSON.\n The streamed response honours the [Stream Protocol](https://sdk.vercel.ai/docs/ai-sdk-ui/stream-protocol), allowing the use of a number of SDKs, including [Vercel AI SDK](https://sdk.vercel.ai/docs/introduction).\n\n The streamed variant is not specified in the OpenAPI Schema because it is not an OpenAPI endpoint.\n " }, "response": [ { "name": "List of chat messages had with a replica by the current user, including the completion", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"telegram_data\": {\n \"chat_type\": \"string\",\n \"chat_id\": 723.9973989721249,\n \"message_id\": 6983.602098055592,\n \"chat_name\": \"string\",\n \"user_id\": 9713.890323481071,\n \"username\": \"string\",\n \"message_thread_id\": 7645.70267383596\n },\n \"skip_chat_history\": false,\n \"imageURL\": \"https://images.invalid/photo.jpeg\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"content\": \"I handled the immense pressure during the Civil War by...\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"telegram_data\": {\n \"chat_type\": \"string\",\n \"chat_id\": 723.9973989721249,\n \"message_id\": 6983.602098055592,\n \"chat_name\": \"string\",\n \"user_id\": 9713.890323481071,\n \"username\": \"string\",\n \"message_thread_id\": 7645.70267383596\n },\n \"skip_chat_history\": false,\n \"imageURL\": \"https://images.invalid/photo.jpeg\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"telegram_data\": {\n \"chat_type\": \"string\",\n \"chat_id\": 723.9973989721249,\n \"message_id\": 6983.602098055592,\n \"chat_name\": \"string\",\n \"user_id\": 9713.890323481071,\n \"username\": \"string\",\n \"message_thread_id\": 7645.70267383596\n },\n \"skip_chat_history\": false,\n \"imageURL\": \"https://images.invalid/photo.jpeg\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"telegram_data\": {\n \"chat_type\": \"string\",\n \"chat_id\": 723.9973989721249,\n \"message_id\": 6983.602098055592,\n \"chat_name\": \"string\",\n \"user_id\": 9713.890323481071,\n \"username\": \"string\",\n \"message_thread_id\": 7645.70267383596\n },\n \"skip_chat_history\": false,\n \"imageURL\": \"https://images.invalid/photo.jpeg\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"telegram_data\": {\n \"chat_type\": \"string\",\n \"chat_id\": 723.9973989721249,\n \"message_id\": 6983.602098055592,\n \"chat_name\": \"string\",\n \"user_id\": 9713.890323481071,\n \"username\": \"string\",\n \"message_thread_id\": 7645.70267383596\n },\n \"skip_chat_history\": false,\n \"imageURL\": \"https://images.invalid/photo.jpeg\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"telegram_data\": {\n \"chat_type\": \"string\",\n \"chat_id\": 723.9973989721249,\n \"message_id\": 6983.602098055592,\n \"chat_name\": \"string\",\n \"user_id\": 9713.890323481071,\n \"username\": \"string\",\n \"message_thread_id\": 7645.70267383596\n },\n \"skip_chat_history\": false,\n \"imageURL\": \"https://images.invalid/photo.jpeg\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "Generate a completion", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"skip_chat_history\": false,\n \"source\": \"telegram_autopilot\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "\n Ask for a completion and stores the prompt in the chat history.\n\n Replica chat supports two response formats: streamed and JSON. To switch between these formats, use the 'Accept' header, specifying either 'text/event-stream' for streaming or 'application/json' for JSON.\n The streamed response honours the [Stream Protocol](https://sdk.vercel.ai/docs/ai-sdk-ui/stream-protocol), allowing the use of a number of SDKs, including [Vercel AI SDK](https://sdk.vercel.ai/docs/introduction).\n\n The streamed variant is not specified in the OpenAPI Schema because it is not an OpenAPI endpoint.\n " }, "response": [ { "name": "List of chat messages had with a replica by the current user, including the completion", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"skip_chat_history\": false,\n \"source\": \"telegram_autopilot\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"content\": \"I handled the immense pressure during the Civil War by...\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"skip_chat_history\": false,\n \"source\": \"telegram_autopilot\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"skip_chat_history\": false,\n \"source\": \"telegram_autopilot\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"skip_chat_history\": false,\n \"source\": \"telegram_autopilot\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"skip_chat_history\": false,\n \"source\": \"telegram_autopilot\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How did you handle the immense pressure during the Civil War?\",\n \"skip_chat_history\": false,\n \"source\": \"telegram_autopilot\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] } ] }, { "name": "integrations", "item": [ { "name": "telegram", "item": [ { "name": "Create a replica Telegram integration", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"telegram_token\": \"string\",\n \"mention\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Integrates a replica to Telegram. The default Sensay Telegram integration will run a bot for you until you delete the integration." }, "response": [ { "name": "Telegram integration created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"telegram_token\": \"string\",\n \"mention\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"id\": 4037.6306189292286\n}" }, { "name": "Telegram integration created successfully, but failed to notify the external integration server. If you are using the default Sensay Telegram Integration, we will retry starting the bot asynchronously.", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"telegram_token\": \"string\",\n \"mention\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"id\": 2178.527870041216,\n \"message\": \"Telegram integration created successfully, but failed to notify the external integration server. If you are using the default Sensay Telegram Integration, we will retry starting the bot asynchronously.\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"telegram_token\": \"string\",\n \"mention\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"telegram_token\": \"string\",\n \"mention\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"telegram_token\": \"string\",\n \"mention\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"telegram_token\": \"string\",\n \"mention\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"telegram_token\": \"string\",\n \"mention\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] }, { "name": "Delete a replica Telegram integration", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Removes a replica Telegram integration." }, "response": [ { "name": "Telegram integration deleted successfully", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true\n}" }, { "name": "Telegram integration deleted successfully, but failed to notify the external integration server. If you are using the default Sensay Telegram Integration, we will retry stopping the bot asynchronously.", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"message\": \"Telegram integration deleted successfully, but failed to notify the external integration server. If you are using the default Sensay Telegram Integration, we will retry stopping the bot asynchronously.\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/integrations/telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "integrations", "telegram" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] } ] }, { "name": "conversations", "item": [ { "name": "{conversationUUID}", "item": [ { "name": "mentions", "item": [ { "name": "List mentions in a conversation", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/mentions?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a&minimumMessagesInPlaceholder=3", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "mentions" ], "query": [ { "key": "limit", "value": "10", "description": "The number of items to fetch. A group of messages is counted as 1 item and a placeholder is counted as 1 item." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only returns results after the given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only returns results before the given message UUID. Excludes given message UUID." }, { "key": "minimumMessagesInPlaceholder", "value": "3", "description": "The minimum number of messages to include in the placeholder. Placeholders with less than this number of messages will be expanded into messages." } ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" }, { "key": "conversationUUID", "value": "4e162bcb-2a32-4b35-89bf-7cf729a73687", "description": "The conversation unique identifier (UUID)" } ] }, "description": "Retrieves mentions of a replica in a specific conversation, together with context surrounding the mention. This endpoint supports cursor-based pagination. Returns most recent mentions first." }, "response": [ { "name": "List of messages/placeholders", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/mentions?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a&minimumMessagesInPlaceholder=3", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "mentions" ], "query": [ { "key": "limit", "value": "10", "description": "The number of items to fetch. A group of messages is counted as 1 item and a placeholder is counted as 1 item." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only returns results after the given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only returns results before the given message UUID. Excludes given message UUID." }, { "key": "minimumMessagesInPlaceholder", "value": "3", "description": "The minimum number of messages to include in the placeholder. Placeholders with less than this number of messages will be expanded into messages." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"items\": [\n {\n \"type\": \"mention\",\n \"messages\": [\n {\n \"uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"createdAt\": \"2024-09-24T09:09:55.66709+00:00\",\n \"content\": \"Hello world!\",\n \"role\": \"user\",\n \"source\": \"web\",\n \"replicaUUID\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"senderName\": \"John Doe\",\n \"senderProfileImageURL\": \"https://example.com/avatar.png\"\n },\n {\n \"uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"createdAt\": \"2024-09-24T09:09:55.66709+00:00\",\n \"content\": \"Hello world!\",\n \"role\": \"user\",\n \"source\": \"web\",\n \"replicaUUID\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"senderName\": \"John Doe\",\n \"senderProfileImageURL\": \"https://example.com/avatar.png\"\n }\n ]\n },\n {\n \"type\": \"mention\",\n \"messages\": [\n {\n \"uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"createdAt\": \"2024-09-24T09:09:55.66709+00:00\",\n \"content\": \"Hello world!\",\n \"role\": \"user\",\n \"source\": \"web\",\n \"replicaUUID\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"senderName\": \"John Doe\",\n \"senderProfileImageURL\": \"https://example.com/avatar.png\"\n },\n {\n \"uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"createdAt\": \"2024-09-24T09:09:55.66709+00:00\",\n \"content\": \"Hello world!\",\n \"role\": \"user\",\n \"source\": \"web\",\n \"replicaUUID\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"senderName\": \"John Doe\",\n \"senderProfileImageURL\": \"https://example.com/avatar.png\"\n }\n ]\n }\n ],\n \"hasMore\": true\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/mentions?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a&minimumMessagesInPlaceholder=3", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "mentions" ], "query": [ { "key": "limit", "value": "10", "description": "The number of items to fetch. A group of messages is counted as 1 item and a placeholder is counted as 1 item." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only returns results after the given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only returns results before the given message UUID. Excludes given message UUID." }, { "key": "minimumMessagesInPlaceholder", "value": "3", "description": "The minimum number of messages to include in the placeholder. Placeholders with less than this number of messages will be expanded into messages." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/mentions?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a&minimumMessagesInPlaceholder=3", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "mentions" ], "query": [ { "key": "limit", "value": "10", "description": "The number of items to fetch. A group of messages is counted as 1 item and a placeholder is counted as 1 item." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only returns results after the given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only returns results before the given message UUID. Excludes given message UUID." }, { "key": "minimumMessagesInPlaceholder", "value": "3", "description": "The minimum number of messages to include in the placeholder. Placeholders with less than this number of messages will be expanded into messages." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/mentions?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a&minimumMessagesInPlaceholder=3", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "mentions" ], "query": [ { "key": "limit", "value": "10", "description": "The number of items to fetch. A group of messages is counted as 1 item and a placeholder is counted as 1 item." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only returns results after the given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only returns results before the given message UUID. Excludes given message UUID." }, { "key": "minimumMessagesInPlaceholder", "value": "3", "description": "The minimum number of messages to include in the placeholder. Placeholders with less than this number of messages will be expanded into messages." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/mentions?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a&minimumMessagesInPlaceholder=3", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "mentions" ], "query": [ { "key": "limit", "value": "10", "description": "The number of items to fetch. A group of messages is counted as 1 item and a placeholder is counted as 1 item." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only returns results after the given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only returns results before the given message UUID. Excludes given message UUID." }, { "key": "minimumMessagesInPlaceholder", "value": "3", "description": "The minimum number of messages to include in the placeholder. Placeholders with less than this number of messages will be expanded into messages." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/mentions?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a&minimumMessagesInPlaceholder=3", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "mentions" ], "query": [ { "key": "limit", "value": "10", "description": "The number of items to fetch. A group of messages is counted as 1 item and a placeholder is counted as 1 item." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only returns results after the given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only returns results before the given message UUID. Excludes given message UUID." }, { "key": "minimumMessagesInPlaceholder", "value": "3", "description": "The minimum number of messages to include in the placeholder. Placeholders with less than this number of messages will be expanded into messages." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "messages", "item": [ { "name": "List messages in a conversation", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/messages?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "messages" ], "query": [ { "key": "limit", "value": "10", "description": "The number of messages to fetch." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only show messages after given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only show messages before given message UUID. Excludes given message UUID." } ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" }, { "key": "conversationUUID", "value": "4e162bcb-2a32-4b35-89bf-7cf729a73687", "description": "The conversation UUID." } ] }, "description": "Retrieves messages in a specific conversation with cursor-based pagination. Messages are sorted chronologically from oldest to newest.\n\nUse the `beforeUUID` parameter to get older messages and the `afterUUID` parameter to get newer messages. Please note:\n - When `beforeUUID` is specified, the most recent messages before `beforeUUID` are returned.\n - When `beforeUUID` and `afterUUID` are both specified, the most recent messages before `beforeUUID` are returned.\n - When `afterUUID` is specified on its own, the least recent messages after `afterUUID` are returned." }, "response": [ { "name": "List of messages in the conversation", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/messages?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "messages" ], "query": [ { "key": "limit", "value": "10", "description": "The number of messages to fetch." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only show messages after given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only show messages before given message UUID. Excludes given message UUID." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"items\": [\n {\n \"uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"createdAt\": \"2024-09-24T09:09:55.66709+00:00\",\n \"content\": \"Hello world!\",\n \"role\": \"user\",\n \"source\": \"web\",\n \"replicaUUID\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"senderName\": \"John Doe\",\n \"senderProfileImageURL\": \"https://example.com/avatar.png\"\n },\n {\n \"uuid\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"createdAt\": \"2024-09-24T09:09:55.66709+00:00\",\n \"content\": \"Hello world!\",\n \"role\": \"user\",\n \"source\": \"web\",\n \"replicaUUID\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"senderName\": \"John Doe\",\n \"senderProfileImageURL\": \"https://example.com/avatar.png\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/messages?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "messages" ], "query": [ { "key": "limit", "value": "10", "description": "The number of messages to fetch." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only show messages after given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only show messages before given message UUID. Excludes given message UUID." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/messages?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "messages" ], "query": [ { "key": "limit", "value": "10", "description": "The number of messages to fetch." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only show messages after given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only show messages before given message UUID. Excludes given message UUID." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/messages?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "messages" ], "query": [ { "key": "limit", "value": "10", "description": "The number of messages to fetch." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only show messages after given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only show messages before given message UUID. Excludes given message UUID." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/messages?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "messages" ], "query": [ { "key": "limit", "value": "10", "description": "The number of messages to fetch." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only show messages after given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only show messages before given message UUID. Excludes given message UUID." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID/messages?limit=10&afterUUID=40d353f3-1241-449e-9fa6-c798d62c9cb1&beforeUUID=ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID", "messages" ], "query": [ { "key": "limit", "value": "10", "description": "The number of messages to fetch." }, { "key": "afterUUID", "value": "40d353f3-1241-449e-9fa6-c798d62c9cb1", "description": "Only show messages after given message UUID. Excludes given message UUID." }, { "key": "beforeUUID", "value": "ec46b4db-3f0d-4392-b0f5-9fe327922e8a", "description": "Only show messages before given message UUID. Excludes given message UUID." } ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "Get conversation details", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" }, { "key": "conversationUUID", "value": "4e162bcb-2a32-4b35-89bf-7cf729a73687", "description": "The conversation UUID." } ] }, "description": "Retrieve details for a specific conversation within a replica." }, "response": [ { "name": "Conversation details", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID" ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"uuid\": \"8e9309af-baa4-4a85-8c59-c3a2a0c2ad0f\",\n \"chatUUID\": \"550e8400-e29b-41d4-a716-446655440001\",\n \"source\": \"telegram\",\n \"messageCount\": 42,\n \"replicaReplyCount\": 42,\n \"conversationType\": \"individual\",\n \"success\": true,\n \"firstMessageAt\": \"2025-05-27T15:02:44.499744+00:00\",\n \"lastMessageAt\": \"2025-05-27T15:02:44.499744+00:00\",\n \"lastReplicaReplyAt\": \"2025-05-27T15:02:44.499744+00:00\",\n \"conversationName\": \"John Doe\",\n \"conversationImageURL\": \"https://example.com/image.png\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID" ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID" ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID" ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID" ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations/:conversationUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations", ":conversationUUID" ], "variable": [ { "key": "replicaUUID" }, { "key": "conversationUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "List replica's conversations", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations?pageSize=24&page=2&sortBy=lastReplicaReplyAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations" ], "query": [ { "key": "pageSize", "value": "24", "description": "The number of items per page." }, { "key": "page", "value": "2", "description": "The page number." }, { "key": "sortBy", "value": "lastReplicaReplyAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "List of replica's conversations with pagination and sorting." }, "response": [ { "name": "List of conversations", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations?pageSize=24&page=2&sortBy=lastReplicaReplyAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations" ], "query": [ { "key": "pageSize", "value": "24", "description": "The number of items per page." }, { "key": "page", "value": "2", "description": "The page number." }, { "key": "sortBy", "value": "lastReplicaReplyAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"items\": [\n {\n \"uuid\": \"8e9309af-baa4-4a85-8c59-c3a2a0c2ad0f\",\n \"chatUUID\": \"550e8400-e29b-41d4-a716-446655440001\",\n \"source\": \"telegram\",\n \"messageCount\": 42,\n \"replicaReplyCount\": 42,\n \"conversationType\": \"individual\",\n \"firstMessageAt\": \"2025-05-27T15:02:44.499744+00:00\",\n \"lastMessageAt\": \"2025-05-27T15:02:44.499744+00:00\",\n \"lastReplicaReplyAt\": \"2025-05-27T15:02:44.499744+00:00\",\n \"conversationName\": \"John Doe\",\n \"conversationImageURL\": \"https://example.com/image.png\"\n },\n {\n \"uuid\": \"8e9309af-baa4-4a85-8c59-c3a2a0c2ad0f\",\n \"chatUUID\": \"550e8400-e29b-41d4-a716-446655440001\",\n \"source\": \"telegram\",\n \"messageCount\": 42,\n \"replicaReplyCount\": 42,\n \"conversationType\": \"individual\",\n \"firstMessageAt\": \"2025-05-27T15:02:44.499744+00:00\",\n \"lastMessageAt\": \"2025-05-27T15:02:44.499744+00:00\",\n \"lastReplicaReplyAt\": \"2025-05-27T15:02:44.499744+00:00\",\n \"conversationName\": \"John Doe\",\n \"conversationImageURL\": \"https://example.com/image.png\"\n }\n ],\n \"total\": 1001,\n \"success\": true\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations?pageSize=24&page=2&sortBy=lastReplicaReplyAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations" ], "query": [ { "key": "pageSize", "value": "24", "description": "The number of items per page." }, { "key": "page", "value": "2", "description": "The page number." }, { "key": "sortBy", "value": "lastReplicaReplyAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations?pageSize=24&page=2&sortBy=lastReplicaReplyAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations" ], "query": [ { "key": "pageSize", "value": "24", "description": "The number of items per page." }, { "key": "page", "value": "2", "description": "The page number." }, { "key": "sortBy", "value": "lastReplicaReplyAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations?pageSize=24&page=2&sortBy=lastReplicaReplyAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations" ], "query": [ { "key": "pageSize", "value": "24", "description": "The number of items per page." }, { "key": "page", "value": "2", "description": "The page number." }, { "key": "sortBy", "value": "lastReplicaReplyAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations?pageSize=24&page=2&sortBy=lastReplicaReplyAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations" ], "query": [ { "key": "pageSize", "value": "24", "description": "The number of items per page." }, { "key": "page", "value": "2", "description": "The page number." }, { "key": "sortBy", "value": "lastReplicaReplyAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/conversations?pageSize=24&page=2&sortBy=lastReplicaReplyAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "conversations" ], "query": [ { "key": "pageSize", "value": "24", "description": "The number of items per page." }, { "key": "page", "value": "2", "description": "The page number." }, { "key": "sortBy", "value": "lastReplicaReplyAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "analytics", "item": [ { "name": "conversations", "item": [ { "name": "historical", "item": [ { "name": "Get replica historical conversation analytics", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/historical", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "historical" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Returns cumulative conversation count for the last 30 days, up to and including today." }, "response": [ { "name": "Historical conversation analytics data", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/historical", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "historical" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"items\": [\n {\n \"date\": \"2025-05-01\",\n \"cumulativeConversations\": 100\n },\n {\n \"date\": \"2025-05-02\",\n \"cumulativeConversations\": 103\n },\n {\n \"date\": \"2025-05-03\",\n \"cumulativeConversations\": 108\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/historical", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "historical" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/historical", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "historical" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/historical", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "historical" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/historical", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "historical" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/historical", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "historical" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "sources", "item": [ { "name": "Get replica source analytics", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "sources" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Returns interaction counts by source for the replica." }, "response": [ { "name": "Source analytics data", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "sources" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"items\": [\n {\n \"source\": \"telegram\",\n \"conversations\": 245\n },\n {\n \"source\": \"discord\",\n \"conversations\": 123\n },\n {\n \"source\": \"web\",\n \"conversations\": 89\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "sources" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "sources" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "sources" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "sources" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/analytics/conversations/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "analytics", "conversations", "sources" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] } ] } ] }, { "name": "knowledge-base", "item": [ { "name": "{knowledgeBaseID}", "item": [ { "name": "Update knowledge base entry", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rawText\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"generatedFacts\": [\n \"The company was founded in 2020.\",\n \"We specialize in AI-powered customer service solutions.\"\n ],\n \"rawTextChunks\": [\n {\n \"content\": \"First part of the document content.\",\n \"chunkIndex\": 0,\n \"chunkTokens\": 7,\n \"chunkChars\": 35\n },\n {\n \"content\": \"Second part of the document content.\",\n \"chunkIndex\": 1,\n \"chunkTokens\": 7,\n \"chunkChars\": 36\n }\n ],\n \"title\": \"Company information\",\n \"generatedTitle\": \"Company information and Business Hours\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"language\": \"en\",\n \"website\": {\n \"url\": \"https://example.com\",\n \"links\": [\n \"string\",\n \"string\"\n ],\n \"title\": \"Example Website Title\",\n \"text\": \"This is the main text content extracted from the website.\",\n \"description\": \"This website provides information about our company and services.\",\n \"autoRefresh\": false,\n \"screenshotURL\": \"string\",\n \"screenshot\": \"string\"\n },\n \"youtube\": {\n \"url\": \"https://www.youtube.com/watch?v=VIDEO_ID\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"thumbnailURL\": \"https://i.ytimg.com/vi/VIDEO_ID/hqdefault.jpg\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"transcription\": \"This is the complete transcript of the video content...\",\n \"visualTranscription\": \"Visual elements and scenes described in text format\"\n },\n \"file\": {\n \"name\": \"company_handbook.pdf\",\n \"size\": 204800,\n \"mimeType\": \"application/epub+zip\",\n \"screenshot\": \"string\"\n },\n \"error\": {\n \"fingerprint\": \"12345\",\n \"message\": \"Failed to process the entry due to invalid format.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" }, { "key": "knowledgeBaseID", "value": "12345", "description": "The unique identifier of the knowledge base entry" } ] }, "description": "Updates a knowledge base entry with training content. This is the second step in the training process after creating an entry. You can provide \"rawText\" which is the content you want your replica to learn from (such as product information, company policies, or specialized knowledge). The system will automatically process this text and make it available for your replica to use when answering questions. The entry status will change to PROCESSING and then to READY once fully processed." }, "response": [ { "name": "Knowledge base entry updated successfully.", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"rawText\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"generatedFacts\": [\n \"The company was founded in 2020.\",\n \"We specialize in AI-powered customer service solutions.\"\n ],\n \"rawTextChunks\": [\n {\n \"content\": \"First part of the document content.\",\n \"chunkIndex\": 0,\n \"chunkTokens\": 7,\n \"chunkChars\": 35\n },\n {\n \"content\": \"Second part of the document content.\",\n \"chunkIndex\": 1,\n \"chunkTokens\": 7,\n \"chunkChars\": 36\n }\n ],\n \"title\": \"Company information\",\n \"generatedTitle\": \"Company information and Business Hours\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"language\": \"en\",\n \"website\": {\n \"url\": \"https://example.com\",\n \"links\": [\n \"string\",\n \"string\"\n ],\n \"title\": \"Example Website Title\",\n \"text\": \"This is the main text content extracted from the website.\",\n \"description\": \"This website provides information about our company and services.\",\n \"autoRefresh\": false,\n \"screenshotURL\": \"string\",\n \"screenshot\": \"string\"\n },\n \"youtube\": {\n \"url\": \"https://www.youtube.com/watch?v=VIDEO_ID\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"thumbnailURL\": \"https://i.ytimg.com/vi/VIDEO_ID/hqdefault.jpg\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"transcription\": \"This is the complete transcript of the video content...\",\n \"visualTranscription\": \"Visual elements and scenes described in text format\"\n },\n \"file\": {\n \"name\": \"company_handbook.pdf\",\n \"size\": 204800,\n \"mimeType\": \"application/epub+zip\",\n \"screenshot\": \"string\"\n },\n \"error\": {\n \"fingerprint\": \"12345\",\n \"message\": \"Failed to process the entry due to invalid format.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"rawText\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"generatedFacts\": [\n \"The company was founded in 2020.\",\n \"We specialize in AI-powered customer service solutions.\"\n ],\n \"rawTextChunks\": [\n {\n \"content\": \"First part of the document content.\",\n \"chunkIndex\": 0,\n \"chunkTokens\": 7,\n \"chunkChars\": 35\n },\n {\n \"content\": \"Second part of the document content.\",\n \"chunkIndex\": 1,\n \"chunkTokens\": 7,\n \"chunkChars\": 36\n }\n ],\n \"title\": \"Company information\",\n \"generatedTitle\": \"Company information and Business Hours\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"language\": \"en\",\n \"website\": {\n \"url\": \"https://example.com\",\n \"links\": [\n \"string\",\n \"string\"\n ],\n \"title\": \"Example Website Title\",\n \"text\": \"This is the main text content extracted from the website.\",\n \"description\": \"This website provides information about our company and services.\",\n \"autoRefresh\": false,\n \"screenshotURL\": \"string\",\n \"screenshot\": \"string\"\n },\n \"youtube\": {\n \"url\": \"https://www.youtube.com/watch?v=VIDEO_ID\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"thumbnailURL\": \"https://i.ytimg.com/vi/VIDEO_ID/hqdefault.jpg\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"transcription\": \"This is the complete transcript of the video content...\",\n \"visualTranscription\": \"Visual elements and scenes described in text format\"\n },\n \"file\": {\n \"name\": \"company_handbook.pdf\",\n \"size\": 204800,\n \"mimeType\": \"application/epub+zip\",\n \"screenshot\": \"string\"\n },\n \"error\": {\n \"fingerprint\": \"12345\",\n \"message\": \"Failed to process the entry due to invalid format.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"rawText\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"generatedFacts\": [\n \"The company was founded in 2020.\",\n \"We specialize in AI-powered customer service solutions.\"\n ],\n \"rawTextChunks\": [\n {\n \"content\": \"First part of the document content.\",\n \"chunkIndex\": 0,\n \"chunkTokens\": 7,\n \"chunkChars\": 35\n },\n {\n \"content\": \"Second part of the document content.\",\n \"chunkIndex\": 1,\n \"chunkTokens\": 7,\n \"chunkChars\": 36\n }\n ],\n \"title\": \"Company information\",\n \"generatedTitle\": \"Company information and Business Hours\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"language\": \"en\",\n \"website\": {\n \"url\": \"https://example.com\",\n \"links\": [\n \"string\",\n \"string\"\n ],\n \"title\": \"Example Website Title\",\n \"text\": \"This is the main text content extracted from the website.\",\n \"description\": \"This website provides information about our company and services.\",\n \"autoRefresh\": false,\n \"screenshotURL\": \"string\",\n \"screenshot\": \"string\"\n },\n \"youtube\": {\n \"url\": \"https://www.youtube.com/watch?v=VIDEO_ID\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"thumbnailURL\": \"https://i.ytimg.com/vi/VIDEO_ID/hqdefault.jpg\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"transcription\": \"This is the complete transcript of the video content...\",\n \"visualTranscription\": \"Visual elements and scenes described in text format\"\n },\n \"file\": {\n \"name\": \"company_handbook.pdf\",\n \"size\": 204800,\n \"mimeType\": \"application/epub+zip\",\n \"screenshot\": \"string\"\n },\n \"error\": {\n \"fingerprint\": \"12345\",\n \"message\": \"Failed to process the entry due to invalid format.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"rawText\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"generatedFacts\": [\n \"The company was founded in 2020.\",\n \"We specialize in AI-powered customer service solutions.\"\n ],\n \"rawTextChunks\": [\n {\n \"content\": \"First part of the document content.\",\n \"chunkIndex\": 0,\n \"chunkTokens\": 7,\n \"chunkChars\": 35\n },\n {\n \"content\": \"Second part of the document content.\",\n \"chunkIndex\": 1,\n \"chunkTokens\": 7,\n \"chunkChars\": 36\n }\n ],\n \"title\": \"Company information\",\n \"generatedTitle\": \"Company information and Business Hours\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"language\": \"en\",\n \"website\": {\n \"url\": \"https://example.com\",\n \"links\": [\n \"string\",\n \"string\"\n ],\n \"title\": \"Example Website Title\",\n \"text\": \"This is the main text content extracted from the website.\",\n \"description\": \"This website provides information about our company and services.\",\n \"autoRefresh\": false,\n \"screenshotURL\": \"string\",\n \"screenshot\": \"string\"\n },\n \"youtube\": {\n \"url\": \"https://www.youtube.com/watch?v=VIDEO_ID\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"thumbnailURL\": \"https://i.ytimg.com/vi/VIDEO_ID/hqdefault.jpg\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"transcription\": \"This is the complete transcript of the video content...\",\n \"visualTranscription\": \"Visual elements and scenes described in text format\"\n },\n \"file\": {\n \"name\": \"company_handbook.pdf\",\n \"size\": 204800,\n \"mimeType\": \"application/epub+zip\",\n \"screenshot\": \"string\"\n },\n \"error\": {\n \"fingerprint\": \"12345\",\n \"message\": \"Failed to process the entry due to invalid format.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"rawText\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"generatedFacts\": [\n \"The company was founded in 2020.\",\n \"We specialize in AI-powered customer service solutions.\"\n ],\n \"rawTextChunks\": [\n {\n \"content\": \"First part of the document content.\",\n \"chunkIndex\": 0,\n \"chunkTokens\": 7,\n \"chunkChars\": 35\n },\n {\n \"content\": \"Second part of the document content.\",\n \"chunkIndex\": 1,\n \"chunkTokens\": 7,\n \"chunkChars\": 36\n }\n ],\n \"title\": \"Company information\",\n \"generatedTitle\": \"Company information and Business Hours\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"language\": \"en\",\n \"website\": {\n \"url\": \"https://example.com\",\n \"links\": [\n \"string\",\n \"string\"\n ],\n \"title\": \"Example Website Title\",\n \"text\": \"This is the main text content extracted from the website.\",\n \"description\": \"This website provides information about our company and services.\",\n \"autoRefresh\": false,\n \"screenshotURL\": \"string\",\n \"screenshot\": \"string\"\n },\n \"youtube\": {\n \"url\": \"https://www.youtube.com/watch?v=VIDEO_ID\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"thumbnailURL\": \"https://i.ytimg.com/vi/VIDEO_ID/hqdefault.jpg\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"transcription\": \"This is the complete transcript of the video content...\",\n \"visualTranscription\": \"Visual elements and scenes described in text format\"\n },\n \"file\": {\n \"name\": \"company_handbook.pdf\",\n \"size\": 204800,\n \"mimeType\": \"application/epub+zip\",\n \"screenshot\": \"string\"\n },\n \"error\": {\n \"fingerprint\": \"12345\",\n \"message\": \"Failed to process the entry due to invalid format.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"rawText\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"generatedFacts\": [\n \"The company was founded in 2020.\",\n \"We specialize in AI-powered customer service solutions.\"\n ],\n \"rawTextChunks\": [\n {\n \"content\": \"First part of the document content.\",\n \"chunkIndex\": 0,\n \"chunkTokens\": 7,\n \"chunkChars\": 35\n },\n {\n \"content\": \"Second part of the document content.\",\n \"chunkIndex\": 1,\n \"chunkTokens\": 7,\n \"chunkChars\": 36\n }\n ],\n \"title\": \"Company information\",\n \"generatedTitle\": \"Company information and Business Hours\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"language\": \"en\",\n \"website\": {\n \"url\": \"https://example.com\",\n \"links\": [\n \"string\",\n \"string\"\n ],\n \"title\": \"Example Website Title\",\n \"text\": \"This is the main text content extracted from the website.\",\n \"description\": \"This website provides information about our company and services.\",\n \"autoRefresh\": false,\n \"screenshotURL\": \"string\",\n \"screenshot\": \"string\"\n },\n \"youtube\": {\n \"url\": \"https://www.youtube.com/watch?v=VIDEO_ID\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"thumbnailURL\": \"https://i.ytimg.com/vi/VIDEO_ID/hqdefault.jpg\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"transcription\": \"This is the complete transcript of the video content...\",\n \"visualTranscription\": \"Visual elements and scenes described in text format\"\n },\n \"file\": {\n \"name\": \"company_handbook.pdf\",\n \"size\": 204800,\n \"mimeType\": \"application/epub+zip\",\n \"screenshot\": \"string\"\n },\n \"error\": {\n \"fingerprint\": \"12345\",\n \"message\": \"Failed to process the entry due to invalid format.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] }, { "name": "Delete knowledge base entry by ID", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" }, { "key": "knowledgeBaseID", "value": "12345", "description": "The unique identifier of the knowledge base entry" } ] }, "description": "Permanently removes a specific knowledge base entry and its associated vector database entry. Use this endpoint when you need to remove outdated or incorrect training data from your replica's knowledge base. This operation cannot be undone, and the entry will no longer be available for retrieval during conversations with your replica. In most cases, the deletion is completed immediately. However, in some scenarios, part of the deletion process may be delayed. This means that while the request has been accepted and the deletion process has started, some associated data may remain temporarily available and will be removed within 24 hours." }, "response": [ { "name": "The knowledge base entry was deleted successfully.", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true\n}" }, { "name": "The deletion process has been initiated. Full removal of all associated data may take up to 24 hours to complete.", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"message\": \"The deletion process has been initiated. Full removal of all associated data may take up to 24 hours to complete.\"\n}" }, { "name": "Knowledge base entry not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" } ] }, { "name": "Get knowledge base entry by ID", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" }, { "key": "knowledgeBaseID", "value": "12345", "description": "The unique identifier of the knowledge base entry" } ] }, "description": "Retrieves detailed information about a specific knowledge base entry using its ID. This endpoint returns the complete entry data including its type, status, content, and metadata. You can use this to check the processing status of your training content, view the raw and processed text, and see when it was created and last updated. This is useful for monitoring the progress of your training data as it moves through the processing pipeline." }, "response": [ { "name": "The requested knowledge base entry.", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"type\": \"youtube\",\n \"status\": \"FILE_UPLOADED\",\n \"createdAt\": \"2025-04-15T08:11:00.093761+00:00\",\n \"updatedAt\": \"2025-04-15T08:15:05.299349+00:00\",\n \"success\": true,\n \"replicaUUID\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"url\": \"http://example.com\",\n \"title\": \"Company information\",\n \"generatedTitle\": \"Company information and business hours\",\n \"summary\": \"Basic company details including founding date, business focus, and operating hours.\",\n \"language\": \"en\",\n \"website\": {\n \"url\": \"https://example.com\",\n \"links\": [\n \"string\",\n \"string\"\n ],\n \"title\": \"Example Website Title\",\n \"text\": \"This is the main text content extracted from the website.\",\n \"description\": \"This website provides information about our company and services.\",\n \"autoRefresh\": false,\n \"screenshotURL\": \"string\"\n },\n \"youtube\": {\n \"url\": \"https://www.youtube.com/watch?v=VIDEO_ID\",\n \"title\": \"Example YouTube Video Title\",\n \"description\": \"This is a description of the YouTube video content.\",\n \"thumbnailURL\": \"https://i.ytimg.com/vi/VIDEO_ID/hqdefault.jpg\",\n \"summary\": \"A concise summary of the key points covered in the video.\",\n \"transcription\": \"This is the complete transcript of the video content...\",\n \"visualTranscription\": \"Visual elements and scenes described in text format\"\n },\n \"file\": {\n \"name\": \"company_handbook.pdf\",\n \"size\": 204800,\n \"mimeType\": \"application/epub+zip\",\n \"screenshotURL\": \"string\",\n \"downloadURL\": \"https://example.com/download/company_handbook.pdf?signed=...\"\n },\n \"error\": {\n \"fingerprint\": \"12345\",\n \"message\": \"Failed to process the entry due to invalid format.\"\n },\n \"rawText\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions. Our business hours are Monday to Friday, 9 AM to 5 PM Eastern Time.\",\n \"generatedFacts\": [\n \"The company was founded in 2020.\",\n \"We specialize in AI-powered customer service solutions.\"\n ],\n \"rawTextChunks\": [\n {\n \"content\": \"First part of the document content.\",\n \"chunkIndex\": 0,\n \"chunkTokens\": 7,\n \"chunkChars\": 35\n },\n {\n \"content\": \"Second part of the document content.\",\n \"chunkIndex\": 1,\n \"chunkTokens\": 7,\n \"chunkChars\": 36\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base/:knowledgeBaseID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base", ":knowledgeBaseID" ], "variable": [ { "key": "replicaUUID" }, { "key": "knowledgeBaseID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "Create a knowledge base entry", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Company information\",\n \"url\": \"https://example.com\",\n \"autoRefresh\": false,\n \"text\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"filename\": \"example.txt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Creates a new knowledge base entry for a replica based on text, file, URL, or Youtube Videos. For YouTube playlists, the system will automatically create separate entries for each video in the playlist." }, "response": [ { "name": "The created knowledge base entry", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Company information\",\n \"url\": \"https://example.com\",\n \"autoRefresh\": false,\n \"text\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"filename\": \"example.txt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"results\": []\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Company information\",\n \"url\": \"https://example.com\",\n \"autoRefresh\": false,\n \"text\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"filename\": \"example.txt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Company information\",\n \"url\": \"https://example.com\",\n \"autoRefresh\": false,\n \"text\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"filename\": \"example.txt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Company information\",\n \"url\": \"https://example.com\",\n \"autoRefresh\": false,\n \"text\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"filename\": \"example.txt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "URL already exists in the knowledge base", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Company information\",\n \"url\": \"https://example.com\",\n \"autoRefresh\": false,\n \"text\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"filename\": \"example.txt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Company information\",\n \"url\": \"https://example.com\",\n \"autoRefresh\": false,\n \"text\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"filename\": \"example.txt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Usage limit exceeded", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Company information\",\n \"url\": \"https://example.com\",\n \"autoRefresh\": false,\n \"text\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"filename\": \"example.txt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Company information\",\n \"url\": \"https://example.com\",\n \"autoRefresh\": false,\n \"text\": \"Our company was founded in 2020. We specialize in AI-powered customer service solutions.\",\n \"filename\": \"example.txt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] }, { "name": "List all knowledge base entries", "request": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base?status=VECTOR_CREATED&status=READY&type=website&type=youtube&search=Company Policies&hasError=false&page=2&pageSize=24&sortBy=createdAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "query": [ { "key": "status", "value": "VECTOR_CREATED", "description": "Filter knowledge base entries by comma separated list of their processing statuses. Use this to find entries in specific states like `NEW` or `READY`." }, { "key": "status", "value": "READY", "description": "Filter knowledge base entries by comma separated list of their processing statuses. Use this to find entries in specific states like `NEW` or `READY`." }, { "key": "type", "value": "website", "description": "Filter knowledge base entries by their content type. Use this to find specific types of training data like text or file uploads." }, { "key": "type", "value": "youtube", "description": "Filter knowledge base entries by their content type. Use this to find specific types of training data like text or file uploads." }, { "key": "search", "value": "Company Policies", "description": "Filter knowledge base entries by their title, filename, or URL." }, { "key": "hasError", "value": "false", "description": "Filter knowledge base entries that have encountered errors during processing." }, { "key": "page", "value": "2", "description": "Page number for pagination. Use this to navigate through large result sets." }, { "key": "pageSize", "value": "24", "description": "Maximum number of entries to return per page (up to 100). Use this to control result set size. A value of zero can be used to check the total number of items without returning any items." }, { "key": "sortBy", "value": "createdAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Returns a list of all knowledge base entries belonging to a replica. This endpoint allows you to view all your training data in one place, with optional filtering by status or type. You can use this to monitor the overall state of a replica's knowledge base, check which entries are still processing, and identify any that might have encountered errors. The response includes detailed information about each entry including its content, status, and metadata." }, "response": [ { "name": "List of knowledge base entries returned successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base?status=READY&type=youtube&search=Company Policies&hasError=false&page=2&pageSize=24&sortBy=createdAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "query": [ { "key": "status", "value": "READY", "description": "Filter knowledge base entries by comma separated list of their processing statuses. Use this to find entries in specific states like `NEW` or `READY`." }, { "key": "type", "value": "youtube", "description": "Filter knowledge base entries by their content type. Use this to find specific types of training data like text or file uploads." }, { "key": "search", "value": "Company Policies", "description": "Filter knowledge base entries by their title, filename, or URL." }, { "key": "hasError", "value": "false", "description": "Filter knowledge base entries that have encountered errors during processing." }, { "key": "page", "value": "2", "description": "Page number for pagination. Use this to navigate through large result sets." }, { "key": "pageSize", "value": "24", "description": "Maximum number of entries to return per page (up to 100). Use this to control result set size. A value of zero can be used to check the total number of items without returning any items." }, { "key": "sortBy", "value": "createdAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"items\": [\n {\n \"id\": 12345,\n \"replicaUUID\": \"03db5651-cb61-4bdf-9ef0-89561f7c9c53\",\n \"type\": \"text\",\n \"status\": \"READY\",\n \"createdAt\": \"2025-04-15T08:11:00.093761+00:00\",\n \"updatedAt\": \"2025-04-15T08:11:05.299349+00:00\",\n \"title\": \"Company information\",\n \"summary\": \"Basic company details and policies\"\n }\n ],\n \"total\": 100\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base?status=READY&type=youtube&search=Company Policies&hasError=false&page=2&pageSize=24&sortBy=createdAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "query": [ { "key": "status", "value": "READY", "description": "Filter knowledge base entries by comma separated list of their processing statuses. Use this to find entries in specific states like `NEW` or `READY`." }, { "key": "type", "value": "youtube", "description": "Filter knowledge base entries by their content type. Use this to find specific types of training data like text or file uploads." }, { "key": "search", "value": "Company Policies", "description": "Filter knowledge base entries by their title, filename, or URL." }, { "key": "hasError", "value": "false", "description": "Filter knowledge base entries that have encountered errors during processing." }, { "key": "page", "value": "2", "description": "Page number for pagination. Use this to navigate through large result sets." }, { "key": "pageSize", "value": "24", "description": "Maximum number of entries to return per page (up to 100). Use this to control result set size. A value of zero can be used to check the total number of items without returning any items." }, { "key": "sortBy", "value": "createdAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base?status=READY&type=youtube&search=Company Policies&hasError=false&page=2&pageSize=24&sortBy=createdAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "query": [ { "key": "status", "value": "READY", "description": "Filter knowledge base entries by comma separated list of their processing statuses. Use this to find entries in specific states like `NEW` or `READY`." }, { "key": "type", "value": "youtube", "description": "Filter knowledge base entries by their content type. Use this to find specific types of training data like text or file uploads." }, { "key": "search", "value": "Company Policies", "description": "Filter knowledge base entries by their title, filename, or URL." }, { "key": "hasError", "value": "false", "description": "Filter knowledge base entries that have encountered errors during processing." }, { "key": "page", "value": "2", "description": "Page number for pagination. Use this to navigate through large result sets." }, { "key": "pageSize", "value": "24", "description": "Maximum number of entries to return per page (up to 100). Use this to control result set size. A value of zero can be used to check the total number of items without returning any items." }, { "key": "sortBy", "value": "createdAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base?status=READY&type=youtube&search=Company Policies&hasError=false&page=2&pageSize=24&sortBy=createdAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "query": [ { "key": "status", "value": "READY", "description": "Filter knowledge base entries by comma separated list of their processing statuses. Use this to find entries in specific states like `NEW` or `READY`." }, { "key": "type", "value": "youtube", "description": "Filter knowledge base entries by their content type. Use this to find specific types of training data like text or file uploads." }, { "key": "search", "value": "Company Policies", "description": "Filter knowledge base entries by their title, filename, or URL." }, { "key": "hasError", "value": "false", "description": "Filter knowledge base entries that have encountered errors during processing." }, { "key": "page", "value": "2", "description": "Page number for pagination. Use this to navigate through large result sets." }, { "key": "pageSize", "value": "24", "description": "Maximum number of entries to return per page (up to 100). Use this to control result set size. A value of zero can be used to check the total number of items without returning any items." }, { "key": "sortBy", "value": "createdAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base?status=READY&type=youtube&search=Company Policies&hasError=false&page=2&pageSize=24&sortBy=createdAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "query": [ { "key": "status", "value": "READY", "description": "Filter knowledge base entries by comma separated list of their processing statuses. Use this to find entries in specific states like `NEW` or `READY`." }, { "key": "type", "value": "youtube", "description": "Filter knowledge base entries by their content type. Use this to find specific types of training data like text or file uploads." }, { "key": "search", "value": "Company Policies", "description": "Filter knowledge base entries by their title, filename, or URL." }, { "key": "hasError", "value": "false", "description": "Filter knowledge base entries that have encountered errors during processing." }, { "key": "page", "value": "2", "description": "Page number for pagination. Use this to navigate through large result sets." }, { "key": "pageSize", "value": "24", "description": "Maximum number of entries to return per page (up to 100). Use this to control result set size. A value of zero can be used to check the total number of items without returning any items." }, { "key": "sortBy", "value": "createdAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID/knowledge-base?status=READY&type=youtube&search=Company Policies&hasError=false&page=2&pageSize=24&sortBy=createdAt&sortOrder=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID", "knowledge-base" ], "query": [ { "key": "status", "value": "READY", "description": "Filter knowledge base entries by comma separated list of their processing statuses. Use this to find entries in specific states like `NEW` or `READY`." }, { "key": "type", "value": "youtube", "description": "Filter knowledge base entries by their content type. Use this to find specific types of training data like text or file uploads." }, { "key": "search", "value": "Company Policies", "description": "Filter knowledge base entries by their title, filename, or URL." }, { "key": "hasError", "value": "false", "description": "Filter knowledge base entries that have encountered errors during processing." }, { "key": "page", "value": "2", "description": "Page number for pagination. Use this to navigate through large result sets." }, { "key": "pageSize", "value": "24", "description": "Maximum number of entries to return per page (up to 100). Use this to control result set size. A value of zero can be used to check the total number of items without returning any items." }, { "key": "sortBy", "value": "createdAt", "description": "Sort criteria." }, { "key": "sortOrder", "value": "asc", "description": "The order of the sort." } ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "Get a replica", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Get an existing replica." }, "response": [ { "name": "The requested replica", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"uuid\": \"4830597b-f3be-42b4-9587-fa15299ccd63\",\n \"success\": true,\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true,\n \"distilledKnowledge\": \"This is the distilled knowledge of the replica.\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] }, { "name": "Delete a replica", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Deletes a replica by UUID." }, "response": [ { "name": "Replica has been deleted", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] }, { "name": "Updates a replica", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "Updates an existing replica." }, "response": [ { "name": "The request outcome", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas/:replicaUUID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas", ":replicaUUID" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "List replicas", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/replicas?owner_uuid=string&ownerID=string&page=9347&page_index=1&page_size=24&slug=string&search=string&tags=Blockchain&tags=meme&sort=name&integration=telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ], "query": [ { "key": "owner_uuid", "value": "string", "description": "Filters by the owner UUID of the Replicas" }, { "key": "ownerID", "value": "string", "description": "The replica owner ID." }, { "key": "page", "value": "9347", "description": "Pagination: The page number to return" }, { "key": "page_index", "value": "1", "description": "Pagination: The page index to return" }, { "key": "page_size", "value": "24", "description": "Pagination: The number of items per page" }, { "key": "slug", "value": "string", "description": "Filters by the replica's slug" }, { "key": "search", "value": "string", "description": "Search: by name of Replica, sorted in ascending order" }, { "key": "tags", "value": "Blockchain", "description": "Filters by tags associated to Replicas" }, { "key": "tags", "value": "meme", "description": "Filters by tags associated to Replicas" }, { "key": "sort", "value": "name", "description": "Sorts by name or popularity of Replicas in ascending order" }, { "key": "integration", "value": "telegram", "description": "Filters by integration" } ] }, "description": "List replicas with pagination with optional filtering. Only Replicas that are public or belong to the authenticated user are returned." }, "response": [ { "name": "List of Replicas", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas?owner_uuid=string&ownerID=string&page=9347&page_index=1&page_size=24&slug=string&search=string&tags=meme&sort=name&integration=telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ], "query": [ { "key": "owner_uuid", "value": "string", "description": "Filters by the owner UUID of the Replicas" }, { "key": "ownerID", "value": "string", "description": "The replica owner ID." }, { "key": "page", "value": "9347", "description": "Pagination: The page number to return" }, { "key": "page_index", "value": "1", "description": "Pagination: The page index to return" }, { "key": "page_size", "value": "24", "description": "Pagination: The number of items per page" }, { "key": "slug", "value": "string", "description": "Filters by the replica's slug" }, { "key": "search", "value": "string", "description": "Search: by name of Replica, sorted in ascending order" }, { "key": "tags", "value": "meme", "description": "Filters by tags associated to Replicas" }, { "key": "sort", "value": "name", "description": "Sorts by name or popularity of Replicas in ascending order" }, { "key": "integration", "value": "telegram", "description": "Filters by integration" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"type\": \"string\",\n \"items\": [\n {\n \"uuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"name\": \"Example Replica\",\n \"purpose\": \"Replica purpose\",\n \"slug\": \"copy\",\n \"profile_image\": \"https://deprecated.invalid/image.png\",\n \"profileImage\": \"https://domain.example/image.webp\",\n \"short_description\": \"An example replica\",\n \"shortDescription\": \"An example replica\",\n \"introduction\": \"deprecated\",\n \"greeting\": \"What would you like to know?\",\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"created_at\": \"2023-10-01T12:00:00Z\",\n \"owner_uuid\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"ownerID\": \"a-user-id\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"example@domain.example\"\n ],\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"answerToLife\"\n ]\n },\n \"voice_enabled\": true,\n \"video_enabled\": true,\n \"chat_history_count\": 5,\n \"system_message\": \"Descriptive, energetic, friendly\",\n \"telegram_integration\": {\n \"token\": \"7701101112:DASeKD32EQLL32113-ngfVUMkyzg\",\n \"service_name\": \"test_telegram_bot\"\n },\n \"discord_integration\": {\n \"token\": \"MTk4NjIyNDgzNDcxOTI1MjQ4.Cl2FMQ.ZnCjm1XVW7vRze4b7Cq4se7kKWs\",\n \"service_name\": \"test_discord_bot\",\n \"is_active\": true\n }\n }\n ],\n \"total\": 100\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas?owner_uuid=string&ownerID=string&page=9347&page_index=1&page_size=24&slug=string&search=string&tags=meme&sort=name&integration=telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ], "query": [ { "key": "owner_uuid", "value": "string", "description": "Filters by the owner UUID of the Replicas" }, { "key": "ownerID", "value": "string", "description": "The replica owner ID." }, { "key": "page", "value": "9347", "description": "Pagination: The page number to return" }, { "key": "page_index", "value": "1", "description": "Pagination: The page index to return" }, { "key": "page_size", "value": "24", "description": "Pagination: The number of items per page" }, { "key": "slug", "value": "string", "description": "Filters by the replica's slug" }, { "key": "search", "value": "string", "description": "Search: by name of Replica, sorted in ascending order" }, { "key": "tags", "value": "meme", "description": "Filters by tags associated to Replicas" }, { "key": "sort", "value": "name", "description": "Sorts by name or popularity of Replicas in ascending order" }, { "key": "integration", "value": "telegram", "description": "Filters by integration" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas?owner_uuid=string&ownerID=string&page=9347&page_index=1&page_size=24&slug=string&search=string&tags=meme&sort=name&integration=telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ], "query": [ { "key": "owner_uuid", "value": "string", "description": "Filters by the owner UUID of the Replicas" }, { "key": "ownerID", "value": "string", "description": "The replica owner ID." }, { "key": "page", "value": "9347", "description": "Pagination: The page number to return" }, { "key": "page_index", "value": "1", "description": "Pagination: The page index to return" }, { "key": "page_size", "value": "24", "description": "Pagination: The number of items per page" }, { "key": "slug", "value": "string", "description": "Filters by the replica's slug" }, { "key": "search", "value": "string", "description": "Search: by name of Replica, sorted in ascending order" }, { "key": "tags", "value": "meme", "description": "Filters by tags associated to Replicas" }, { "key": "sort", "value": "name", "description": "Sorts by name or popularity of Replicas in ascending order" }, { "key": "integration", "value": "telegram", "description": "Filters by integration" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas?owner_uuid=string&ownerID=string&page=9347&page_index=1&page_size=24&slug=string&search=string&tags=meme&sort=name&integration=telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ], "query": [ { "key": "owner_uuid", "value": "string", "description": "Filters by the owner UUID of the Replicas" }, { "key": "ownerID", "value": "string", "description": "The replica owner ID." }, { "key": "page", "value": "9347", "description": "Pagination: The page number to return" }, { "key": "page_index", "value": "1", "description": "Pagination: The page index to return" }, { "key": "page_size", "value": "24", "description": "Pagination: The number of items per page" }, { "key": "slug", "value": "string", "description": "Filters by the replica's slug" }, { "key": "search", "value": "string", "description": "Search: by name of Replica, sorted in ascending order" }, { "key": "tags", "value": "meme", "description": "Filters by tags associated to Replicas" }, { "key": "sort", "value": "name", "description": "Sorts by name or popularity of Replicas in ascending order" }, { "key": "integration", "value": "telegram", "description": "Filters by integration" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas?owner_uuid=string&ownerID=string&page=9347&page_index=1&page_size=24&slug=string&search=string&tags=meme&sort=name&integration=telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ], "query": [ { "key": "owner_uuid", "value": "string", "description": "Filters by the owner UUID of the Replicas" }, { "key": "ownerID", "value": "string", "description": "The replica owner ID." }, { "key": "page", "value": "9347", "description": "Pagination: The page number to return" }, { "key": "page_index", "value": "1", "description": "Pagination: The page index to return" }, { "key": "page_size", "value": "24", "description": "Pagination: The number of items per page" }, { "key": "slug", "value": "string", "description": "Filters by the replica's slug" }, { "key": "search", "value": "string", "description": "Search: by name of Replica, sorted in ascending order" }, { "key": "tags", "value": "meme", "description": "Filters by tags associated to Replicas" }, { "key": "sort", "value": "name", "description": "Sorts by name or popularity of Replicas in ascending order" }, { "key": "integration", "value": "telegram", "description": "Filters by integration" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/replicas?owner_uuid=string&ownerID=string&page=9347&page_index=1&page_size=24&slug=string&search=string&tags=meme&sort=name&integration=telegram", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ], "query": [ { "key": "owner_uuid", "value": "string", "description": "Filters by the owner UUID of the Replicas" }, { "key": "ownerID", "value": "string", "description": "The replica owner ID." }, { "key": "page", "value": "9347", "description": "Pagination: The page number to return" }, { "key": "page_index", "value": "1", "description": "Pagination: The page index to return" }, { "key": "page_size", "value": "24", "description": "Pagination: The number of items per page" }, { "key": "slug", "value": "string", "description": "Filters by the replica's slug" }, { "key": "search", "value": "string", "description": "Search: by name of Replica, sorted in ascending order" }, { "key": "tags", "value": "meme", "description": "Filters by tags associated to Replicas" }, { "key": "sort", "value": "name", "description": "Sorts by name or popularity of Replicas in ascending order" }, { "key": "integration", "value": "telegram", "description": "Filters by integration" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] }, { "name": "Create a replica", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ] }, "description": "Creates a new replica." }, "response": [ { "name": "The created replica", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"uuid\": \"654c2874-0b43-4d84-85fc-62ba866da1cb\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Smith\",\n \"shortDescription\": \"Accountant from Brooklyn who loves sports.\",\n \"greeting\": \"What would you like to know?\",\n \"ownerID\": \"a-user-id\",\n \"slug\": \"example-replica\",\n \"llm\": {\n \"model\": \"gpt-4o\",\n \"memoryMode\": \"rag-search\",\n \"systemMessage\": \"Concise, knowledgeable, empathetic and cheerful.\",\n \"tools\": [\n \"getTokenInfo\"\n ]\n },\n \"purpose\": \"Acts as my AI twin for answering questions about my creative work.\",\n \"type\": \"character\",\n \"private\": false,\n \"whitelistEmails\": [\n \"user@domain.example\"\n ],\n \"tags\": [\n \"male\",\n \"italian\"\n ],\n \"profileImage\": \"https://images.invalid/photo.jpeg\",\n \"suggestedQuestions\": [\n \"What is the meaning of life?\"\n ],\n \"voicePreviewText\": \"Hi, I'm your Sensay replica! How can I assist you today?\",\n \"isEveryConversationAccessibleBySupport\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/replicas", "host": [ "{{baseUrl}}" ], "path": [ "v1", "replicas" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "experimental", "item": [ { "name": "replicas", "item": [ { "name": "{replicaUUID}", "item": [ { "name": "chat", "item": [ { "name": "completions", "item": [ { "name": "Generate a completion (OpenAI-compatible, non-streaming)", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a helpful assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"How did you handle the immense pressure during the Civil War?\"\n }\n ],\n \"store\": true,\n \"source\": \"web\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/experimental/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "experimental", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "The replica unique identifier (UUID)" } ] }, "description": "\n > warn\n > Limited [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat/create) compatibility.\n > Supports basic chat completion with standard message roles and JSON responses.\n > Not supported: OpenAI-style streaming, tool calls, stop sequences, logprobs, and most request parameters.\n\n Creates a chat completion response from a list of messages comprising a conversation.\n " }, "response": [ { "name": "Chat completion response in OpenAI compatible format", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a helpful assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"How did you handle the immense pressure during the Civil War?\"\n }\n ],\n \"store\": true,\n \"source\": \"web\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/experimental/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "experimental", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"chatcmpl-abc123\",\n \"created\": 1677858242,\n \"object\": \"chat.completion\",\n \"model\": \"o1\",\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"During the Civil War, I faced tremendous pressure...\",\n \"tool_calls\": [\n {\n \"nullable\": true\n },\n {\n \"nullable\": true\n }\n ]\n },\n \"finish_reason\": \"stop\",\n \"logprobs\": {\n \"nullable\": true,\n \"description\": \"Log probabilities for token generation if requested.\"\n }\n },\n {\n \"index\": 0,\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"During the Civil War, I faced tremendous pressure...\",\n \"tool_calls\": [\n {\n \"nullable\": true\n },\n {\n \"nullable\": true\n }\n ]\n },\n \"finish_reason\": \"stop\",\n \"logprobs\": {\n \"nullable\": true,\n \"description\": \"Log probabilities for token generation if requested.\"\n }\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 56,\n \"completion_tokens\": 31,\n \"total_tokens\": 87\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a helpful assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"How did you handle the immense pressure during the Civil War?\"\n }\n ],\n \"store\": true,\n \"source\": \"web\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/experimental/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "experimental", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a helpful assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"How did you handle the immense pressure during the Civil War?\"\n }\n ],\n \"store\": true,\n \"source\": \"web\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/experimental/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "experimental", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a helpful assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"How did you handle the immense pressure during the Civil War?\"\n }\n ],\n \"store\": true,\n \"source\": \"web\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/experimental/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "experimental", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a helpful assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"How did you handle the immense pressure during the Civil War?\"\n }\n ],\n \"store\": true,\n \"source\": \"web\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/experimental/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "experimental", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a helpful assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"How did you handle the immense pressure during the Civil War?\"\n }\n ],\n \"store\": true,\n \"source\": \"web\",\n \"discord_data\": {\n \"channel_id\": \"string\",\n \"channel_name\": \"string\",\n \"author_id\": \"string\",\n \"author_name\": \"string\",\n \"message_id\": \"string\",\n \"created_at\": \"string\",\n \"server_id\": \"string\",\n \"server_name\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/experimental/replicas/:replicaUUID/chat/completions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "experimental", "replicas", ":replicaUUID", "chat", "completions" ], "variable": [ { "key": "replicaUUID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] } ] } ] } ] } ] }, { "name": "users", "item": [ { "name": "me", "item": [ { "name": "usage", "item": [ { "name": "Get usage metrics", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/me/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "usage" ] }, "description": "Returns usage metrics including total conversations and knowledge base entries across all replicas owned by the authenticated user." }, "response": [ { "name": "Usage metrics", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "usage" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"conversations\": {\n \"currentMonthTotal\": 3678,\n \"currentMonthByReplica\": {\n \"14e42ac9-369e-432c-97ab-7e7250a779b7\": 5,\n \"5ee26dc3-49d2-43a8-a45b-25a1c78382cd\": 12,\n \"9c0cf332-387e-4067-96e5-007c1f03e0d4\": 3\n }\n },\n \"knowledgeBaseEntries\": {\n \"total\": 67,\n \"byReplica\": {\n \"14e42ac9-369e-432c-97ab-7e7250a779b7\": 25,\n \"5ee26dc3-49d2-43a8-a45b-25a1c78382cd\": 32,\n \"9c0cf332-387e-4067-96e5-007c1f03e0d4\": 10\n }\n },\n \"success\": true\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "usage" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "usage" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "usage" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "usage" ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me", "usage" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "Get the current user", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] }, "description": "Returns information about the current user." }, "response": [ { "name": "User information", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"johndoe\",\n \"success\": true,\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}" } ] }, { "name": "Delete the current user", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] }, "description": "This endpoint permanently deletes the currently authenticated user account, including all associated data. After deletion, the account cannot be recovered." }, "response": [ { "name": "User deleted successfully", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": null }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] }, { "name": "Update the current user", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"johndoe\",\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] }, "description": "Update the currently logged in user." }, "response": [ { "name": "The updated User entity", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"johndoe\",\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"johndoe\",\n \"success\": true,\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"johndoe\",\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"johndoe\",\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"johndoe\",\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Linked account or email already exists or is invalid", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"johndoe\",\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"johndoe\",\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"johndoe\",\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "me" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] }, { "name": "{userID}", "item": [ { "name": "Get a user by ID", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userID" ], "variable": [ { "key": "userID", "value": "03db5651-cb61-4bdf-9ef0-89561f7c9c53", "description": "User ID" } ] }, "description": "Returns information about the user with the specified ID." }, "response": [ { "name": "User entity", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userID" ], "variable": [ { "key": "userID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"johndoe\",\n \"success\": true,\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}" }, { "name": "User not found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/users/:userID", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":userID" ], "variable": [ { "key": "userID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" } ] } ] }, { "name": "Create a user", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"id\": \"string\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ] }, "description": "Creates a new user." }, "response": [ { "name": "The created User entity", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"id\": \"string\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"johndoe\",\n \"success\": true,\n \"email\": \"user@example.com\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}" }, { "name": "User, email, or linked account already exists", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"id\": \"string\",\n \"linkedAccounts\": [\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n },\n {\n \"accountID\": \"string\",\n \"accountType\": \"discord\"\n }\n ],\n \"name\": \"John Doe\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" } ] } ] }, { "name": "knowledge-base", "item": [ { "name": "file-types", "item": [ { "name": "Get supported file types", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-ORGANIZATION-SECRET", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/knowledge-base/file-types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "knowledge-base", "file-types" ] }, "description": "Returns a list of all supported file types and MIME types for knowledge base entries. This endpoint provides information about which file formats can be uploaded to the knowledge base, organized by media type (documents, images, audio, video, etc.). Each file type includes the supported MIME types, file extensions, and support level (production or preview). This information can be used by client applications to validate file uploads and provide appropriate user interface elements." }, "response": [ { "name": "Supported file types returned successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/knowledge-base/file-types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "knowledge-base", "file-types" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": true,\n \"mediaGroups\": [\n {\n \"label\": \"PDF Documents\",\n \"mediaType\": \"document\",\n \"fileTypes\": [\n {\n \"mimeTypes\": [\n \"application/pdf\"\n ],\n \"extensions\": [\n \".pdf\",\n \".pdfa\"\n ],\n \"supportLevel\": \"production\"\n },\n {\n \"mimeTypes\": [\n \"application/pdf\"\n ],\n \"extensions\": [\n \".pdf\",\n \".pdfa\"\n ],\n \"supportLevel\": \"production\"\n }\n ],\n \"limitation\": \"Maximum duration: 90 minutes\"\n },\n {\n \"label\": \"PDF Documents\",\n \"mediaType\": \"document\",\n \"fileTypes\": [\n {\n \"mimeTypes\": [\n \"application/pdf\"\n ],\n \"extensions\": [\n \".pdf\",\n \".pdfa\"\n ],\n \"supportLevel\": \"production\"\n },\n {\n \"mimeTypes\": [\n \"application/pdf\"\n ],\n \"extensions\": [\n \".pdf\",\n \".pdfa\"\n ],\n \"supportLevel\": \"production\"\n }\n ],\n \"limitation\": \"Maximum duration: 90 minutes\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/knowledge-base/file-types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "knowledge-base", "file-types" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/knowledge-base/file-types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "knowledge-base", "file-types" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/knowledge-base/file-types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "knowledge-base", "file-types" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Unsupported Media Type", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/knowledge-base/file-types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "knowledge-base", "file-types" ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Version", "value": "2025-03-25" }, { "key": "Accept", "value": "application/json" }, { "key": "X-ORGANIZATION-SECRET", "value": "", "description": "Added as a part of security scheme: apikey" } ], "url": { "raw": "{{baseUrl}}/v1/knowledge-base/file-types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "knowledge-base", "file-types" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": false,\n \"error\": \"A text representation of the error\",\n \"fingerprint\": \"14fceadd84e74ec499afe9b0f7952d6b\",\n \"request_id\": \"xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab\",\n \"inner_exception\": {\n \"name\": \"Server overheated\",\n \"message\": \"The server overheated due to an unexpected situation\",\n \"cause\": \"Request too complicated\",\n \"stack\": \"Error: Server overheated due to an unexpected situation\\n at Object.eval (eval at ...\"\n }\n}" } ] } ] } ] } ] } ], "variable": [ { "key": "baseUrl", "value": "https://api.sensay.io" } ] }