Get directive (Step 2) | ForbocAI SDK

SDK sends an observation. API analyzes it against registered rules and returns memory recall instructions telling the SDK what to query from its local vector DB.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

npcIdstringRequired

Request

This endpoint expects an object.

observationstringRequired

The game event or observation triggering the protocol

npcStatemap from strings to anyRequired

Current NPC state from the SDK

contextmap from strings to any or nullOptional

Optional additional context

rulesetIdstring or nullOptional

Response

Memory recall instructions

memoryRecallobject

Instructions for what the SDK should recall from its local vector DB

1	curl -X POST https://api.forboc.ai/npcs/npcId/directive \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"observation": "Player has entered the ancient temple and triggered the hidden trap.",
6	"npcState": {}
7	}'

1	{
2	"memoryRecall": {
3	"query": "ancient temple traps and player interactions",
4	"limit": 5,
5	"threshold": 0.75
6	}
7	}