Referencia de API

Inicia sesión en la app NPC Builder #

Accede a la aplicación web de NPC Builder a través de este enlace: https://app.npcbuilder.com.

Navega a la sección de desarrolladores #

Haz click en el icono de desarrolladores de la barra de navegación

Genera el token de autenticación #

Haz click en el botón «Generate Bearer Token» y copia el resultado. Guárdalo para después!

Obtén los IDs de tu juego y mundo #

En el arbol que aparece en pantalla, encuentra los IDs asociados al juego y mundo donde se encuentra tu personaje.

Construye la petición a la API #

Con los detalles previos ya puedes construir el cuerpo de la llamada a la API como sigue:

{
   "character_name":"Name",
   "game_id":"ID",
   "world_id":"ID",
   "messages":[
      {"role":"user",
      "content":"Message"}
   ]
}

NOTA: Recuerda que para mantener el contexto de toda la conversación, es importante añadir todas las interacciones, deberás añadir todos los mensajes a la lista como se muestra a continuación.

El parámetro «role» puede tomar los siguientes valores (es sensible a mayúsculas y minúsculas):
-user: representa al usuario que está interactuando con el NPC
-assistant: representa al NPC

{
   "character_name":"Name",
   "game_id":"ID",
   "world_id":"ID",
   "messages":[
      {"role":"user",
      "content":"Message"},
       {"role":"assistant",
      "content":"Message"},
       {"role":"user",
      "content":"Message"}
   ]
}

Envía la petición a la API #

Envía tu petición a la API con el método POST a nuestro endpoint. Recuerda utilizar Autorización tipo Bearer pasando el token obtenido en el paso «Genera el token de autenticación», y el body construido en el paso «Construye la petición a la API»

POST https://app.npcbuilder.com/api/interactions

Recupera la respuesta #

Recibirás directamente la respuesta del personaje a la lista de mensajes, formateado como un string.

{
  "response": "Hello, how are you today?", 
  "user_events": [
    {
        "name": "take",
        "item": "sword"
    },
    {
        "name": "dance",
        "item": null
    }
  ],
  "character_events": [
      {
          "name": "take",
          "item": "sword"
      },
      {
          "name": "dance",
          "item": null
      }
  ]
}

OpenAPI #

Para la referencia de la API consulta https://npcbuilder.com/docs-api