Sign in
Replicas

List replicas

List replicas with pagination with optional filtering. Only Replicas that are public or belong to the authenticated user are returned.

get/v1/replicas

Request

  • Base URL: https://api.sensay.io
  • URL: https://api.sensay.io/v1/replicas
  • Auth: one of:
    • API key in header X-ORGANIZATION-SECRET and API key in header X-USER-ID and API key in header X-USER-ID-TYPE
    • API key in header X-ORGANIZATION-SECRET

Query parameters

owner_uuidstring

Filters by the owner UUID of the Replicas

ownerIDstring

The replica owner ID.

pageIndexinteger

Pagination: The page index to return

pageSizeinteger

Pagination: The number of items per page

pageinteger

Pagination: The page number to return (deprecated, use pageIndex instead)

page_indexinteger

Pagination: The page index to return (deprecated, use pageIndex instead)

page_sizeinteger

Pagination: The number of items per page (deprecated, use pageSize instead)

slugstring

Filters by the replica's slug

searchstring

Search: by name of Replica, sorted in ascending order

tagsstring[]

Filters by tags associated to Replicas

sort'name' | 'popularity'

Sorts by name or popularity of Replicas in ascending order

integration'telegram' | 'discord'

Filters by integration

Headers

X-API-Versionstring
Example:2025-03-25

Response

List of Replicas

successboolean required

Indicates the status of the request

typestring required
totalinteger required

The total number of replica items available across all pages

Example response

{
  "items": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Example Replica",
      "purpose": "Replica purpose",
      "slug": "copy",
      "profile_image": "https://deprecated.invalid/image.png",
      "profileImage": "https://domain.example/image.webp",
      "short_description": "An example replica",
      "shortDescription": "An example replica",
      "introduction": "deprecated",
      "greeting": "What would you like to know?",
      "tags": [
        "male",
        "italian"
      ],
      "created_at": "2023-10-01T12:00:00Z",
      "owner_uuid": "123e4567-e89b-12d3-a456-426614174001",
      "ownerID": "a-user-id",
      "type": "character",
      "private": false,
      "whitelistEmails": [
        "example@domain.example"
      ],
      "suggestedQuestions": [
        "What is the meaning of life?"
      ],
      "llm": {
        "model": "gpt-4o",
        "systemMessage": "Concise, knowledgeable, empathetic and cheerful.",
        "tools": [
          "answerToLife"
        ]
      },
      "voice_enabled": true,
      "video_enabled": true,
      "chat_history_count": 5,
      "system_message": "Descriptive, energetic, friendly",
      "telegram_integration": {
        "token": "7701101112:DASeKD32EQLL32113-ngfVUMkyzg",
        "service_name": "test_telegram_bot"
      },
      "discord_integration": {
        "token": "MTk4NjIyNDgzNDcxOTI1MjQ4.Cl2FMQ.ZnCjm1XVW7vRze4b7Cq4se7kKWs",
        "service_name": "test_discord_bot",
        "is_active": true
      }
    }
  ],
  "total": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.