Create a new session
curl --request POST \
--url https://app.npcbuilder.com/api/sessionmanager \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"session_key": "campaign_nightfall",
"game_id": "game_12345",
"player_id": "550e8400-e29b-41d4-a716-446655440000"
}
'import requests
url = "https://app.npcbuilder.com/api/sessionmanager"
payload = {
"session_key": "campaign_nightfall",
"game_id": "game_12345",
"player_id": "550e8400-e29b-41d4-a716-446655440000"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
session_key: 'campaign_nightfall',
game_id: 'game_12345',
player_id: '550e8400-e29b-41d4-a716-446655440000'
})
};
fetch('https://app.npcbuilder.com/api/sessionmanager', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.npcbuilder.com/api/sessionmanager",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'session_key' => 'campaign_nightfall',
'game_id' => 'game_12345',
'player_id' => '550e8400-e29b-41d4-a716-446655440000'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.npcbuilder.com/api/sessionmanager"
payload := strings.NewReader("{\n \"session_key\": \"campaign_nightfall\",\n \"game_id\": \"game_12345\",\n \"player_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.npcbuilder.com/api/sessionmanager")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"session_key\": \"campaign_nightfall\",\n \"game_id\": \"game_12345\",\n \"player_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.npcbuilder.com/api/sessionmanager")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"session_key\": \"campaign_nightfall\",\n \"game_id\": \"game_12345\",\n \"player_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Session created for key: campaign_nightfall with id: ABC123 has been created",
"session_key": "<string>",
"session_id": "<string>",
"player_id": "<string>"
}{
"message": "An error occurred"
}{
"message": "Session already existing for key: campaign_nightfall. Please delete it before creating a new one.",
"session_id": "<string>"
}{
"message": "An error occurred"
}Sessions
Create a new session
Create a new player session for a specific game. A session ties a player to a game context and is used for tracking interactions & specific context.
POST
/
sessionmanager
Create a new session
curl --request POST \
--url https://app.npcbuilder.com/api/sessionmanager \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"session_key": "campaign_nightfall",
"game_id": "game_12345",
"player_id": "550e8400-e29b-41d4-a716-446655440000"
}
'import requests
url = "https://app.npcbuilder.com/api/sessionmanager"
payload = {
"session_key": "campaign_nightfall",
"game_id": "game_12345",
"player_id": "550e8400-e29b-41d4-a716-446655440000"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
session_key: 'campaign_nightfall',
game_id: 'game_12345',
player_id: '550e8400-e29b-41d4-a716-446655440000'
})
};
fetch('https://app.npcbuilder.com/api/sessionmanager', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.npcbuilder.com/api/sessionmanager",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'session_key' => 'campaign_nightfall',
'game_id' => 'game_12345',
'player_id' => '550e8400-e29b-41d4-a716-446655440000'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.npcbuilder.com/api/sessionmanager"
payload := strings.NewReader("{\n \"session_key\": \"campaign_nightfall\",\n \"game_id\": \"game_12345\",\n \"player_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.npcbuilder.com/api/sessionmanager")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"session_key\": \"campaign_nightfall\",\n \"game_id\": \"game_12345\",\n \"player_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.npcbuilder.com/api/sessionmanager")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"session_key\": \"campaign_nightfall\",\n \"game_id\": \"game_12345\",\n \"player_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Session created for key: campaign_nightfall with id: ABC123 has been created",
"session_key": "<string>",
"session_id": "<string>",
"player_id": "<string>"
}{
"message": "An error occurred"
}{
"message": "Session already existing for key: campaign_nightfall. Please delete it before creating a new one.",
"session_id": "<string>"
}{
"message": "An error occurred"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The session details required to create a new session.
Schema for creating a new session. Contains session key, game identifier, and player identifier.
A unique key for the session.
Maximum string length:
50Pattern:
^[a-zA-Z0-9_-]+$Example:
"campaign_nightfall"
The unique identifier for the game.
Maximum string length:
50Example:
"game_12345"
The unique identifier for the player.
Example:
"550e8400-e29b-41d4-a716-446655440000"
⌘I