Sensay API documentation

2 days ago

Change #51129857

2025-03-25

Compare

32 structure changes including:

32 Modifications

Modified 32

DELETE /v1/replicas/{replicaUUID}

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
404 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

DELETE /v1/replicas/{replicaUUID}/integrations/telegram

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

DELETE /v1/users/me

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/knowledge-base/file-types

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/analytics/conversations/historical

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
404 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/analytics/conversations/sources

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
404 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/chat/history

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/chat/history/discord

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/chat/history/embed

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/chat/history/telegram

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/chat/history/web

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/conversations

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
404 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/conversations/{conversationUUID}

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
404 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/conversations/{conversationUUID}/mentions

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
404 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/conversations/{conversationUUID}/messages

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
404 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/knowledge-base

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/users/me/usage

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

GET /v1/users/{userID}

Response
404 response Modified
- application/json content type Modified
  - error_code property Added

PATCH /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

POST /v1/api-keys/invites/{code}/redeem

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

POST /v1/experimental/replicas/{replicaUUID}/chat/completions

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

POST /v1/replicas

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
409 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added
429 response Modified
- application/json content type Modified
  - error_code property Added

POST /v1/replicas/{replicaUUID}/chat/completions

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

POST /v1/replicas/{replicaUUID}/chat/completions/telegram

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

POST /v1/replicas/{replicaUUID}/integrations/telegram

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

POST /v1/replicas/{replicaUUID}/knowledge-base

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
409 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added
429 response Modified
- application/json content type Modified
  - error_code property Added

POST /v1/users

Response
409 response Modified
- application/json content type Modified
  - error_code property Added

PUT /v1/replicas/{replicaUUID}

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
409 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

PUT /v1/users/me

Response
400 response Modified
- application/json content type Modified
  - error_code property Added
401 response Modified
- application/json content type Modified
  - error_code property Added
409 response Modified
- application/json content type Modified
  - error_code property Added
415 response Modified
- application/json content type Modified
  - error_code property Added

5 days ago

Change #f003062e

2025-03-25

Compare

4 structure changes including:

4 Modifications

Modified 4

GET /v1/replicas

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - llm property Modified

GET /v1/replicas/{replicaUUID}

Response
200 response Modified
- application/json content type Modified
  - llm property Modified
    - model property Modified

POST /v1/replicas

Body
application/json content type Modified
- llm property Modified
  - model property Modified
    - claude-3-5-haiku-latest alternative Added

PUT /v1/replicas/{replicaUUID}

Body
application/json content type Modified
- llm property Modified
  - model property Modified
    - claude-3-5-haiku-latest alternative Added

5 days ago

Change #b13f165d

2025-03-25

Compare

4 structure changes including:

4 Modifications

Modified 4

GET /v1/replicas

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - llm property Modified

GET /v1/replicas/{replicaUUID}

Response
200 response Modified
- application/json content type Modified
  - llm property Modified
    - model property Modified

POST /v1/replicas

Body
application/json content type Modified
- llm property Modified
  - model property Modified
    - claude-4-sonnet-20250514 alternative Added

PUT /v1/replicas/{replicaUUID}

Body
application/json content type Modified
- llm property Modified
  - model property Modified
    - claude-4-sonnet-20250514 alternative Added

6 days ago

Change #63596566

2025-03-25

Compare

4 structure changes including:

4 Modifications

Modified 4

GET /v1/replicas

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - llm property Modified

GET /v1/replicas/{replicaUUID}

Response
200 response Modified
- application/json content type Modified
  - llm property Modified
    - embeddingModel property Added

POST /v1/replicas

Body
application/json content type Modified
- llm property Modified
  - embeddingModel property Added

PUT /v1/replicas/{replicaUUID}

Body
application/json content type Modified
- llm property Modified
  - embeddingModel property Added

9 days ago

Change #aaf450b9

2025-03-25

Breaking

Compare

1 structure change including:

1 Breaking change

1 Removal

