Default

Health check

get
Responses
200

Plugin status and version

application/json
get
/api/ping
GET /api/ping HTTP/1.1
Host: localhost:7777
Accept: */*
200

Plugin status and version

{
  "status": "text",
  "version": "text"
}

Create a new session

post
Responses
200

Returns a session ID

application/json
post
/api/create-session
POST /api/create-session HTTP/1.1
Host: localhost:7777
Accept: */*
200

Returns a session ID

{
  "sessionId": "text"
}

Get current plugin state

get
Query parameters
sessionstringRequired
Responses
200

Plugin state snapshot

application/json
get
/api/plugin-state
GET /api/plugin-state?session=text HTTP/1.1
Host: localhost:7777
Accept: */*
200

Plugin state snapshot

{
  "conversations": [
    {}
  ],
  "npcs": [
    {}
  ]
}

Update plugin state

post
Query parameters
sessionstringRequired
Body
conversationsobject[]Optional
npcsobject[]Optional
Responses
200

Success response

application/json
post
/api/plugin-state
POST /api/plugin-state?session=text HTTP/1.1
Host: localhost:7777
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "conversations": [
    {}
  ],
  "npcs": [
    {}
  ]
}
200

Success response

{
  "status": "text",
  "message": "text"
}

Last updated