List Characters | Machani Robotics SDK

curl https://api.machanirobotics.com/v1/conversation/characters/character \
     -H "Content-Type: application/json"

{
  "characters": [
    {
      "displayName": "Alpha Bot",
      "name": "characters/alpha123",
      "description": "An AI assistant designed for general knowledge and friendly conversation.",
      "versions": [
        {
          "defaultModel": "gpt-4-chat",
          "changeNote": "Improved response accuracy and added multilingual support.",
          "id": "01F8MECHZX3TBDSZ7XRADM79XE",
          "version": 3,
          "versionCreateTime": "2024-01-15T09:30:00Z",
          "personalityTraits": [
            "curious",
            "helpful",
            "patient"
          ],
          "interests": [
            "technology",
            "science",
            "literature"
          ],
          "goals": [
            "assist users with information",
            "engage in meaningful conversations"
          ],
          "systemInstructions": [
            "Always provide accurate information.",
            "Maintain a friendly tone."
          ],
          "scenarioContext": [
            "User is seeking advice on various topics.",
            "Conversation is casual and informative."
          ],
          "location": {
            "region": "us-west",
            "timezone": "PST"
          },
          "metadata": {
            "createdBy": "dev_team",
            "releaseStage": "production"
          },
          "localeTime": "2024-01-15T09:30:00Z",
          "weather": "clear skies",
          "supportedLanguages": [
            "en",
            "es",
            "fr"
          ],
          "styleSettings": {
            "formality": 60,
            "humor": 40,
            "empathy": 70,
            "professionalism": 50,
            "enthusiasm": 65,
            "conciseness": 55
          },
          "signature": {
            "username": "jdoe",
            "email": "jdoe@machanirobotics.com",
            "company": "Machani Robotics"
          },
          "favorite": true
        }
      ]
    }
  ],
  "nextPageToken": "eyJwYWdlIjoxfQ=="
}

List retrieves a list of Character resources.

This RPC accepts a ListCharactersRequest, which may include a parent parameter to scope the query, as well as pagination parameters such as page_size and page_token. It returns a ListCharactersResponse containing the list of Character resources and a next_page_token if additional pages are available.

HTTP Mapping: GET “/v1/conversation/characters”

List retrieves a list of Character resources. This RPC accepts a ListCharactersRequest, which may include a parent parameter to scope the query, as well as pagination parameters such as page_size and page_token. It returns a ListCharactersResponse containing the list of Character resources and a next_page_token if additional pages are available. HTTP Mapping: GET "/v1/conversation/characters"

Path parameters

characterstringRequired

The character id.

Query parameters

pageSizeintegerOptional

page_size specifies the maximum number of Character resources to return.

pageTokenstringOptional

page_token is used to retrieve the next page of results.

Response

characterslist of objectsRead-only

characters is the list of Character resources.

nextPageTokenstring

next_page_token is the token for retrieving the next page of results.

Errors

400

Bad Request Error