🤖NPCs

API utilized for our AI NPCs to be used in your applications.

NPCs

get

Responses

200

Success

text/plainapplication/jsontext/json

idinteger · int32Optional

accountIdinteger · int32Optional

namestring · nullableOptional

gamestring · nullableOptional

npcRolestring · nullableOptional

backgroundstring · nullableOptional

additionalFeaturesstring · nullableOptional

get

/npc

HTTPcURLJavaScriptPython

GET /npc HTTP/1.1
Accept: */*

200

Success

[
  {
    "id": 1,
    "accountId": 1,
    "name": "text",
    "game": "text",
    "npcRole": "text",
    "background": "text",
    "additionalFeatures": "text",
    "actions": [
      {
        "id": 1,
        "npcId": 1,
        "name": "text",
        "instruction": "text",
        "npc": {
          "id": 1,
          "accountId": 1,
          "name": "text",
          "game": "text",
          "npcRole": "text",
          "background": "text",
          "additionalFeatures": "text",
          "actions": [
            "[Circular Reference]"
          ],
          "knowledge": [
            "[Circular Reference]"
          ]
        }
      }
    ],
    "knowledge": [
      {
        "id": 1,
        "npcId": 1,
        "knowledgeId": 1,
        "npc": {
          "id": 1,
          "accountId": 1,
          "name": "text",
          "game": "text",
          "npcRole": "text",
          "background": "text",
          "additionalFeatures": "text",
          "actions": [
            {
              "id": 1,
              "npcId": 1,
              "name": "text",
              "instruction": "text",
              "npc": {
                "id": 1,
                "accountId": 1,
                "name": "text",
                "game": "text",
                "npcRole": "text",
                "background": "text",
                "additionalFeatures": "text",
                "actions": [
                  "[Circular Reference]"
                ],
                "knowledge": [
                  "[Circular Reference]"
                ]
              }
            }
          ],
          "knowledge": [
            "[Circular Reference]"
          ]
        },
        "knowledge": {
          "id": 1,
          "topic": "text",
          "body": "text"
        }
      }
    ]
  }
]

post

Body

application/jsontext/jsonapplication/*+json

namestring · nullableOptional

Responses

200

Success

text/plainapplication/jsontext/json

idinteger · int32Optional

accountIdinteger · int32Optional

namestring · nullableOptional

gamestring · nullableOptional

npcRolestring · nullableOptional

backgroundstring · nullableOptional

additionalFeaturesstring · nullableOptional

post

/npc

HTTPcURLJavaScriptPython

POST /npc HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

application/jsontext/jsonapplication/*+json

200

Success

{
  "id": 1,
  "accountId": 1,
  "name": "text",
  "game": "text",
  "npcRole": "text",
  "background": "text",
  "additionalFeatures": "text",
  "actions": [
    {
      "id": 1,
      "npcId": 1,
      "name": "text",
      "instruction": "text",
      "npc": {
        "id": 1,
        "accountId": 1,
        "name": "text",
        "game": "text",
        "npcRole": "text",
        "background": "text",
        "additionalFeatures": "text",
        "actions": [
          {
            "id": 1,
            "npcId": 1,
            "name": "text",
            "instruction": "text",
            "npc": "[Circular Reference]"
          }
        ],
        "knowledge": [
          {
            "id": 1,
            "npcId": 1,
            "knowledgeId": 1,
            "npc": "[Circular Reference]",
            "knowledge": {
              "id": 1,
              "topic": "text",
              "body": "text"
            }
          }
        ]
      }
    }
  ],
  "knowledge": [
    {
      "id": 1,
      "npcId": 1,
      "knowledgeId": 1,
      "npc": "[Circular Reference]",
      "knowledge": {
        "id": 1,
        "topic": "text",
        "body": "text"
      }
    }
  ]
}

get

Path parameters

idinteger · int32Required

Responses

200

Success

text/plainapplication/jsontext/json

idinteger · int32Optional

accountIdinteger · int32Optional

namestring · nullableOptional

gamestring · nullableOptional

npcRolestring · nullableOptional

backgroundstring · nullableOptional

additionalFeaturesstring · nullableOptional

get

/npc/{id}

HTTPcURLJavaScriptPython

GET /npc/{id} HTTP/1.1
Accept: */*

200

Success

