# Get a replica

**GET /v1/replicas/{replicaUUID}**

Get an existing replica.


## Servers
- https://api.sensay.io: https://api.sensay.io ()


## Authentication methods
- Organization service token


## Parameters
### Headers
- **X-API-Version** (string)


### Path parameters
- **replicaUUID** (string(uuid))
  The replica unique identifier (UUID)



## Responses
### 200
The requested replica

#### Body: application/json (object)
- **name** (string)
  The name of the replica.
- **purpose** (string)
  The purpose of the replica. This field is not used for training the replica.
- **shortDescription** (string)
  A short description of your replica. This field is not used for training the replica.
- **greeting** (string)
  The first thing your replica will say when you start a conversation with them.
- **type** (string)
  The replica type.
  `individual`: A replica of yourself.
  `character`: A replica of a character: can be anything you want.
  `brand`: A replica of a business persona or organization.
- **ownerID** (string)
  The replica owner ID.
- **private** (boolean)
  Visibility of the replica. When set to `true`, only the owner and users on the allowlist will be able to find the replica and chat with it.
- **whitelistEmails** (array[string(email)])
  Emails of users who can use the replica when the replica is private.
- **slug** (string)
  The slug of the replica. Slugs can be used by API consumers to determine the URLs where replicas can be found.
- **tags** (array[string])
  The tags associated with the replica. Tags help categorize replicas and make them easier to find.
- **profileImage** (string)
  The URL of the profile image of the replica. The image will be downloaded, optimized and stored on our servers, so the URL in the response will be different. Supported formats: image/jpeg, image/jpg, image/pjpeg, image/png, image/bmp, image/x-windows-bmp, image/x-bmp, image/x-bitmap, image/x-ms-bmp, image/webp, image/avif
- **suggestedQuestions** (array[string])
  Suggested questions when starting a conversation.
- **llm** (object)

- **voicePreviewText** (string)
  Text that can be used to generate a voice preview.
- **isEveryConversationAccessibleBySupport** (boolean)
  Whether the replica conversations are accessible to customer support
- **uuid** (string(uuid))
  The replica UUID
- **distilledKnowledge** (string)
  The distilled knowledge of the replica
- **success** (boolean)
  Indicates the request was successful

### 400
Bad Request

#### Body: application/json (object)
- **success** (boolean)
  Indicates the status of the request
- **error** (string)
  A text representation of the error
- **error_code** (string)
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- **fingerprint** (string)
  A unique identifier of the event, useful for reporting
- **request_id** (string)
  A unique identifier of the request, useful for reporting

### 401
Unauthorized

#### Body: application/json (object)
- **success** (boolean)
  Indicates the status of the request
- **error** (string)
  A text representation of the error
- **error_code** (string)
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- **fingerprint** (string)
  A unique identifier of the event, useful for reporting
- **request_id** (string)
  A unique identifier of the request, useful for reporting

### 404
Not Found

#### Body: application/json (object)
- **success** (boolean)
  Indicates the status of the request
- **error** (string)
  A text representation of the error
- **request_id** (string)
  A unique identifier of the request, useful for reporting

### 415
Unsupported Media Type

#### Body: application/json (object)
- **success** (boolean)
  Indicates the status of the request
- **error** (string)
  A text representation of the error
- **error_code** (string)
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- **fingerprint** (string)
  A unique identifier of the event, useful for reporting
- **request_id** (string)
  A unique identifier of the request, useful for reporting

### 500
Internal Server Error

#### Body: application/json (object)
- **success** (boolean)
  Indicates the status of the request
- **error** (string)
  A text representation of the error
- **fingerprint** (string)
  A unique identifier of the event, useful for reporting
- **request_id** (string)
  A unique identifier of the request, useful for reporting
- **inner_exception** (object)
  The inner exception


[Powered by Bump.sh](https://bump.sh)