Change Updates

Do not miss any Sensay API changes, ever again

Subscribe to the Sensay API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
1 structure change including:
1 Modification
Modified 1
GET /v1/replicas
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • discord_integration, telegram_integration properties Added
  • Query
  • integration query parameter Added
2 structure changes including:
2 Modifications
Modified 2
GET /v1/training
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • title, description properties Added
GET /v1/training/{trainingID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • title, description properties Added
3 structure changes including:
3 Additions
Added 3
GET /v1/training
GET /v1/training/{trainingID}
PUT /v1/replicas/{replicaUUID}/training/{trainingID}
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /v1/replicas/{replicaUUID}/chat/history
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • images property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/replicas/{replicaUUID}/chat/history/discord
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • images property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/replicas/{replicaUUID}/chat/history/embed
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • images property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/replicas/{replicaUUID}/chat/history/telegram
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • images property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/replicas/{replicaUUID}/chat/history/web
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • images property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
1 structure change including:
1 Addition
Added 1
DELETE /v1/replicas/{replicaUUID}/integrations/telegram
2025-03-25
5 structure changes including:
1 Addition
4 Modifications
Modified 4 Breaking
DELETE /v1/users/me
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
  • Authentication
  • Sensay jwt authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /v1/users/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • success, type, uuid properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • name, id, linkedAccounts properties Added
  • 400, 401, 404, 415, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Authentication
  • Sensay jwt authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /v1/users
  • Body
  • application/json content type Modified
    • IDs property Removed
    • name, id, linkedAccounts properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • success, type, uuid properties Removed
      • name, email, id, linkedAccounts properties Added
  • 400, 401, 404, 415, 500 responses Removed
PUT /v1/users/me
  • Operation is no longer beta
  • Body
  • application/json content type Modified
    • IDs property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • name, id, linkedAccounts properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • success, type, uuid properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • name, id, linkedAccounts properties Added
  • Authentication
  • Sensay jwt authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Added 1
GET /v1/users/{ID}
9 structure changes including:
4 Breaking changes
1 Modification
8 Removals
Modified 1
GET /v1/replicas/{replicaUUID}/training/files/upload
  • Operation is now beta
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signedURL property Modified
        • Name went from signedUrl to signedURL
      • filePath, message properties Removed
Removed 8 Breaking
GET /v1/replicas/{replicaUUID}/training/{knowledgeBaseID}
GET /v1/training/list
GET /v1/training/{knowledgeBaseID}
POST /v1/replicas/training/files/webhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/replicas/{replicaUUID}/chat/completions/test
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/replicas/{replicaUUID}/generate-system-prompt
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/replicas/{replicaUUID}/training/question-answer
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /v1/replicas/{replicaUUID}/training/{knowledgeBaseID}
1 structure change including:
1 Addition
Added 1
POST /v1/replicas/{replicaUUID}/integrations/telegram
1 structure change including:
1 Modification
Modified 1
POST /v1/replicas/{replicaUUID}/chat/completions/test
  • Response
  • 200 response Modified
    • application/json content type Modified
      • queries, matches properties Added
13 structure changes including:
2 Breaking changes
9 Additions
2 Modifications
2 Removals
Modified 2 Breaking
GET /v1/replicas/{replicaUUID}/training/files/upload
  • Query
  • filename query parameter Modified
    • Name went from fileName to filename
      Breaking
PUT /v1/replicas/{replicaUUID}/training/{knowledgeBaseID}
  • Body
  • application/json content type Modified
    • metadata property Added
Removed 2 Breaking
GET /v1/replicas/{replicaUUID}/chat/history/{source}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/replicas/{replicaUUID}/chat/history/{source}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 9
GET /v1/replicas/{replicaUUID}/chat/history/discord
GET /v1/replicas/{replicaUUID}/chat/history/embed
GET /v1/replicas/{replicaUUID}/chat/history/telegram
GET /v1/replicas/{replicaUUID}/chat/history/web
POST /v1/replicas/{replicaUUID}/chat/completions/telegram
POST /v1/replicas/{replicaUUID}/chat/completions/test
POST /v1/replicas/{replicaUUID}/chat/history
POST /v1/replicas/{replicaUUID}/chat/history/telegram
POST /v1/replicas/{replicaUUID}/training/question-answer
1 structure change including:
1 Addition
Added 1
POST /v1/experimental/replicas/{replicaUUID}/chat/completions
2025-02-01
8 structure changes including:
8 Modifications
Modified 8
DELETE /v1/users/me
  • Header
  • X-API-Version header Added
GET /v1/replicas
  • Header
  • X-API-Version header Added
GET /v1/replicas/{replicaUUID}/chat/history
  • Header
  • X-API-Version header Added
GET /v1/users/me
  • Header
  • X-API-Version header Added
POST /v1/replicas/{replicaUUID}/chat/completions
  • Header
  • X-API-Version header Added
POST /v1/replicas/{replicaUUID}/chat/history/{source}
  • Header
  • X-API-Version header Added
POST /v1/users
  • Header
  • X-API-Version header Added
PUT /v1/users/me
  • Header
  • X-API-Version header Added
2 structure changes including:
2 Additions
Added 2
GET /v1/replicas/{replicaUUID}/training/files/upload
POST /v1/replicas/training/files/webhook
3 structure changes including:
2 Additions
1 Modification
Modified 1 Breaking
POST /v1/replicas/{replicaUUID}/generate-system-prompt
  • Path went from /v1/replicas/{id}/generate-system-prompt to /v1/replicas/{replicaUUID}/generate-system-prompt (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • replicaUUID path parameter Added
  • Authentication
  • Sensay jwt, Organization service token & User & User id type authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Added 2
GET /v1/training/list
GET /v1/training/{knowledgeBaseID}
5 structure changes including:
3 Additions
2 Removals
Removed 2
GET /v1/replicas/{replicaUUID}/training/files/{trainingID}
PUT /v1/replicas/{replicaUUID}/training/files/{trainingID}
Added 3
GET /v1/replicas/{replicaUUID}/training/{knowledgeBaseID}
POST /v1/replicas/{id}/generate-system-prompt
PUT /v1/replicas/{replicaUUID}/training/{knowledgeBaseID}
1 structure change including:
1 Addition
Added 1
GET /v1/replicas/{replicaUUID}/training/files/{trainingID}
1 structure change including:
1 Modification
Modified 1
PUT /v1/replicas/{replicaUUID}/training/files/{trainingID}
  • Operation is now beta
  • Path went from /v1/replicas/{replicaUUID}/training/files/{trainingId} to /v1/replicas/{replicaUUID}/training/files/{trainingID} (same operationId)
  • Body
  • application/json content type Modified
    • raw_text property Modified
      • Property is no longer required
    • optimized_text property Added
  • Path
  • trainingID path parameter Modified
    • Name went from trainingId to trainingID
1 structure change including:
1 Modification
Modified 1
GET /v1/replicas
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • system_message property Added
2 structure changes including:
1 Addition
1 Modification
Modified 1 Breaking
POST /v1/replicas/{replicaUUID}/chat/history/{source}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type, items properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Added 1
PUT /v1/replicas/{replicaUUID}/training/files/{trainingId}
2 structure changes including:
1 Addition
1 Modification
Modified 1
POST /v1/replicas/{replicaUUID}/chat/completions
  • Body
  • application/json content type Modified
    • discord_data property Added
Added 1
POST /v1/replicas/{replicaUUID}/chat/history/{source}