Skip to main content
PUT
/
v1
/
agent-npc
/
{instance}
/
{identifier}
/
interact
Register an interact event for an agent NPC
curl --request PUT \
  --url https://api.pixocracy.io/v1/agent-npc/{instance}/{identifier}/interact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "responderIdentifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "initiator": {
    "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": [
        {
          "id": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "deletedAt": "<any>",
          "name": "<any>",
          "uuid": "<any>",
          "instance": "<any>"
        }
      ],
      "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": [
        {
          "id": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "deletedAt": "<any>",
          "application": "<any>",
          "uuid": "<any>",
          "taxRate": "<any>",
          "collectedTaxes": "<any>",
          "npcs": "<any>",
          "agentNpcs": "<any>"
        }
      ]
    },
    "wealth": 0,
    "mood": 100,
    "parents": []
  },
  "responder": {
    "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": [
        {
          "id": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "deletedAt": "<any>",
          "name": "<any>",
          "uuid": "<any>",
          "instance": "<any>"
        }
      ],
      "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": [
        {
          "id": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "deletedAt": "<any>",
          "application": "<any>",
          "uuid": "<any>",
          "taxRate": "<any>",
          "collectedTaxes": "<any>",
          "npcs": "<any>",
          "agentNpcs": "<any>"
        }
      ]
    },
    "wealth": 1,
    "mood": 50,
    "parents": [
      {}
    ]
  },
  "chat": []
}
Billable Resource
Register an interaction event between Agent NPCs in your instance. Interactions are AI-driven conversations and social exchanges that help build relationships and create engaging narratives. When Agent NPCs interact, they engage in dynamic conversations based on their personalities, current state, and previous interactions. These events contribute to the social fabric of your game world and can influence future behavior and relationships.

Authorizations

​
Authorization
string
header
required

Your Application's JWT token

Path Parameters

​
instance
string
required
​
identifier
string
required

Body

application/json

The interact event data

​
responderIdentifier
string<uuid> | null
required

The ID or UUID of the responder AgentNPC

Response

The created interact event

​
id
string<uuid>
required

Unique identifier

​
createdAt
string<date-time>
required

Date of creation

​
updatedAt
string<date-time>
required

Date of last update

​
initiator
object
required

The initiator of the interaction

​
responder
object
required

The responder of the interaction

​
chat
object[]
required

The chat of the interaction

​
deletedAt
string<date-time> | null

Date of deletion