{
  "id": 1,
  "accountId": 1,
  "name": "text",
  "game": "text",
  "npcRole": "text",
  "background": "text",
  "additionalFeatures": "text",
  "actions": [
    {
      "id": 1,
      "npcId": 1,
      "name": "text",
      "instruction": "text",
      "npc": {
        "id": 1,
        "accountId": 1,
        "name": "text",
        "game": "text",
        "npcRole": "text",
        "background": "text",
        "additionalFeatures": "text",
        "actions": [
          {
            "id": 1,
            "npcId": 1,
            "name": "text",
            "instruction": "text",
            "npc": "[Circular Reference]"
          }
        ],
        "knowledge": [
          {
            "id": 1,
            "npcId": 1,
            "knowledgeId": 1,
            "npc": "[Circular Reference]",
            "knowledge": {
              "id": 1,
              "topic": "text",
              "body": "text"
            }
          }
        ]
      }
    }
  ],
  "knowledge": [
    {
      "id": 1,
      "npcId": 1,
      "knowledgeId": 1,
      "npc": "[Circular Reference]",
      "knowledge": {
        "id": 1,
        "topic": "text",
        "body": "text"
      }
    }
  ]
}

put

Path parameters

idinteger · int32Required

Body

application/jsontext/jsonapplication/*+json

idinteger · int32Optional

accountIdinteger · int32Optional

namestring · nullableOptional

gamestring · nullableOptional

npcRolestring · nullableOptional

backgroundstring · nullableOptional

additionalFeaturesstring · nullableOptional

Responses

200

Success

No content

put

/npc/{id}

HTTPcURLJavaScriptPython

PUT /npc/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 654

{
  "id": 1,
  "accountId": 1,
  "name": "text",
  "game": "text",
  "npcRole": "text",
  "background": "text",
  "additionalFeatures": "text",
  "actions": [
    {
      "id": 1,
      "npcId": 1,
      "name": "text",
      "instruction": "text",
      "npc": {
        "id": 1,
        "accountId": 1,
        "name": "text",
        "game": "text",
        "npcRole": "text",
        "background": "text",
        "additionalFeatures": "text",
        "actions": [
          {
            "id": 1,
            "npcId": 1,
            "name": "text",
            "instruction": "text",
            "npc": "[Circular Reference]"
          }
        ],
        "knowledge": [
          {
            "id": 1,
            "npcId": 1,
            "knowledgeId": 1,
            "npc": "[Circular Reference]",
            "knowledge": {
              "id": 1,
              "topic": "text",
              "body": "text"
            }
          }
        ]
      }
    }
  ],
  "knowledge": [
    {
      "id": 1,
      "npcId": 1,
      "knowledgeId": 1,
      "npc": "[Circular Reference]",
      "knowledge": {
        "id": 1,
        "topic": "text",
        "body": "text"
      }
    }
  ]
}

application/jsontext/jsonapplication/*+json

200

Success

No content

delete

Path parameters

idstring · uuidRequired

Responses

200

Success

text/plainapplication/jsontext/json

idinteger · int32Optional

accountIdinteger · int32Optional

namestring · nullableOptional

gamestring · nullableOptional

npcRolestring · nullableOptional

backgroundstring · nullableOptional

additionalFeaturesstring · nullableOptional

delete

/npc/{id}

HTTPcURLJavaScriptPython

DELETE /npc/{id} HTTP/1.1
Accept: */*

200

Success

{
  "id": 1,
  "accountId": 1,
  "name": "text",
  "game": "text",
  "npcRole": "text",
  "background": "text",
  "additionalFeatures": "text",
  "actions": [
    {
      "id": 1,
      "npcId": 1,
      "name": "text",
      "instruction": "text",
      "npc": {
        "id": 1,
        "accountId": 1,
        "name": "text",
        "game": "text",
        "npcRole": "text",
        "background": "text",
        "additionalFeatures": "text",
        "actions": [
          {
            "id": 1,
            "npcId": 1,
            "name": "text",
            "instruction": "text",
            "npc": "[Circular Reference]"
          }
        ],
        "knowledge": [
          {
            "id": 1,
            "npcId": 1,
            "knowledgeId": 1,
            "npc": "[Circular Reference]",
            "knowledge": {
              "id": 1,
              "topic": "text",
              "body": "text"
            }
          }
        ]
      }
    }
  ],
  "knowledge": [
    {
      "id": 1,
      "npcId": 1,
      "knowledgeId": 1,
      "npc": "[Circular Reference]",
      "knowledge": {
        "id": 1,
        "topic": "text",
        "body": "text"
      }
    }
  ]
}