Headers

• X-API-Version string

  Default value is 2025-03-25.

Query parameters

• owner_uuid string

  Filters by the owner UUID of the Replicas

• page_index integer

  Pagination: The page index to return

  Default value is 1.

• page_size integer

  Pagination: The number of items per page

  Default value is 24.

• slug string

  Filters by the replica's slug

• search string

  Search: by name of Replica, sorted in ascending order

• tags array[string]

  Filters by tags associated to Replicas

  Values are AI, Academic, Arts, Blockchain, Business, Celebrity, Charity, Developer, Educator, Europe, Fashion, Finance, Food, Health & Fitness, History, Italian, Kids, Language, Law, Leadership, Lifestyle, Literature, Love, Military, Modelling, Motivation, Movies, Music, North America, Philosophy, Politics, Religion, Science, Self-Help, Sensay, Sports, Technology, Web, Wisdom, blockchain, engage2earn, female, investment, male, meme, miniapp, telegram, or web3.

• sort string

  Sorts by name or popularity of Replicas in ascending order

  Values are name or popularity. Default value is name.

• integration string

  Filters by integration

  Values are telegram or discord.

Responses

• 200 application/json

  List of Replicas

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • type string Required
  • items array[object] Required

    Array of replica items for the current page. Will be an empty array if no items exist.

    Hide items attributes Show items attributes object

    • uuid string | null Required

      The UUID of the Replica

    • name string | null Required

      The Name of the Replica

    • slug string | null Required

      The Slug of the Replica

    • profile_image string | null Required

      The URL of the profile image of the Replica

    • short_description string | null Required

      The description of the Replica

    • introduction string | null Required

      The introduction of the Replica

    • tags array[string] | null Required

      The Tags associated to the Replica

    • created_at string | null Required

      The date and time the Replica was created

    • owner_uuid string | null Required

      The UUID of the owner of the Replica

    • voice_enabled boolean Required

      Does replica have voice support

    • video_enabled boolean Required

      Does replica have video support

    • chat_history_count integer | null Required

      The number of completions of the Replica

    • system_message string Required

      The replica's tone, personality and behaviour

    • discord_integration object | null Required

      The Discord integration of the Replica

      Hide discord_integration attributes Show discord_integration attributes object | null

      • token string | null Required
      • service_name string | null Required
      • is_active boolean | null Required
    • telegram_integration object | null Required

      The Telegram integration of the Replica

      Hide telegram_integration attributes Show telegram_integration attributes object | null

      • token string | null Required
      • service_name string | null Required
  • total integer Required

    The total number of replica items available across all pages

• 400 application/json

  Bad Request

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • error string Required

    A text representation of the error

  • fingerprint string

    A unique identifier of the event, useful for reporting

  • request_id string Required

    A unique identifier of the request, useful for reporting

• 401 application/json

  Unauthorized

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • error string Required

    A text representation of the error

  • fingerprint string

    A unique identifier of the event, useful for reporting

  • request_id string Required

    A unique identifier of the request, useful for reporting

• 404 application/json

  Not Found

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • error string Required

    A text representation of the error

  • request_id string Required

    A unique identifier of the request, useful for reporting

• 415 application/json

  Unsupported Media Type

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • error string Required

    A text representation of the error

  • fingerprint string

    A unique identifier of the event, useful for reporting

  • request_id string Required

    A unique identifier of the request, useful for reporting

• 500 application/json

  Internal Server Error

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • error string Required

    A text representation of the error

  • fingerprint string

    A unique identifier of the event, useful for reporting

  • request_id string Required

    A unique identifier of the request, useful for reporting

  • inner_exception object

    The inner exception

    Hide inner_exception attributes Show inner_exception attributes object

    • name string Required
    • message string Required
    • cause string
    • stack string