Crear un nuevo personaje

curl --request POST \
  --url https://app.npcbuilder.com/api/context/characters/{game_id}/{world_id}/{character_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "age": "adult",
  "description": "Un valiente guerrero con un pasado misterioso.",
  "gender": "Male",
  "model": "standard",
  "filters": {
    "active": true,
    "violence": false,
    "sexual": false,
    "drugs": true
  },
  "items": [
    {
      "type": "trade",
      "itemName": "Sword",
      "unit": "Pieza",
      "value": "100",
      "description": "Una espada afilada."
    }
  ],
  "events": [
    {
      "type": "item",
      "eventName": "Attack",
      "description": "Acto de violencia contra otra persona."
    }
  ],
  "name": "Aragorn",
  "quests": [
    {
      "description": "Recupera el artefacto perdido.",
      "objective": "Encontrar y devolver el artefacto.",
      "reward": "500 monedas de oro"
    }
  ],
  "role": "protagonist",
  "tone": "mysterious",
  "traits": [
    "brave"
  ]
}
'

{
  "message": "Personaje: character789 ha sido creado con el siguiente contexto.",
  "character_id": "character789",
  "character_context": {
    "age": "adult",
    "description": "Un valiente guerrero con un pasado misterioso.",
    "gender": "Male",
    "items": [
      {
        "itemName": "Sword",
        "unit": "Pieza",
        "value": "100"
      }
    ],
    "name": "Aragorn",
    "quests": [
      {
        "description": "Recupera el artefacto perdido.",
        "objective": "Encontrar y devolver el artefacto.",
        "reward": "500 monedas de oro"
      }
    ],
    "role": "protagonist",
    "tone": "mysterious",
    "traits": [
      "brave"
    ]
  }
}

POST

context

characters

{game_id}

{world_id}

{character_id}

Crear un nuevo personaje

curl --request POST \
  --url https://app.npcbuilder.com/api/context/characters/{game_id}/{world_id}/{character_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "age": "adult",
  "description": "Un valiente guerrero con un pasado misterioso.",
  "gender": "Male",
  "model": "standard",
  "filters": {
    "active": true,
    "violence": false,
    "sexual": false,
    "drugs": true
  },
  "items": [
    {
      "type": "trade",
      "itemName": "Sword",
      "unit": "Pieza",
      "value": "100",
      "description": "Una espada afilada."
    }
  ],
  "events": [
    {
      "type": "item",
      "eventName": "Attack",
      "description": "Acto de violencia contra otra persona."
    }
  ],
  "name": "Aragorn",
  "quests": [
    {
      "description": "Recupera el artefacto perdido.",
      "objective": "Encontrar y devolver el artefacto.",
      "reward": "500 monedas de oro"
    }
  ],
  "role": "protagonist",
  "tone": "mysterious",
  "traits": [
    "brave"
  ]
}
'

