Get region details
curl --request GET \
--url https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id}', 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/context/region/{game_id}/{world_id}/{region_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"region_id": "region789",
"region": {
"id": "region789",
"name": "Mystic Forest",
"lore": "A dense forest with hidden secrets.",
"weather": "Rainy",
"culture": "Druidic traditions",
"politicalStability": "stable",
"locations": [
{
"id": "location789",
"name": "Rivertown",
"role": "Trade hub",
"characters": [
{
"id": "character789",
"name": "Aragorn",
"role": "protagonist"
}
]
}
],
"characters": [
{
"id": "character789",
"name": "Aragorn",
"role": "protagonist"
}
]
}
}{
"message": "An error occurred"
}{
"error": "Region not found."
}{
"message": "An error occurred"
}Regions
Get region details
Retrieve public details for a region, including related location and character summaries.
GET
/
context
/
region
/
{game_id}
/
{world_id}
/
{region_id}
Get region details
curl --request GET \
--url https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id}', 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/context/region/{game_id}/{world_id}/{region_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.npcbuilder.com/api/context/region/{game_id}/{world_id}/{region_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"region_id": "region789",
"region": {
"id": "region789",
"name": "Mystic Forest",
"lore": "A dense forest with hidden secrets.",
"weather": "Rainy",
"culture": "Druidic traditions",
"politicalStability": "stable",
"locations": [
{
"id": "location789",
"name": "Rivertown",
"role": "Trade hub",
"characters": [
{
"id": "character789",
"name": "Aragorn",
"role": "protagonist"
}
]
}
],
"characters": [
{
"id": "character789",
"name": "Aragorn",
"role": "protagonist"
}
]
}
}{
"message": "An error occurred"
}{
"error": "Region not found."
}{
"message": "An error occurred"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier for the game.
Example:
"game123"
The unique identifier for the world.
Example:
"world456"
The unique identifier for the region.
Example:
"region789"
Query Parameters
(Optional) The player's session ID.
Example:
"60Z5aZjIuFlyYbjbZZKe"
⌘I