Removed 1 Breaking

GET /v1/replicas/models

Removing a resource is always breaking unless it was deprecated before
Breaking

13 days ago

Change #9005a2de

2025-03-25

Breaking

Compare

1 structure change including:

1 Modification

Modified 1 Breaking

GET /v1/replicas/models

Response
200 response Modified
- application/json content type Modified
  - models property Modified
    - Type went from array[object] to object
      Breaking
    - asi1-mini, claude-3-5-haiku-latest, claude-3-7-sonnet-latest, claude-4-sonnet-20250514, claude-sonnet-4-5, deepseek-chat, gemini-2.5-flash, gemini-2.5-pro, gpt-4o, gpt-4o-mini, gpt-5, gpt-5-mini, gpt-5-nano, grok-2-latest, grok-3-beta, grok-3-latest, grok-4-latest, o3-mini, targon-gpt-oss-120b properties Added

14 days ago

Change #f64df6f9

2025-03-25

Compare

6 structure changes including:

6 Removals

Removed 6

DELETE /v1/training/{trainingID}

GET /v1/replicas/{replicaUUID}/training/files/upload

GET /v1/training

GET /v1/training/{trainingID}

POST /v1/replicas/{replicaUUID}/training

PUT /v1/replicas/{replicaUUID}/training/{trainingID}

15 days ago

Change #81611407

2025-03-25

Compare

1 structure change including:

1 Modification

Modified 1

POST /v1/replicas/{replicaUUID}/knowledge-base

Response
429 response Added

19 days ago

Change #7ac7dd22

2025-03-25

Compare

1 structure change including:

1 Addition

Added 1

GET /v1/replicas/models

20 days ago

Change #bd47c154

2025-03-25

Compare

1 structure change including:

1 Modification

Modified 1

POST /v1/replicas

Response
429 response Added

22 days ago

Change #6018b81d

2025-03-25

Compare

2 structure changes including:

2 Modifications

Modified 2

DELETE /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}

Path
knowledgeBaseID path parameter Modified
- Type is now number

GET /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}

Path
knowledgeBaseID path parameter Modified
- Type is now number

29 days ago

Change #1c00c145

2025-03-25

Compare

1 structure change including:

1 Addition

Added 1

GET /v1/users/me/usage

29 days ago

Change #0800255f

2025-03-25

Breaking

Compare

3 structure changes including:

3 Modifications

Modified 3 Breaking

DELETE /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}

Path
knowledgeBaseID path parameter Modified
- Type is no longer number
  Breaking

GET /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}

Path
knowledgeBaseID path parameter Modified
- Path parameter is now required
  Breaking
- Type is no longer number
  Breaking

PATCH /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}

Path
knowledgeBaseID path parameter Modified
- Path parameter is no longer required

Sep 10, 2025

Change #45b51d46

2025-03-25

Breaking

Compare

2 structure changes including:

2 Modifications

Modified 2 Breaking

GET /v1/replicas/{replicaUUID}/conversations

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - conversationType property Modified
      - Property is now required
        Breaking

GET /v1/replicas/{replicaUUID}/conversations/{conversationUUID}

Response
200 response Modified
- application/json content type Modified
  - conversationType property Modified
    - Property is now required
      Breaking

Sep 10, 2025

Change #59f750b3

2025-03-25

Compare

8 structure changes including:

1 Addition

7 Modifications

Modified 7

DELETE /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}

Operation is no longer beta

GET /v1/replicas/{replicaUUID}/analytics/conversations/historical

Operation is no longer beta

GET /v1/replicas/{replicaUUID}/analytics/conversations/sources

Operation is no longer beta

GET /v1/replicas/{replicaUUID}/knowledge-base

Operation is no longer beta

GET /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}

Operation is no longer beta

PATCH /v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}

Operation is no longer beta

POST /v1/replicas/{replicaUUID}/knowledge-base

Operation is no longer beta

Added 1

GET /v1/knowledge-base/file-types