{
  "message": "Personaje: character789 ha sido creado con el siguiente contexto.",
  "character_id": "character789",
  "character_context": {
    "age": "adult",
    "description": "Un valiente guerrero con un pasado misterioso.",
    "gender": "Male",
    "items": [
      {
        "itemName": "Sword",
        "unit": "Pieza",
        "value": "100"
      }
    ],
    "name": "Aragorn",
    "quests": [
      {
        "description": "Recupera el artefacto perdido.",
        "objective": "Encontrar y devolver el artefacto.",
        "reward": "500 monedas de oro"
      }
    ],
    "role": "protagonist",
    "tone": "mysterious",
    "traits": [
      "brave"
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

game_id

string

required

El identificador único del juego.

Example:

"game123"

world_id

string

required

El identificador único del mundo.

Example:

"world456"

character_id

string

required

El identificador único del personaje.

Example:

"character789"

Query Parameters

session_id

string

(Opcional) El ID de sesión del jugador.

Example:

"60Z5aZjIuFlyYbjbZZKe"

Body

application/json

Los datos necesarios del personaje para crearlo.

age

enum<string>

La categoría de edad del personaje.

Opciones disponibles:

infant,

child,

teenager,

youngAdult,

adult,

middleAged,

elderly

Example:

"adult"

description

string

Una breve descripción de los antecedentes del personaje.

Example:

"Un valiente guerrero con un pasado misterioso."

gender

string

El género del personaje.

Example:

"Male"

model

enum<string>

El modelo de IA usado para las interacciones del personaje. Los modelos premium solo están disponibles para algunas suscripciones.

Opciones disponibles:

standard,

premium

Example:

"standard"

filters

object

Filtros de contenido estructurados aplicados a las respuestas del personaje. Activa o desactiva las categorías individuales para controlar lo que puede decir.

Mostrar atributos secundarios

filters.active

boolean

required

Activa o desactiva todos los filtros del personaje.

filters.violence

boolean

required

Refuerza contenido violento o sangriento en las respuestas del personaje.

filters.sexual

boolean

required

Refuerza contenido sexual o sugestivo en las respuestas del personaje.

filters.drugs

boolean

required

Refuerza referencias al consumo de drogas o parafernalia en las respuestas del personaje.

Example:

{
  "active": true,
  "violence": false,
  "sexual": false,
  "drugs": true
}

items

object[]

Lista de objetos asociados al personaje. Cada objeto debe seguir uno de los esquemas predefinidos según su tipo.

Esquema para objetos de tipo "trade"

Option 1
Option 2

Mostrar atributos secundarios

items.type

enum<string>

required

El tipo de objeto, que determina su esquema.

Opciones disponibles:

trade

Example:

"trade"

items.itemName

string

required

El nombre del objeto de intercambio.

Example:

"Sword"

items.unit

string

required

La unidad en la que se mide el objeto.

Example:

"Pieza"

items.value

string

required

El valor o coste del objeto.

Example:

"100"

items.description

string

Una descripción detallada del objeto.

Example:

"Una espada afilada."

events

object[]

Lista de eventos asociados al personaje. Cada evento debe ajustarse al esquema definido para su tipo.

Esquema para eventos de tipo "action"

Option 1
Option 2

Mostrar atributos secundarios

events.type

enum<string>

required

El tipo de evento.

Opciones disponibles:

action

Example:

"item"

events.eventName

string

required

El nombre del evento.

Example:

"Attack"

events.description

string

Detalles del evento.

Example:

"Acto de violencia contra otra persona."

name

string

El nombre visible del personaje.

Example:

"Aragorn"

quests

object[]

Una lista de misiones asociadas al personaje.

Mostrar atributos secundarios

quests.description

string

Breve descripción de la misión.

Example:

"Recupera el artefacto perdido."

quests.objective

string

El objetivo principal de la misión.

Example:

"Encontrar y devolver el artefacto."

quests.reward

string

La recompensa por completar la misión.

Example:

"500 monedas de oro"

role

enum<string>

El rol del personaje en el juego. Determina cómo interactúa con la historia.

Opciones disponibles:

noRole,

protagonist,

antagonist,

secondaryCharacter,

tertiaryCharacter,

mentor,

enemy,

villain,

rival,

shopkeeper,

healer,

questGiver,

innkeeper,

guard,

familyMember,

loveInterest,

scientist,

politician,

criminal,

explorer,

wizard,

ghost,

animalCompanion,

artificialIntelligence

Example:

"protagonist"

tone

enum<string>

El tono o estilo del diálogo del personaje.

Opciones disponibles:

formal,

casual,

sarcastic,

mysterious,

emotive

Example:

"mysterious"

traits

string[]

Lista de rasgos de personalidad que describen al personaje.

Response

Personaje creado correctamente.

message

string

Mensaje de confirmación con detalles del personaje.

Example:

"Personaje: character789 ha sido creado con el siguiente contexto."

character_id

string

UID del personaje.

Example:

"character789"

character_context

object

El contexto del personaje creado.

Example:

{
  "age": "adult",
  "description": "Un valiente guerrero con un pasado misterioso.",
  "gender": "Male",
  "items": [
    {
      "itemName": "Sword",
      "unit": "Pieza",
      "value": "100"
    }
  ],
  "name": "Aragorn",
  "quests": [
    {
      "description": "Recupera el artefacto perdido.",
      "objective": "Encontrar y devolver el artefacto.",
      "reward": "500 monedas de oro"
    }
  ],
  "role": "protagonist",
  "tone": "mysterious",
  "traits": ["brave"]
}

Obtener una respuesta de un personaje NPC Eliminar un personaje

⌘I

Documentación de la API

Endpoints

Crear un nuevo personaje

Authorizations

Path Parameters

Query Parameters

Body

Response