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

Jun 16, 2025

main
2025-03-25
Compare

API structure has changed

30 structure changes including:
6 Breaking changes
22 Modifications
8 Removals
Modified 22 Breaking
DELETE /v1/replicas/{replicaUUID}/integrations/telegram
  • Path
  • replicaUUID path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 202 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
DELETE /v1/users/me
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Organization service token & User & User id type authentication method Added
GET /v1/replicas
  • Query
  • page_index query parameter Modified
    • Query parameter is no longer deprecated
  • tags query parameter Modified
    • Type went from array[string] to array[string] | string
  • ownerID, page, slug, integration query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • Property is no longer required
        • uuid property Modified
          • Type went from string(uuid) to string | null
        • name, slug properties Modified
          • Type went from string to string | null
        • profile_image, short_description, introduction, owner_uuid, system_message properties Modified
          • Properties are no longer deprecated
        • tags property Modified
          • Property is now required
            Breaking
          • Type went from array[string] to array[string] | null
        • voice_enabled, video_enabled properties Modified
          • Properties are no longer beta
        • purpose, shortDescription, greeting, type, ownerID, private, whitelistEmails, profileImage, suggestedQuestions, llm, voicePreviewText properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • discord_integration, telegram_integration, elevenLabsID properties Removed
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
GET /v1/replicas/{replicaUUID}/chat/history
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • original_message_id property Removed
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
GET /v1/replicas/{replicaUUID}/chat/history/discord
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • original_message_id property Removed
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
GET /v1/replicas/{replicaUUID}/chat/history/embed
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • original_message_id property Removed
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
GET /v1/replicas/{replicaUUID}/chat/history/telegram
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • original_message_id property Removed
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
GET /v1/replicas/{replicaUUID}/chat/history/web
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • original_message_id property Removed
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
GET /v1/replicas/{replicaUUID}/training/files/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • knowledgeBaseID property Removed
GET /v1/training
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • url property Removed
  • Header
  • X-API-Version header Removed
GET /v1/training/{trainingID}
  • Path
  • trainingID path parameter Modified
    • Type went from number | null to number
  • Response
  • 200 response Modified
    • application/json content type Modified
      • url property Removed
  • Header
  • X-API-Version header Removed
GET /v1/users/me
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Organization service token & User & User id type authentication method Added
GET /v1/users/{ID}
  • Path went from /v1/users/{userID} to /v1/users/{ID} (same operationId)
  • Path
  • userID path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • ID path parameter Added
POST /v1/experimental/replicas/{replicaUUID}/chat/completions
  • Body
  • application/json content type Modified
    • discord_data property Modified
      • created_at, server_id, server_name properties Removed
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Organization service token & User & User id type authentication method Added
POST /v1/replicas/{replicaUUID}/chat/completions
  • Body
  • application/json content type Modified
    • discord_data property Modified
      • created_at, server_id, server_name properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
POST /v1/replicas/{replicaUUID}/chat/completions/telegram
  • Body
  • application/json content type Modified
    • telegram_data property Modified
      • chat_id, message_id properties Modified
        • Type went from number to string
          Breaking
      • user_id, message_thread_id properties Modified
        • Properties are now required
          Breaking
        • Type went from number to string
          Breaking
      • username property Modified
        • Property is now required
          Breaking
    • imageURL property Removed
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
  • Path
  • source path parameter Added
POST /v1/replicas/{replicaUUID}/chat/history
  • Body
  • application/json content type Modified
    • discord_data property Modified
      • created_at, server_id, server_name properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
POST /v1/replicas/{replicaUUID}/chat/history/telegram
  • Body
  • application/json content type Modified
    • telegram_data property Modified
      • chat_id, message_id properties Modified
        • Type went from number to string
          Breaking
      • user_id, message_thread_id properties Modified
        • Properties are now required
          Breaking
        • Type went from number to string
          Breaking
      • username property Modified
        • Property is now required
          Breaking
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
POST /v1/replicas/{replicaUUID}/integrations/telegram
  • Path
  • replicaUUID path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 202 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Sensay jwt, Organization service token & User & User id type authentication methods Added
POST /v1/users
  • Operation is now beta
PUT /v1/replicas/{replicaUUID}/training/{trainingID}
  • Path
  • trainingID path parameter Modified
    • Path parameter is no longer required
  • Response
  • 404 response Modified
    • application/json content type Modified
      • error, request_id properties Removed
      • message property Added
PUT /v1/users/me
  • Authentication
  • Organization service token & User authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Organization service token & User & User id type authentication method Added
Removed 8 Breaking
DELETE /v1/replicas/{replicaUUID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /v1/training/{trainingID}
GET /v1/replicas/{replicaUUID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/replicas/{replicaUUID}/conversations/{conversationUUID}/messages
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/api-keys/invites/{code}/redeem
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/replicas
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/replicas/{replicaUUID}/training
PUT /v1/replicas/{replicaUUID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking