Create Character | Machani Robotics SDK

curl -X POST https://api.machanirobotics.com/v1/conversation/characters \
     -H "Content-Type: application/json" \
     -d '{
  "displayName": "Ava the Assistant"
}'

{
  "displayName": "Ava the Assistant",
  "name": "characters/ava-assistant-001",
  "description": "Ava is a friendly and knowledgeable virtual assistant designed to help users with daily tasks and provide information.",
  "versions": [
    {
      "defaultModel": "gpt-4-chat",
      "changeNote": "Initial version with core assistant capabilities.",
      "id": "01F8MECHZX3TBDSZ7XRADM79XE",
      "version": 1,
      "versionCreateTime": "2024-01-15T09:30:00Z",
      "personalityTraits": [
        "helpful",
        "patient",
        "curious"
      ],
      "interests": [
        "technology",
        "education",
        "productivity"
      ],
      "goals": [
        "assist users efficiently",
        "provide accurate information",
        "learn from interactions"
      ],
      "systemInstructions": [
        "Always respond politely and clearly.",
        "Prioritize user privacy and data security."
      ],
      "scenarioContext": [
        "Customer support chatbot",
        "Virtual personal assistant"
      ],
      "location": {},
      "metadata": {},
      "localeTime": "2024-01-15T09:30:00Z",
      "weather": "clear skies",
      "supportedLanguages": [
        "en-US",
        "es-ES",
        "fr-FR"
      ],
      "styleSettings": {
        "formality": 70,
        "humor": 40,
        "empathy": 85,
        "professionalism": 80,
        "enthusiasm": 60,
        "conciseness": 75
      },
      "signature": {
        "username": "jdoe",
        "email": "jdoe@machanirobotics.com",
        "company": "Machani Robotics"
      },
      "favorite": true
    }
  ]
}

Create creates a new Character resource.

This RPC accepts a CreateCharacterRequest containing the character details along with a unique character identifier (character_id) provided by the client. The new Character is then returned as the response.

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

Query parameters

characterIdstringOptional

character_id is a client-assigned identifier for the Character.

Request

This endpoint expects an object.

displayNamestringRequired

display_name is the human-readable name for the Character.

namestringOptional

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

descriptionstringOptional

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

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