Saltar al contenido principal
POST
/
interactions
Obtener una respuesta de un personaje NPC
curl --request POST \
  --url https://app.npcbuilder.com/api/interactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "character_id": "a96c6161-59f5-40f7-955e-459cd11",
  "game_id": "tx65BrETVN2vMrrUIrlV",
  "world_id": "PtUYW5bLMZNnXPN8qAUJ",
  "messages": [
    {
      "role": "user",
      "content": "Hola Jakinen, me llamo Juan, ¡cogeré mi espada y bailaré!"
    }
  ],
  "user_context": {
    "name": "Juan",
    "age": "Adult",
    "gender": "Male",
    "race": "Human",
    "class": "Warrior",
    "level": 5,
    "status": "Healthy",
    "description": "Huele mal, con una gran espada y una herida en el pecho"
  }
}
'
{
  "response": "Hola Juan, me llamo Jakinen",
  "user_events": [
    {
      "name": "take",
      "item": "sword"
    },
    {
      "name": "dance",
      "item": null
    }
  ],
  "character_events": [
    {
      "name": "give",
      "item": "shield"
    },
    {
      "name": "attack",
      "item": null
    }
  ]
}

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de consulta

language
enum<string>
requerido

El código de idioma para la interacción. Valores admitidos: - en-US: Inglés (Estados Unidos) - es-ES: Español (España)

Opciones disponibles:
en-US,
es-ES
Ejemplo:

"en-US"

session_id
string

(Opcional) El identificador único de la sesión del jugador.

Ejemplo:

"60Z5aZjIuFlyYbjbZZKe"

Cuerpo

Una carga útil en JSON, XML o codificada en URL que contiene el historial completo de la conversación. Asegúrate de enviar los mensajes como un array de objetos siguiendo el esquema definido.

El esquema Interaction define la estructura para una conversación entre un jugador y un NPC. Incluye metadatos como ID del personaje, ID del juego, ID del mundo y un array de mensajes.

character_id
string

El identificador único del personaje NPC.

Ejemplo:

"a96c6161-59f5-40f7-955e-459cd11"

game_id
string

El identificador único del juego.

Ejemplo:

"tx65BrETVN2vMrrUIrlV"

world_id
string

El identificador único del mundo.

Ejemplo:

"PtUYW5bLMZNnXPN8qAUJ"

messages
object[]

Un array de mensajes intercambiados entre el jugador y el NPC.

user_context
object

Un objeto que contiene información específica del jugador para el contexto del personaje.

Respuesta

Operación exitosa. Devuelve la respuesta del personaje junto con cualquier evento de usuario desencadenado.

El esquema ApiResponse representa la respuesta correcta de la API, incluyendo la respuesta del NPC y cualquier evento desencadenado por el usuario.

response
string

La respuesta generada por el NPC.

Ejemplo:

"Hola Juan, me llamo Jakinen"

user_events
object[]

Una lista de eventos desencadenados por la entrada del usuario.

character_events
object[]

Una lista de eventos desencadenados por la entrada del usuario.