Skip to main content
GET
/
v1
/
agent-npc
/
{instance}
/
{identifier}
Retrieve an Agent NPC
curl --request GET \
  --url https://api.pixocracy.io/v1/agent-npc/{instance}/{identifier} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "instance": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "application": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "description": "<string>",
      "instances": [
        {}
      ],
      "twitchUsername": "<string>",
      "featuredInstance": {}
    },
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "taxRate": 123,
    "collectedTaxes": 123,
    "npcs": [],
    "agentNpcs": []
  },
  "agent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "endpoint": "<string>",
    "hostType": "self_hosted",
    "lastHealthCheck": "2023-11-07T05:31:56Z",
    "healthy": true,
    "claimedInstances": []
  },
  "wealth": 0,
  "mood": 100,
  "parents": []
}
Retrieve information about a specific Agent NPC in your instance using its ID or UUID. This endpoint returns comprehensive details about the Agent NPC including their name, wealth, mood, assigned AI agent, and parent relationships. This information is essential for tracking the state and development of your AI-powered characters and their interactions within the game world.

Authorizations

​
Authorization
string
header
required

Your Application's JWT token

Path Parameters

​
instance
string
required
​
identifier
string
required

The ID or UUID of the Agent NPC

Response

The Agent NPC

​
id
string<uuid>
required

Unique identifier

​
createdAt
string<date-time>
required

Date of creation

​
updatedAt
string<date-time>
required

Date of last update

​
name
string
required

The name of the NPC.

​
uuid
string<uuid>
required

The UUID of the NPC.

​
agent
object
required

The AI agent this AgentNPC uses.

​
wealth
number
default:0
required

The wealth of the agent NPC.

Required range: x >= 0
​
mood
number
default:100
required

The mood of the agent NPC.

Required range: 0 <= x <= 100
​
deletedAt
string<date-time> | null

Date of deletion

​
instance
object

The instance that the NPC is a part of.

​
parents
object[]

The parent game entities of the agent game entity.