Skip to navigation
API ReferenceCharacter World

Create an NPC

Authentication

AuthorizationBearer

LoreOS runtime API key (ck_...), sent as Authorization: Bearer <key>.

Path parameters

slugstringRequired

Request

This endpoint expects an object.
npc_refstringRequired1-160 characters
display_namestringRequired1-160 characters
rolestringOptional<=300 charactersDefaults to
persistence_levelenumOptionalDefaults to recurring
Allowed values:
voicestring or nullOptional<=1000 characters
stancestring or nullOptional<=1000 characters
agendamap from strings to anyOptional
metadatamap from strings to anyOptional
external_refstring or nullOptional<=240 characters
aliaseslist of stringsOptional
supporting_cast_statusenumOptionalDefaults to developer_promoted
Allowed values:
supporting_cast_scoredouble or nullOptional0-1
supporting_cast_evidencemap from strings to anyOptional
visibility_tierenumOptionalDefaults to planning_only
Allowed values:
canon_tierenumOptionalDefaults to soft_canon
Allowed values:

Response

Successful Response

Errors

422
Unprocessable Entity Error