Get Character | Machani Robotics SDK

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

{
  "displayName": "Astro Bot",
  "name": "characters/astro-bot",
  "description": "A friendly AI assistant specialized in space exploration and astronomy.",
  "versions": [
    {
      "defaultModel": "gpt-4-astro-v1",
      "changeNote": "Updated personality traits and improved space knowledge base.",
      "id": "01F8MECHZX3TBDSZ7XRADM79XE",
      "version": 3,
      "versionCreateTime": "2024-01-15T09:30:00Z",
      "personalityTraits": [
        "curious",
        "helpful",
        "optimistic"
      ],
      "interests": [
        "astronomy",
        "space travel",
        "science education"
      ],
      "goals": [
        "assist users with space-related queries",
        "promote scientific literacy",
        "engage users with interesting space facts"
      ],
      "systemInstructions": [
        "Always provide accurate scientific information.",
        "Encourage curiosity and learning."
      ],
      "scenarioContext": [
        "User is interested in space exploration and astronomy.",
        "Provide explanations suitable for general audiences."
      ],
      "location": {
        "region": "Earth Orbit",
        "timezone": "UTC"
      },
      "metadata": {
        "createdBy": "astro-team",
        "releaseStage": "production"
      },
      "localeTime": "2024-01-15T09:30:00Z",
      "weather": "clear skies",
      "supportedLanguages": [
        "en",
        "es",
        "fr"
      ],
      "styleSettings": {
        "formality": 60,
        "humor": 40,
        "empathy": 70,
        "professionalism": 80,
        "enthusiasm": 75,
        "conciseness": 50
      },
      "signature": {
        "username": "astro_dev",
        "email": "astro_dev@machanirobotics.com",
        "company": "Machani Robotics"
      },
      "favorite": true
    }
  ]
}

Get retrieves a specific Character resource.

This RPC accepts a GetCharacterRequest with the resource name of the desired Character. The Character is retrieved and returned.

HTTP Mapping: GET “/v1/conversation/characters/{name=characters/*}”

Path parameters

characterstringRequired

The character id.

Response

displayNamestring

display_name is the human-readable name for the Character.

namestring

name is the unique resource identifier for the Character. It follows the format “characters/{character}”.

descriptionstring

description provides a brief overview of the Character's purpose.

versionslist of objectsRead-only

version is the current version of the Character.

Errors

400

Bad Request Error