curl --request PATCH \
--url https://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id} \
--header 'Content-Type: application/json' \
--data '
{
"description": "Ambush by bandits, now with a goblin lieutenant",
"difficulty": "deadly"
}
'import requests
url = "https://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id}"
payload = {
"description": "Ambush by bandits, now with a goblin lieutenant",
"difficulty": "deadly"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Ambush by bandits, now with a goblin lieutenant',
difficulty: 'deadly'
})
};
fetch('https://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_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://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'Ambush by bandits, now with a goblin lieutenant',
'difficulty' => 'deadly'
]),
CURLOPT_HTTPHEADER => [
"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://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id}"
payload := strings.NewReader("{\n \"description\": \"Ambush by bandits, now with a goblin lieutenant\",\n \"difficulty\": \"deadly\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id}")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Ambush by bandits, now with a goblin lieutenant\",\n \"difficulty\": \"deadly\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Ambush by bandits, now with a goblin lieutenant\",\n \"difficulty\": \"deadly\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2026-01-01T12:00:00Z",
"description": "Ambush by bandits on the mountain pass",
"difficulty": "hard",
"encounter_id": "enc_abc123",
"project_id": "proj_abc123",
"session_id": "sess_xyz789",
"status": "brainstorm"
}{
"error": "Forbidden",
"code": "forbidden",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "Your API key does not have the required scope.",
"doc_url": "https://docs.kitefrost.ai/errors/forbidden"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": "Rate limit exceeded",
"code": "rate_limited",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "You have exceeded the rate limit for your plan.",
"doc_url": "https://docs.kitefrost.ai/errors/rate_limited"
}{
"error": "Internal server error",
"code": "internal_error",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "An unexpected error occurred.",
"doc_url": "https://docs.kitefrost.ai/errors/internal_error"
}Update encounter
Partial update of encounter fields. Accepts description, difficulty, party_level, party_size, game_system, project_context, environment. Generated data JSONB is preserved - re-generate the encounter if you want fresh content.
curl --request PATCH \
--url https://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id} \
--header 'Content-Type: application/json' \
--data '
{
"description": "Ambush by bandits, now with a goblin lieutenant",
"difficulty": "deadly"
}
'import requests
url = "https://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id}"
payload = {
"description": "Ambush by bandits, now with a goblin lieutenant",
"difficulty": "deadly"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Ambush by bandits, now with a goblin lieutenant',
difficulty: 'deadly'
})
};
fetch('https://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_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://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'Ambush by bandits, now with a goblin lieutenant',
'difficulty' => 'deadly'
]),
CURLOPT_HTTPHEADER => [
"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://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id}"
payload := strings.NewReader("{\n \"description\": \"Ambush by bandits, now with a goblin lieutenant\",\n \"difficulty\": \"deadly\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id}")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Ambush by bandits, now with a goblin lieutenant\",\n \"difficulty\": \"deadly\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.kitefrost.ai/v1/projects/{project_id}/ttrpg-gm/encounters/{encounter_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Ambush by bandits, now with a goblin lieutenant\",\n \"difficulty\": \"deadly\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2026-01-01T12:00:00Z",
"description": "Ambush by bandits on the mountain pass",
"difficulty": "hard",
"encounter_id": "enc_abc123",
"project_id": "proj_abc123",
"session_id": "sess_xyz789",
"status": "brainstorm"
}{
"error": "Forbidden",
"code": "forbidden",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "Your API key does not have the required scope.",
"doc_url": "https://docs.kitefrost.ai/errors/forbidden"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": "Rate limit exceeded",
"code": "rate_limited",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "You have exceeded the rate limit for your plan.",
"doc_url": "https://docs.kitefrost.ai/errors/rate_limited"
}{
"error": "Internal server error",
"code": "internal_error",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "An unexpected error occurred.",
"doc_url": "https://docs.kitefrost.ai/errors/internal_error"
}Path Parameters
Body
PATCH /v1/projects/{project_id}/encounters/{encounter_id}.
Every field is optional - caller sends only the keys they intend to
change. Generated data JSONB is preserved across the update; to
refresh content, re-issue POST /encounters/{id}/generate.
1 - 500^(easy|medium|hard|deadly)$1 <= x <= 201 <= x <= 105050000100Response
Encounter updated
Encounter resource representation.
Unique encounter identifier
Brief description of the encounter scenario
Project this encounter belongs to
Human-readable slug for the URL (/projects/<slug>/encounters/<external_id>). Derived from description at create time and immutable. May be null on rows that pre-date migration 102 backfill - frontend falls back to id. See docs/conventions/dashboard-slug-urls.md.
Lifecycle status: brainstorm | draft | final
Encounter difficulty level
Active generation session ID, if any
ISO 8601 creation timestamp
URL of a generated battle-map / token image when generate_token=true was passed and image generation succeeded. Null otherwise.