Skip to main content
DELETE
/
v1
/
agent-npc
/
{instance}
/
{identifier}
Register a death event for an agent NPC
curl --request DELETE \
  --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",
  "agentNpc": {
    "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": [
          "<any>"
        ],
        "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": []
  }
}
Billable Resource
Register a death event for an Agent NPC in your instance. This permanently removes the Agent NPC from your game world and records their final state. Death events for Agent NPCs are significant as they affect the social and economic dynamics of your game world. The Agent NPC’s wealth may be redistributed, and their relationships with other characters will be terminated.

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 created death event

id
string<uuid>
required

Unique identifier

createdAt
string<date-time>
required

Date of creation

updatedAt
string<date-time>
required

Date of last update

deletedAt
string<date-time> | null

Date of deletion

agentNpc
object

The agent NPC that died