Sep 10, 2025

Change #5b0e3c8b

2025-03-25

Breaking

Compare

6 structure changes including:

6 Modifications

Modified 6 Breaking

GET /v1/replicas

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - isAccessibleByCustomerSupport, isPrivateConversationsEnabled, elevenLabsID, elevenLabsCustomID, heygenAvatarID, voiceManager properties Removed
    - introductionAudioID property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /v1/replicas/{replicaUUID}

Response
200 response Modified
- application/json content type Modified
  - isAccessibleByCustomerSupport, isPrivateConversationsEnabled, elevenLabsID, elevenLabsCustomID, heygenAvatarID, voiceManager properties Removed
  - introductionAudioID property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

GET /v1/replicas/{replicaUUID}/conversations

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - conversationType property Modified
      - Property is no longer required
    - summary, commonQuestions, commonTopics properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

GET /v1/replicas/{replicaUUID}/conversations/{conversationUUID}

Response
200 response Modified
- application/json content type Modified
  - conversationType property Modified
    - Property is no longer required
  - summary, commonQuestions, commonTopics properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

POST /v1/replicas

Body
application/json content type Modified
- isAccessibleByCustomerSupport, isPrivateConversationsEnabled properties Removed
- introductionAudioID property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking

PUT /v1/replicas/{replicaUUID}

Body
application/json content type Modified
- isAccessibleByCustomerSupport, isPrivateConversationsEnabled properties Removed
- introductionAudioID property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking

Sep 10, 2025

Change #2101a0f8

2025-03-25

Breaking

Compare

4 structure changes including:

4 Modifications

Modified 4 Breaking

GET /v1/replicas

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - llm property Modified

GET /v1/replicas/{replicaUUID}

Response
200 response Modified
- application/json content type Modified
  - llm property Modified
    - maxTokens property Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking

POST /v1/replicas

Body
application/json content type Modified
- llm property Modified
  - maxTokens property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

PUT /v1/replicas/{replicaUUID}

Body
application/json content type Modified
- llm property Modified
  - maxTokens property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

Sep 10, 2025

Change #a78df76e

2025-03-25

Compare

2 structure changes including:

2 Modifications

Modified 2

GET /v1/replicas/{replicaUUID}/conversations

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - chatUUID property Added

GET /v1/replicas/{replicaUUID}/conversations/{conversationUUID}

Response
200 response Modified
- application/json content type Modified
  - chatUUID property Added

Sep 10, 2025

Change #03a987c9

2025-03-25

Compare

7 structure changes including:

7 Modifications

Modified 7

GET /v1/replicas/{replicaUUID}

Response
200 response Modified
- application/json content type Modified
  - success property Added

GET /v1/replicas/{replicaUUID}/conversations

Response
200 response Modified
- application/json content type Modified
  - success property Added

GET /v1/replicas/{replicaUUID}/conversations/{conversationUUID}

Response
200 response Modified
- application/json content type Modified
  - success property Added

GET /v1/users/me

Response
200 response Modified
- application/json content type Modified
  - success property Added

GET /v1/users/{userID}

Response
200 response Modified
- application/json content type Modified
  - success property Added

POST /v1/users

Response
200 response Modified
- application/json content type Modified
  - success property Added

PUT /v1/users/me

Response
200 response Modified
- application/json content type Modified
  - success property Added

Sep 9, 2025

Change #4cbc585e

2025-03-25

Compare

4 structure changes including:

4 Modifications

Modified 4

GET /v1/replicas

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - llm property Modified

GET /v1/replicas/{replicaUUID}

Response
200 response Modified
- application/json content type Modified
  - llm property Modified
    - maxTokens property Added

POST /v1/replicas

Body
application/json content type Modified
- llm property Modified
  - maxTokens property Added

PUT /v1/replicas/{replicaUUID}

Body
application/json content type Modified
- llm property Modified
  - maxTokens property Added

Do not miss any Sensay API changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed