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