{ "openapi": "3.0.3", "info": { "title": "Kismet Developer API", "version": "0.7.46", "description": "Published, collection-scoped Kismet resources for external builders: SDKs, fixtures, and developer applications.\n\nOperations require a Kismet developer Bearer credential and positive collection/entity grants. Catalog reads default to published content. TEST installations can explicitly request view=staging on group and vacation-rental list/detail reads for manager-approved, unexpired previews. Indicative pricing from Kismet’s synchronized calendar plane (the nightly calendar and list/detail nightly-from summaries) is available behind the `rates.read` grant; the API still deliberately excludes quotes, totals, fees, taxes, booking URLs, checkout, arbitrary draft access, exact private addresses, and vendor payloads.\n\nBase URL: https://api.ksmt.app/v1. Each operation declares its maturity, capabilities and TEST/LIVE behavior. A TEST offer capture can send a real staging email to an explicitly registered test recipient; TEST does not universally mean simulated delivery.", "contact": { "name": "Kismet Developer Platform", "email": "engineering@makekismet.com" } }, "paths": { "/v1/developer/collections/{collection}": { "get": { "operationId": "getVacationRentalManager", "summary": "Get a published vacation rental manager", "tags": [ "developer-published-resources" ], "description": "Returns published, non-transactional Kismet content within the authenticated application grant. No rates, availability, indicative pricing, booking URL, draft state, or vendor payload is returned.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "name", "brand", "links", "propertyCount", "publication" ], "properties": { "resourceType": { "enum": [ "collection" ] }, "type": { "enum": [ "vacation_rental_manager" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "brand": { "type": "object", "additionalProperties": false, "properties": { "logoUrl": { "type": "string", "format": "uri" }, "faviconUrl": { "type": "string", "format": "uri" }, "primaryColor": { "type": "string" }, "secondaryColor": { "type": "string" } } }, "links": { "type": "object", "additionalProperties": false, "required": [ "self", "vacationRentals", "bookableProductGroups" ], "properties": { "self": { "type": "string" }, "vacationRentals": { "type": "string" }, "bookableProductGroups": { "type": "string" }, "website": { "type": "string", "format": "uri" } } }, "propertyCount": { "type": "integer", "minimum": 0 }, "publication": { "type": "object", "additionalProperties": false, "required": [ "updatedAt" ], "properties": { "updatedAt": { "type": "string", "format": "date-time" } } } } }, "example": { "resourceType": "collection", "type": "vacation_rental_manager", "id": "11111111-1111-4111-8111-111111111111", "slug": "sandbox-stays", "name": "Sandbox Stays", "description": "Evaluation collection used in developer sandbox examples.", "brand": { "logoUrl": "https://cdn.kismet.travel/sandbox/logo.png", "faviconUrl": "https://cdn.kismet.travel/sandbox/favicon.ico", "primaryColor": "#3b0014", "secondaryColor": "#677251" }, "links": { "self": "/v1/developer/collections/11111111-1111-4111-8111-111111111111", "vacationRentals": "/v1/developer/collections/11111111-1111-4111-8111-111111111111/vacation-rentals", "bookableProductGroups": "/v1/developer/collections/11111111-1111-4111-8111-111111111111/bookable-product-groups", "website": "https://sandbox-stays.example" }, "propertyCount": 2, "publication": { "updatedAt": "2026-07-01T00:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "collections.read" } }, "/v1/developer/collections/{collection}/bookable-product-groups": { "get": { "operationId": "listBookableProductGroups", "summary": "List published catalog groups for a collection", "tags": [ "developer-published-resources" ], "description": "Returns the published catalog hierarchy available to this installation. TEST installations may request view=staging to include only explicitly approved, unexpired staging groups; room reads additionally require the independent inventory preview grant; no booking writes are enabled. The core resource is a bookable-product group; `type` carries the installed vertical vocabulary. In the Vacation Rental pack, areas, resorts, and curated property groups are all `vacation_rental_group` resources. Members-only groups are never served on this surface. For dynamically curated groups, membership and `memberCount` reflect the most recent scheduled membership refresh.", "parameters": [ { "schema": { "type": "string", "enum": [ "UNCLASSIFIED", "BUILDING", "NEIGHBORHOOD" ] }, "in": "query", "name": "semanticType", "required": false, "description": "Filter by canonical classification before pagination. Omit for all classifications. Independent of STANDARD/DROP grouping behavior." }, { "schema": { "type": "string", "enum": [ "published", "staging" ], "default": "published" }, "in": "query", "name": "view", "required": false, "description": "TEST-only opt-in to explicitly approved, unexpired staging catalog and room reads. Omit for published inventory. Does not authorize pricing, booking, or publication." }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "name", "collection", "classification", "media", "memberCount", "links", "publication", "capabilities" ], "properties": { "resourceType": { "enum": [ "bookable_product_group" ] }, "type": { "enum": [ "vacation_rental_group" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "collection": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "classification": { "type": "object", "additionalProperties": false, "required": [ "tags" ], "properties": { "semanticType": { "type": "string", "enum": [ "UNCLASSIFIED", "BUILDING", "NEIGHBORHOOD" ] }, "marketingRegion": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "media": { "type": "object", "additionalProperties": false, "properties": { "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } } } }, "parent": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "memberCount": { "type": "integer", "minimum": 0 }, "links": { "type": "object", "additionalProperties": false, "required": [ "self", "bookableProducts" ], "properties": { "self": { "type": "string" }, "bookableProducts": { "type": "string" } } }, "publication": { "type": "object", "additionalProperties": false, "required": [ "updatedAt" ], "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "visibility": { "type": "string", "enum": [ "published", "staging" ] }, "stagingExpiresAt": { "type": "string", "format": "date-time" } } }, "capabilities": { "type": "array", "items": { "type": "string" } }, "content": { "type": "object", "additionalProperties": false, "required": [ "faqs" ], "properties": { "bodyHtml": { "type": "string" }, "faqs": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "question", "answerHtml" ], "properties": { "question": { "type": "string" }, "answerHtml": { "type": "string" } } } } } }, "reviews": { "type": "object", "additionalProperties": false, "required": [ "aggregate", "featured" ], "properties": { "aggregate": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "overallRating", "reviewCount" ], "properties": { "overallRating": { "type": "number" }, "reviewCount": { "type": "integer", "minimum": 0 } } } ] }, "featured": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "vacationRentalId", "reviewerDisplayName", "reviewText", "overallRating", "channel", "propertyName" ], "properties": { "id": { "type": "string" }, "vacationRentalId": { "type": "string" }, "reviewerDisplayName": { "type": "string" }, "reviewText": { "type": "string" }, "overallRating": { "type": "number" }, "channel": { "type": "string" }, "propertyName": { "type": "string" }, "propertyImage": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } } } } } } }, "children": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name", "memberCount" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, "memberCount": { "type": "integer", "minimum": 0 } } } }, "stories": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "title" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } } } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "example": { "data": [ { "resourceType": "bookable_product_group", "type": "vacation_rental_group", "id": "33333333-3333-4333-8333-333333333333", "slug": "old-port", "name": "Old Port", "description": "Walkable stays near the waterfront and historic district.", "collection": { "id": "11111111-1111-4111-8111-111111111111", "slug": "sandbox-stays", "name": "Sandbox Stays" }, "classification": { "marketingRegion": "Portland", "tags": [ "walkable", "waterfront" ] }, "media": {}, "memberCount": 8, "links": { "self": "/v1/developer/bookable-product-groups/33333333-3333-4333-8333-333333333333", "bookableProducts": "/v1/developer/collections/11111111-1111-4111-8111-111111111111/vacation-rentals?group=old-port" }, "publication": { "updatedAt": "2026-08-25T00:00:00.000Z" }, "capabilities": [ "vacation_rentals.read" ] } ], "page": { "limit": 20, "nextCursor": null } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience + Catalog", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "vacation_rentals.read" } }, "/v1/developer/bookable-product-groups/{group}": { "get": { "operationId": "getBookableProductGroup", "summary": "Get a published catalog group", "tags": [ "developer-published-resources" ], "description": "Returns one catalog group by id or slug. Published by default; TEST view=staging includes only explicitly approved, unexpired groups. Follow `links.bookableProducts`, or pass the group slug to catalog and availability reads, to keep area and resort pages on the same live collection membership plane.", "parameters": [ { "schema": { "type": "string", "enum": [ "published", "staging" ], "default": "published" }, "in": "query", "name": "view", "required": false, "description": "TEST-only opt-in to explicitly approved, unexpired staging catalog and room reads. Omit for published inventory. Does not authorize pricing, booking, or publication." }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "group", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "name", "collection", "classification", "media", "memberCount", "links", "publication", "capabilities" ], "properties": { "resourceType": { "enum": [ "bookable_product_group" ] }, "type": { "enum": [ "vacation_rental_group" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "collection": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "classification": { "type": "object", "additionalProperties": false, "required": [ "tags" ], "properties": { "semanticType": { "type": "string", "enum": [ "UNCLASSIFIED", "BUILDING", "NEIGHBORHOOD" ] }, "marketingRegion": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "media": { "type": "object", "additionalProperties": false, "properties": { "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } } } }, "parent": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "memberCount": { "type": "integer", "minimum": 0 }, "links": { "type": "object", "additionalProperties": false, "required": [ "self", "bookableProducts" ], "properties": { "self": { "type": "string" }, "bookableProducts": { "type": "string" } } }, "publication": { "type": "object", "additionalProperties": false, "required": [ "updatedAt" ], "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "visibility": { "type": "string", "enum": [ "published", "staging" ] }, "stagingExpiresAt": { "type": "string", "format": "date-time" } } }, "capabilities": { "type": "array", "items": { "type": "string" } }, "content": { "type": "object", "additionalProperties": false, "required": [ "faqs" ], "properties": { "bodyHtml": { "type": "string" }, "faqs": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "question", "answerHtml" ], "properties": { "question": { "type": "string" }, "answerHtml": { "type": "string" } } } } } }, "reviews": { "type": "object", "additionalProperties": false, "required": [ "aggregate", "featured" ], "properties": { "aggregate": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "overallRating", "reviewCount" ], "properties": { "overallRating": { "type": "number" }, "reviewCount": { "type": "integer", "minimum": 0 } } } ] }, "featured": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "vacationRentalId", "reviewerDisplayName", "reviewText", "overallRating", "channel", "propertyName" ], "properties": { "id": { "type": "string" }, "vacationRentalId": { "type": "string" }, "reviewerDisplayName": { "type": "string" }, "reviewText": { "type": "string" }, "overallRating": { "type": "number" }, "channel": { "type": "string" }, "propertyName": { "type": "string" }, "propertyImage": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } } } } } } }, "children": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name", "memberCount" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, "memberCount": { "type": "integer", "minimum": 0 } } } }, "stories": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "title" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } } } } } } }, "example": { "resourceType": "bookable_product_group", "type": "vacation_rental_group", "id": "33333333-3333-4333-8333-333333333333", "slug": "old-port", "name": "Old Port", "collection": { "id": "11111111-1111-4111-8111-111111111111", "slug": "sandbox-stays", "name": "Sandbox Stays" }, "classification": { "marketingRegion": "Portland", "tags": [ "walkable" ] }, "media": {}, "memberCount": 8, "links": { "self": "/v1/developer/bookable-product-groups/33333333-3333-4333-8333-333333333333", "bookableProducts": "/v1/developer/collections/11111111-1111-4111-8111-111111111111/vacation-rentals?group=old-port" }, "publication": { "updatedAt": "2026-08-25T00:00:00.000Z" }, "capabilities": [ "vacation_rentals.read" ], "content": { "faqs": [] }, "reviews": { "aggregate": { "overallRating": 4.86, "reviewCount": 1042 }, "featured": [ { "id": "44444444-4444-4444-8444-444444444444", "vacationRentalId": "22222222-2222-4222-8222-222222222222", "reviewerDisplayName": "Jamie", "reviewText": "Wonderful stay — spotless, quiet, and a short walk to the water.", "overallRating": 5, "channel": "airbnb2", "propertyName": "Sandbox Chalet", "propertyImage": { "url": "https://kismet.travel/vrm/sandbox-stays/images/chalet.jpg" } } ] }, "children": [ { "id": "55555555-5555-4555-8555-555555555555", "slug": "old-port-waterfront", "name": "Waterfront", "memberCount": 3 } ], "stories": [] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience + Catalog", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "vacation_rentals.read" } }, "/v1/developer/collections/{collection}/vacation-rentals": { "get": { "operationId": "listVacationRentals", "summary": "List published vacation rentals for a manager", "tags": [ "developer-published-resources" ], "description": "Returns published Kismet content within the authenticated application grant. When the credential also holds collection-wide `rates.read`, each row may add `pricing.nightlyFrom`, the cheapest sellable night in the coming 90 days, kept current by Kismet's rate synchronization and served from stored values (no calendar is read per request). It is indicative display pricing, never a dated quote. `sort` orders the WHOLE matched set: `recommended` is the collection's own stable order; `price-asc`/`price-desc` order by `pricing.nightlyFrom` with homes lacking a synced price last; `name-asc` orders by name; `bedrooms`/`sleeps` order largest-first with missing values last; `best-fit` is the Best-Fit ranking Kismet storefronts show (the /v1/public/vrm order). Ties always break by name, then id, and the cursor keeps the sort across pages. `minPrice`/`maxPrice` are whole currency units per night (inclusive) against `nightlyFrom`; homes without a synced price are excluded only while a price filter is set. Unknown sort values return a 400 problem. Every summary already carries `location.geo`, `media.hero`, `media.cardImages` (up to 5 card-carousel photos: the hero first, then priority-space photos, then the gallery; public-safe or Kismet-proxied URLs only) and (behind `rates.read`) `pricing.nightlyFrom` when the data exists, so a card, card carousel, map, or sort needs no per-home detail read. TEST view=staging additionally reads linked rooms under both active catalog and source-inventory grants. Staging-only rooms have publication.publishedAt=null and an explicit visibility/expiry; indicative pricing is withheld. No availability search, booking URL, or vendor payload is returned.", "parameters": [ { "schema": { "type": "string", "enum": [ "published", "staging" ], "default": "published" }, "in": "query", "name": "view", "required": false, "description": "TEST-only opt-in to explicitly approved, unexpired staging catalog and room reads. Omit for published inventory. Does not authorize pricing, booking, or publication." }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "group", "required": false, "description": "Published bookable-product group id or slug." }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "minBedrooms", "required": false }, { "schema": { "type": "number", "minimum": 0 }, "in": "query", "name": "minBathrooms", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "minGuests", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "petsAllowed", "required": false }, { "schema": { "type": "string", "enum": [ "recommended", "price-asc", "price-desc", "name-asc", "bedrooms", "sleeps", "best-fit" ], "default": "recommended" }, "in": "query", "name": "sort", "required": false, "description": "Whole-set ordering. recommended = the collection’s own order; price-* by pricing.nightlyFrom (unpriced homes last); bedrooms/sleeps largest-first; ties break by name then id. The cursor keeps the sort." }, { "schema": { "type": "number", "minimum": 0 }, "in": "query", "name": "minPrice", "required": false, "description": "Minimum nightly from-price in whole currency units (inclusive, against pricing.nightlyFrom). Homes without a synced price are excluded while any price filter is set." }, { "schema": { "type": "number", "minimum": 0 }, "in": "query", "name": "maxPrice", "required": false, "description": "Maximum nightly from-price in whole currency units (inclusive, against pricing.nightlyFrom). Homes without a synced price are excluded while any price filter is set." }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "name", "collection", "capacity", "media", "amenityHighlights", "links", "publication", "capabilities" ], "properties": { "resourceType": { "enum": [ "bookable_product" ] }, "type": { "enum": [ "vacation_rental" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "tagline": { "type": "string" }, "shortSummary": { "type": "string" }, "propertyType": { "type": "string" }, "collection": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "capacity": { "type": "object", "additionalProperties": false, "required": [ "bedrooms", "bathrooms", "maxGuests" ], "properties": { "bedrooms": { "type": [ "null", "integer" ] }, "bathrooms": { "type": [ "null", "number" ] }, "maxGuests": { "type": [ "null", "integer" ] } } }, "location": { "type": "object", "additionalProperties": false, "required": [ "locality", "region", "postalCode", "country", "geo" ], "properties": { "locality": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "geo": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "latitude", "longitude", "precision" ], "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "precision": { "enum": [ "approximate" ] } } } ] } } }, "media": { "type": "object", "additionalProperties": false, "required": [ "cardImages" ], "properties": { "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, "cardImages": { "type": "array", "maxItems": 5, "items": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } } } } }, "amenityHighlights": { "type": "array", "maxItems": 12, "items": { "type": "string" } }, "pricing": { "type": "object", "additionalProperties": false, "required": [ "nightlyFrom" ], "properties": { "nightlyFrom": { "type": "object", "additionalProperties": false, "required": [ "amountMinor", "currency", "horizonDays" ], "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string" }, "horizonDays": { "type": "integer" } } } } }, "links": { "type": "object", "additionalProperties": false, "required": [ "self" ], "properties": { "self": { "type": "string" } } }, "publication": { "type": "object", "additionalProperties": false, "required": [ "publishedAt", "updatedAt" ], "properties": { "publishedAt": { "type": [ "null", "string" ], "format": "date-time" }, "visibility": { "type": "string", "enum": [ "published", "staging" ] }, "stagingExpiresAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "capabilities": { "type": "array", "items": { "type": "string" } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "example": { "data": [ { "resourceType": "bookable_product", "type": "vacation_rental", "id": "22222222-2222-4222-8222-222222222222", "slug": "sandbox-chalet", "name": "Sandbox Chalet", "tagline": "A cozy evaluation chalet", "collection": { "id": "11111111-1111-4111-8111-111111111111", "slug": "sandbox-stays", "name": "Sandbox Stays" }, "capacity": { "bedrooms": 3, "bathrooms": 2, "maxGuests": 8 }, "location": { "locality": "Dover", "region": "VT", "postalCode": "05356", "country": "US", "geo": { "latitude": 42.94, "longitude": -72.87, "precision": "approximate" } }, "media": { "hero": { "url": "https://cdn.kismet.travel/sandbox/chalet-hero.jpg", "alt": "Chalet exterior" }, "cardImages": [ { "url": "https://cdn.kismet.travel/sandbox/chalet-hero.jpg", "alt": "Chalet exterior" }, { "url": "https://cdn.kismet.travel/sandbox/chalet-living.jpg" }, { "url": "https://cdn.kismet.travel/sandbox/chalet-deck.jpg" } ] }, "amenityHighlights": [ "Hot tub", "EV charger" ], "links": { "self": "/v1/developer/vacation-rentals/22222222-2222-4222-8222-222222222222" }, "publication": { "publishedAt": "2026-06-15T00:00:00.000Z", "updatedAt": "2026-07-01T00:00:00.000Z" }, "capabilities": [ "vacation_rentals.read" ], "pricing": { "nightlyFrom": { "amountMinor": 16500, "currency": "USD", "horizonDays": 90 } } } ], "page": { "limit": 20, "nextCursor": null } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "vacation_rentals.read" } }, "/v1/developer/vacation-rentals/{vacationRental}": { "get": { "operationId": "getVacationRental", "summary": "Get a published vacation rental", "tags": [ "developer-published-resources" ], "description": "Returns the bounded published detail projection within the authenticated application grant: description, gallery (max 12), spaces (max 60, each with its public-safe photos and host-verified `imagesVerified` flag), nearby attractions, and effective pet policy. A nearby attraction resolved to a place additionally carries exact `geo` coordinates and its Google `placeId` for map pins; an unresolved one carries neither. `goodFor` lists up to 6 ranked labels from the fixed Kismet Good-for list (families, groups, couples, remote-work, pets, ski-trips, beach-days, lake-days, hot-tub-nights, accessible, events), each with the concrete listing evidence that earned it in `reasons`; a label never appears without evidence. When the credential also holds `rates.read`, the response additively carries `pricing.nightlyFrom` — an indicative synced floor over the coming window, never a bookable quote. TEST view=staging also reads only explicitly approved rooms under both active preview grants, with null publishedAt and explicit staging visibility/expiry. Pricing is withheld for staging-only rooms. No availability search, quotes, booking URLs, or vendor payloads.", "parameters": [ { "schema": { "type": "string", "enum": [ "published", "staging" ], "default": "published" }, "in": "query", "name": "view", "required": false, "description": "TEST-only opt-in to explicitly approved, unexpired staging catalog and room reads. Omit for published inventory. Does not authorize pricing, booking, or publication." }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "vacationRental", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "name", "collection", "capacity", "media", "amenityHighlights", "links", "publication", "capabilities", "description", "spaces", "nearbyAttractions", "policies" ], "properties": { "resourceType": { "enum": [ "bookable_product" ] }, "type": { "enum": [ "vacation_rental" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "tagline": { "type": "string" }, "shortSummary": { "type": "string" }, "propertyType": { "type": "string" }, "collection": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "capacity": { "type": "object", "additionalProperties": false, "required": [ "bedrooms", "bathrooms", "maxGuests" ], "properties": { "bedrooms": { "type": [ "null", "integer" ] }, "bathrooms": { "type": [ "null", "number" ] }, "maxGuests": { "type": [ "null", "integer" ] } } }, "location": { "type": "object", "additionalProperties": false, "required": [ "locality", "region", "postalCode", "country", "geo" ], "properties": { "locality": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "geo": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "latitude", "longitude", "precision" ], "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "precision": { "enum": [ "approximate" ] } } } ] } } }, "media": { "type": "object", "additionalProperties": false, "required": [ "cardImages", "gallery" ], "properties": { "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, "cardImages": { "type": "array", "maxItems": 5, "items": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } } }, "gallery": { "type": "array", "maxItems": 12, "items": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } } } } }, "amenityHighlights": { "type": "array", "maxItems": 12, "items": { "type": "string" } }, "pricing": { "type": "object", "additionalProperties": false, "required": [ "nightlyFrom" ], "properties": { "nightlyFrom": { "type": "object", "additionalProperties": false, "required": [ "amountMinor", "currency", "horizonDays" ], "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string" }, "horizonDays": { "type": "integer" } } } } }, "links": { "type": "object", "additionalProperties": false, "required": [ "self" ], "properties": { "self": { "type": "string" } } }, "publication": { "type": "object", "additionalProperties": false, "required": [ "publishedAt", "updatedAt" ], "properties": { "publishedAt": { "type": [ "null", "string" ], "format": "date-time" }, "visibility": { "type": "string", "enum": [ "published", "staging" ] }, "stagingExpiresAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "capabilities": { "type": "array", "items": { "type": "string" } }, "description": { "type": "object", "additionalProperties": false, "properties": { "short": { "type": "string" }, "long": { "type": "string" }, "hostNotes": { "type": "string" }, "neighborhood": { "type": "string" } } }, "spaces": { "type": "array", "maxItems": 60, "items": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "spaceType": { "type": "string" }, "description": { "type": "string" }, "cover": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, "images": { "type": "array", "maxItems": 30, "items": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" }, "alt": { "type": "string" }, "caption": { "type": "string" } } } }, "imagesVerified": { "type": "boolean" }, "beds": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "type", "count" ], "properties": { "type": { "type": "string" }, "count": { "type": "integer", "minimum": 1 } } } }, "bedSummary": { "type": "string" } } } }, "nearbyAttractions": { "type": "array", "maxItems": 40, "description": "Up to 40 stored public place associations in source order. Blank names are omitted before this bound; unresolved or invalid coordinates are omitted without dropping the place name.", "items": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "distance": { "type": "string" }, "geo": { "type": "object", "additionalProperties": false, "required": [ "latitude", "longitude" ], "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } } }, "placeId": { "type": "string" } } } }, "policies": { "type": "object", "additionalProperties": false, "required": [ "petsAllowed" ], "properties": { "petsAllowed": { "type": "boolean" } } }, "goodFor": { "type": "array", "maxItems": 6, "items": { "type": "object", "additionalProperties": false, "required": [ "key", "label", "reasons" ], "properties": { "key": { "type": "string", "enum": [ "families", "groups", "couples", "remote-work", "pets", "ski-trips", "beach-days", "lake-days", "hot-tub-nights", "accessible", "events" ] }, "label": { "type": "string" }, "reasons": { "type": "array", "minItems": 1, "maxItems": 4, "items": { "type": "string" } } } } }, "enrichment": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "slug", "version", "name", "defaultLocale", "values" ], "properties": { "slug": { "type": "string" }, "version": { "type": "integer" }, "name": { "type": "string" }, "defaultLocale": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "key", "labels", "value", "curated" ], "properties": { "key": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "value": {}, "locale": { "type": "string" }, "curated": { "type": "boolean" }, "publishedAt": { "type": "string" }, "relationship": { "type": "string" } } } } } } }, "highlights": { "type": "array", "maxItems": 12, "description": "Manager-editable editorial highlights in saved order. Empty when none are stored; absent on older responses. Separate from amenityHighlights. Read-only delivery; this request does not generate or edit content.", "items": { "type": "object", "additionalProperties": false, "required": [ "title" ], "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string", "description": "Optional icon identifier, not HTML or an asset URL. Use a local allowlist with a text fallback." } } } }, "uniqueSellingPoints": { "type": "array", "maxItems": 12, "items": { "type": "string" }, "description": "Manager-editable short selling points in saved order. Empty when none are stored; absent on older responses. Render as text, not HTML." } } }, "example": { "resourceType": "bookable_product", "type": "vacation_rental", "id": "22222222-2222-4222-8222-222222222222", "slug": "sandbox-chalet", "name": "Sandbox Chalet", "tagline": "A cozy evaluation chalet", "collection": { "id": "11111111-1111-4111-8111-111111111111", "slug": "sandbox-stays", "name": "Sandbox Stays" }, "capacity": { "bedrooms": 3, "bathrooms": 2, "maxGuests": 8 }, "location": { "locality": "Dover", "region": "VT", "postalCode": "05356", "country": "US", "geo": { "latitude": 42.94, "longitude": -72.87, "precision": "approximate" } }, "media": { "hero": { "url": "https://cdn.kismet.travel/sandbox/chalet-hero.jpg", "alt": "Chalet exterior" }, "cardImages": [ { "url": "https://cdn.kismet.travel/sandbox/chalet-hero.jpg", "alt": "Chalet exterior" }, { "url": "https://cdn.kismet.travel/sandbox/chalet-living.jpg" } ], "gallery": [ { "url": "https://cdn.kismet.travel/sandbox/chalet-living.jpg", "alt": "Living room" }, { "url": "https://cdn.kismet.travel/sandbox/chalet-deck.jpg" } ] }, "amenityHighlights": [ "Hot tub", "EV charger" ], "links": { "self": "/v1/developer/vacation-rentals/22222222-2222-4222-8222-222222222222" }, "publication": { "publishedAt": "2026-06-15T00:00:00.000Z", "updatedAt": "2026-07-01T00:00:00.000Z" }, "capabilities": [ "vacation_rentals.read" ], "description": { "short": "A quiet three-bedroom chalet near the trails.", "long": "A longer published description of the chalet and its surroundings.", "neighborhood": "Ten minutes from the village center." }, "spaces": [ { "name": "Primary bedroom", "spaceType": "bedroom", "description": "King bed", "cover": { "url": "https://cdn.kismet.travel/sandbox/chalet-bedroom.jpg", "alt": "Primary bedroom" }, "images": [ { "url": "https://cdn.kismet.travel/sandbox/chalet-bedroom.jpg", "alt": "Primary bedroom" } ], "imagesVerified": true, "beds": [ { "type": "King", "count": 1 } ], "bedSummary": "King" }, { "name": "Bunk room", "spaceType": "bedroom", "beds": [ { "type": "Bunk (Twin/Twin)", "count": 1 }, { "type": "Twin", "count": 2 } ], "bedSummary": "Bunk (Twin/Twin) · 2x Twin" } ], "nearbyAttractions": [ { "name": "River Trail", "type": "trail", "distance": "0.5 mi", "geo": { "latitude": 45.3311, "longitude": -121.7113 }, "placeId": "ChIJ-example-river-trail" }, { "name": "Old Mill Bakery", "type": "restaurant", "distance": "1.2 mi" } ], "policies": { "petsAllowed": true }, "goodFor": [ { "key": "hot-tub-nights", "label": "Hot tub nights", "reasons": [ "hot tub", "fire pit", "mountain views" ] }, { "key": "pets", "label": "Pets", "reasons": [ "pets allowed", "fenced yard" ] }, { "key": "remote-work", "label": "Remote work", "reasons": [ "desk", "Wi-Fi" ] } ], "enrichment": [ { "slug": "local-favorites", "version": 1, "name": "Local favorites", "defaultLocale": "en", "values": [ { "key": "story", "labels": { "en": "The story" }, "value": "Built by hand in 1971 and restored by the current hosts.", "curated": false, "publishedAt": "2026-08-20T00:00:00.000Z", "relationship": "OWNER" } ] } ], "pricing": { "nightlyFrom": { "amountMinor": 24900, "currency": "USD", "horizonDays": 90 } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "vacation_rentals.read" } }, "/v1/developer/vacation-rentals/{vacationRental}/reviews": { "get": { "operationId": "listVacationRentalReviews", "summary": "List published reviews for a vacation rental", "tags": [ "developer-published-resources" ], "description": "Returns published, non-transactional Kismet content within the authenticated application grant. No rates, availability, indicative pricing, booking URL, draft state, or vendor payload is returned.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "vacationRental", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "channel", "overallRating", "reviewText", "hostResponse", "reviewerDisplayName", "reviewDate", "categoryRatings", "personas", "features", "season" ], "properties": { "id": { "type": "string" }, "channel": { "type": "string" }, "overallRating": { "type": [ "null", "number" ] }, "reviewText": { "type": [ "null", "string" ] }, "hostResponse": { "type": [ "null", "string" ] }, "reviewerDisplayName": { "type": [ "null", "string" ] }, "reviewDate": { "type": [ "null", "string" ], "format": "date-time" }, "categoryRatings": { "type": "object", "additionalProperties": false, "required": [ "cleanliness", "accuracy", "checkin", "communication", "location", "value" ], "properties": { "cleanliness": { "type": [ "null", "number" ] }, "accuracy": { "type": [ "null", "number" ] }, "checkin": { "type": [ "null", "number" ] }, "communication": { "type": [ "null", "number" ] }, "location": { "type": [ "null", "number" ] }, "value": { "type": [ "null", "number" ] } } }, "personas": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "slug", "label", "confidence", "source" ], "properties": { "slug": { "type": "string" }, "label": { "type": "string" }, "confidence": { "type": [ "null", "number" ] }, "source": { "type": "string", "enum": [ "ai", "manual" ] } } } }, "features": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "slug", "label", "confidence", "source" ], "properties": { "slug": { "type": "string" }, "label": { "type": "string" }, "confidence": { "type": [ "null", "number" ] }, "source": { "type": "string", "enum": [ "ai", "manual" ] } } } }, "season": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "season", "source" ], "properties": { "season": { "type": "string" }, "source": { "type": "string", "enum": [ "derived", "ai", "manual" ] } } } ] } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "aggregate" ], "properties": { "aggregate": { "type": "object", "additionalProperties": false, "required": [ "overallRating", "reviewCount" ], "properties": { "overallRating": { "type": [ "null", "number" ] }, "reviewCount": { "type": "integer" } } } } } } }, "example": { "data": [ { "id": "44444444-4444-4444-8444-444444444444", "channel": "airbnb", "overallRating": 5, "reviewText": "Wonderful stay — spotless and quiet.", "hostResponse": "Thank you! Come back any time.", "reviewerDisplayName": "Jamie", "reviewDate": "2026-05-20T00:00:00.000Z", "categoryRatings": { "cleanliness": 5, "accuracy": 5, "checkin": 5, "communication": 5, "location": 4.5, "value": 5 }, "personas": [ { "slug": "family", "label": "Family", "confidence": 0.92, "source": "ai" } ], "features": [ { "slug": "amazing-host", "label": "Amazing host", "confidence": 0.88, "source": "ai" } ], "season": { "season": "spring", "source": "derived" } } ], "page": { "limit": 20, "nextCursor": null }, "meta": { "aggregate": { "overallRating": 4.9, "reviewCount": 24 } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "reviews.read" } }, "/v1/developer/vacation-rentals/{vacationRental}/policies": { "get": { "operationId": "listVacationRentalPolicies", "summary": "List effective policies for a vacation rental", "tags": [ "developer-published-resources" ], "description": "Returns published, non-transactional Kismet content within the authenticated application grant. No rates, availability, indicative pricing, booking URL, draft state, or vendor payload is returned.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "vacationRental", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "policyType", "scope", "title", "url" ], "properties": { "policyType": { "type": "string" }, "scope": { "type": "string", "enum": [ "VR", "VRM", "PMS" ] }, "policyId": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "integer" ] }, "contentHash": { "type": [ "null", "string" ] }, "effectiveAt": { "type": [ "null", "string" ] }, "title": { "type": "string" }, "url": { "type": "string" }, "format": { "type": "string", "enum": [ "html", "text" ] }, "body": { "type": "string" } } } } } }, "example": { "data": [ { "policyType": "PET", "scope": "VR", "policyId": "55555555-5555-4555-8555-555555555555", "version": 2, "contentHash": "c0ffee00c0ffee00c0ffee00c0ffee00c0ffee00c0ffee00c0ffee00c0ffee00", "effectiveAt": "2026-04-01T00:00:00.000Z", "title": "Pet policy", "url": "https://sandbox-stays.example/policies/pet", "format": "html", "body": "

Up to two dogs under 40 lb are welcome for a $75 fee per stay.

" } ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "policies.read" } }, "/v1/developer/vacation-rentals/{vacationRental}/calendar": { "get": { "operationId": "getVacationRentalCalendar", "summary": "Get the synced nightly calendar for a vacation rental", "tags": [ "developer-published-resources" ], "description": "Per-night availability and indicative nightly rates from Kismet's synchronized calendar plane for a bounded date window (max 90 days, today onward). `meta.lastSyncedAt` communicates recency. This is never a bookable quote: totals, fees, taxes, and checkout are out of scope. `nightlyRate` is null when the connected source withholds the rate; a night is bookable only when `available` is true.", "parameters": [ { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "start", "required": true }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "end", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "vacationRental", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "date", "available", "nightlyRate", "checkInAllowed", "checkOutAllowed" ], "properties": { "date": { "type": "string" }, "available": { "type": "boolean" }, "nightlyRate": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "amountMinor", "currency" ], "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string" } } } ] }, "minStay": { "type": "integer" }, "checkInAllowed": { "type": "boolean" }, "checkOutAllowed": { "type": "boolean" } } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "start", "end", "lastSyncedAt" ], "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "lastSyncedAt": { "type": [ "null", "string" ] } } } } }, "example": { "data": [ { "date": "2026-08-01", "available": true, "nightlyRate": { "amountMinor": 18900, "currency": "USD" }, "minStay": 2, "checkInAllowed": true, "checkOutAllowed": true }, { "date": "2026-08-02", "available": false, "nightlyRate": null, "checkInAllowed": false, "checkOutAllowed": true } ], "meta": { "start": "2026-08-01", "end": "2026-08-02", "lastSyncedAt": "2026-07-01T00:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Booking Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "synced-commercial", "x-kismet-maturity": "beta", "x-kismet-required-capability": "rates.read" } }, "/v1/developer/collections/{collection}/groups/availability": { "get": { "operationId": "getGroupAvailability", "summary": "Read building availability and observed stay prices", "tags": [ "developer-published-resources" ], "description": "Canonical building/neighborhood union selection over published collection inventory. Calendar-plane estimates, never chargeable quotes. lowestStay is withheld unless coverage is complete and all prices comparable. Current base-calendar coverage is explicitly partial: lowestObservedStays preserves qualified base estimates without claiming the cheapest supplier rate plan. Missing evidence is unknown, not sold out. A declared host is required; staging links never fall back to production. No request-time supplier fan-out.", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "guests", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 253 }, "in": "query", "name": "host", "required": true }, { "schema": { "type": "string", "enum": [ "building" ] }, "in": "query", "name": "groupType", "required": false }, { "schema": { "type": "array", "maxItems": 100, "items": { "type": "string", "minLength": 1 } }, "in": "query", "name": "groupSlug", "required": false }, { "schema": { "type": "array", "maxItems": 100, "items": { "type": "string", "minLength": 1 } }, "in": "query", "name": "neighborhoodSlug", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "checkIn", "required": true }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "checkOut", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "groupId", "groupSlug", "classification", "availability", "completeness", "lowestStay", "lowestObservedStays", "coverage", "reasons", "retrievedAt", "dataAsOf", "expiresAt", "navigation" ], "properties": { "groupId": { "type": "string" }, "groupSlug": { "type": "string" }, "classification": { "type": "object", "additionalProperties": false, "required": [ "semanticType" ], "properties": { "semanticType": { "type": "string", "enum": [ "UNCLASSIFIED", "BUILDING", "NEIGHBORHOOD" ] } } }, "availability": { "type": "string", "enum": [ "available", "unavailable", "unknown" ] }, "completeness": { "type": "string", "enum": [ "complete", "partial" ] }, "lowestStay": { "anyOf": [ { "type": "object", "additionalProperties": false, "required": [ "productId", "supplier", "roomTypeId", "ratePlanId", "checkIn", "checkOut", "guests", "currency", "totalMinor", "averageNightlyMinor", "nights", "priceBasis", "priceKind", "included", "excluded", "unknownComponents", "dataAsOf", "expiresAt" ], "properties": { "productId": { "type": "string" }, "supplier": { "type": "string" }, "roomTypeId": { "type": [ "null", "string" ] }, "ratePlanId": { "type": [ "null", "string" ] }, "checkIn": { "type": "string" }, "checkOut": { "type": "string" }, "guests": { "type": "integer" }, "currency": { "type": "string" }, "totalMinor": { "type": "integer" }, "averageNightlyMinor": { "type": "integer" }, "nights": { "type": "integer" }, "priceBasis": { "type": "string" }, "priceKind": { "type": "string", "enum": [ "estimate", "quote" ] }, "included": { "type": "array", "items": { "type": "string" } }, "excluded": { "type": "array", "items": { "type": "string" } }, "unknownComponents": { "type": "array", "items": { "type": "string" } }, "dataAsOf": { "type": "string" }, "expiresAt": { "type": "string" } } }, { "type": "null" } ] }, "lowestObservedStays": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "productId", "supplier", "roomTypeId", "ratePlanId", "checkIn", "checkOut", "guests", "currency", "totalMinor", "averageNightlyMinor", "nights", "priceBasis", "priceKind", "included", "excluded", "unknownComponents", "dataAsOf", "expiresAt" ], "properties": { "productId": { "type": "string" }, "supplier": { "type": "string" }, "roomTypeId": { "type": [ "null", "string" ] }, "ratePlanId": { "type": [ "null", "string" ] }, "checkIn": { "type": "string" }, "checkOut": { "type": "string" }, "guests": { "type": "integer" }, "currency": { "type": "string" }, "totalMinor": { "type": "integer" }, "averageNightlyMinor": { "type": "integer" }, "nights": { "type": "integer" }, "priceBasis": { "type": "string" }, "priceKind": { "type": "string", "enum": [ "estimate", "quote" ] }, "included": { "type": "array", "items": { "type": "string" } }, "excluded": { "type": "array", "items": { "type": "string" } }, "unknownComponents": { "type": "array", "items": { "type": "string" } }, "dataAsOf": { "type": "string" }, "expiresAt": { "type": "string" } } } }, "coverage": { "anyOf": [ { "type": "object", "required": [ "members", "available", "unavailable", "unknown", "suppliers" ], "properties": { "members": { "type": "integer", "minimum": 0 }, "available": { "type": "integer", "minimum": 0 }, "unavailable": { "type": "integer", "minimum": 0 }, "unknown": { "type": "integer", "minimum": 0 }, "suppliers": { "type": "array", "items": { "type": "object", "required": [ "supplier", "checked", "complete" ], "properties": { "supplier": { "type": "string" }, "checked": { "type": "integer", "minimum": 0 }, "complete": { "type": "boolean" } } } } } }, { "type": "object", "required": [ "windows", "completeWindows", "byArrival" ], "properties": { "windows": { "type": "integer", "minimum": 0 }, "completeWindows": { "type": "integer", "minimum": 0 }, "byArrival": { "type": "array", "items": { "type": "object", "required": [ "checkIn", "members", "available", "unavailable", "unknown", "suppliers" ], "properties": { "checkIn": { "type": "string" }, "members": { "type": "integer", "minimum": 0 }, "available": { "type": "integer", "minimum": 0 }, "unavailable": { "type": "integer", "minimum": 0 }, "unknown": { "type": "integer", "minimum": 0 }, "suppliers": { "type": "array", "items": { "type": "object", "required": [ "supplier", "checked", "complete" ], "properties": { "supplier": { "type": "string" }, "checked": { "type": "integer", "minimum": 0 }, "complete": { "type": "boolean" } } } } } } } } } ] }, "reasons": { "type": "array", "items": { "type": "string" } }, "retrievedAt": { "type": "string" }, "dataAsOf": { "type": [ "null", "string" ] }, "expiresAt": { "type": "string" }, "arrivalWindow": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "integer" } } }, "stayLength": { "type": "integer" }, "guests": { "type": "integer" }, "navigation": { "type": "object", "required": [ "url", "status" ], "properties": { "url": { "type": [ "null", "string" ] }, "status": { "type": "string", "enum": [ "declared", "unmapped" ] } } } } } }, "meta": { "type": "object", "required": [ "guests", "host", "retrievedAt", "calendarDayTimezone", "priceKind" ], "properties": { "guests": { "type": "integer" }, "host": { "type": "string" }, "retrievedAt": { "type": "string" }, "calendarDayTimezone": { "type": "string" }, "priceKind": { "type": "string" } } } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience + Pricing", "x-kismet-quota-cost": 1, "x-kismet-freshness": "synced-commercial", "x-kismet-maturity": "beta", "x-kismet-required-capability": "rates.read" } }, "/v1/developer/collections/{collection}/groups/from-prices": { "get": { "operationId": "getGroupFromPrices", "summary": "Find observed building stay prices over the next 90 arrival dates", "tags": [ "developer-published-resources" ], "description": "Canonical building/neighborhood union selection over published collection inventory. Calendar-plane estimates, never chargeable quotes. lowestStay is withheld unless coverage is complete and all prices comparable. Current base-calendar coverage is explicitly partial: lowestObservedStays preserves qualified base estimates without claiming the cheapest supplier rate plan. Missing evidence is unknown, not sold out. A declared host is required; staging links never fall back to production. No request-time supplier fan-out.", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "guests", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 253 }, "in": "query", "name": "host", "required": true }, { "schema": { "type": "string", "enum": [ "building" ] }, "in": "query", "name": "groupType", "required": false }, { "schema": { "type": "array", "maxItems": 100, "items": { "type": "string", "minLength": 1 } }, "in": "query", "name": "groupSlug", "required": false }, { "schema": { "type": "array", "maxItems": 100, "items": { "type": "string", "minLength": 1 } }, "in": "query", "name": "neighborhoodSlug", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 90 }, "in": "query", "name": "stayLength", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "groupId", "groupSlug", "classification", "availability", "completeness", "lowestStay", "lowestObservedStays", "coverage", "reasons", "retrievedAt", "dataAsOf", "expiresAt", "navigation" ], "properties": { "groupId": { "type": "string" }, "groupSlug": { "type": "string" }, "classification": { "type": "object", "additionalProperties": false, "required": [ "semanticType" ], "properties": { "semanticType": { "type": "string", "enum": [ "UNCLASSIFIED", "BUILDING", "NEIGHBORHOOD" ] } } }, "availability": { "type": "string", "enum": [ "available", "unavailable", "unknown" ] }, "completeness": { "type": "string", "enum": [ "complete", "partial" ] }, "lowestStay": { "anyOf": [ { "type": "object", "additionalProperties": false, "required": [ "productId", "supplier", "roomTypeId", "ratePlanId", "checkIn", "checkOut", "guests", "currency", "totalMinor", "averageNightlyMinor", "nights", "priceBasis", "priceKind", "included", "excluded", "unknownComponents", "dataAsOf", "expiresAt" ], "properties": { "productId": { "type": "string" }, "supplier": { "type": "string" }, "roomTypeId": { "type": [ "null", "string" ] }, "ratePlanId": { "type": [ "null", "string" ] }, "checkIn": { "type": "string" }, "checkOut": { "type": "string" }, "guests": { "type": "integer" }, "currency": { "type": "string" }, "totalMinor": { "type": "integer" }, "averageNightlyMinor": { "type": "integer" }, "nights": { "type": "integer" }, "priceBasis": { "type": "string" }, "priceKind": { "type": "string", "enum": [ "estimate", "quote" ] }, "included": { "type": "array", "items": { "type": "string" } }, "excluded": { "type": "array", "items": { "type": "string" } }, "unknownComponents": { "type": "array", "items": { "type": "string" } }, "dataAsOf": { "type": "string" }, "expiresAt": { "type": "string" } } }, { "type": "null" } ] }, "lowestObservedStays": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "productId", "supplier", "roomTypeId", "ratePlanId", "checkIn", "checkOut", "guests", "currency", "totalMinor", "averageNightlyMinor", "nights", "priceBasis", "priceKind", "included", "excluded", "unknownComponents", "dataAsOf", "expiresAt" ], "properties": { "productId": { "type": "string" }, "supplier": { "type": "string" }, "roomTypeId": { "type": [ "null", "string" ] }, "ratePlanId": { "type": [ "null", "string" ] }, "checkIn": { "type": "string" }, "checkOut": { "type": "string" }, "guests": { "type": "integer" }, "currency": { "type": "string" }, "totalMinor": { "type": "integer" }, "averageNightlyMinor": { "type": "integer" }, "nights": { "type": "integer" }, "priceBasis": { "type": "string" }, "priceKind": { "type": "string", "enum": [ "estimate", "quote" ] }, "included": { "type": "array", "items": { "type": "string" } }, "excluded": { "type": "array", "items": { "type": "string" } }, "unknownComponents": { "type": "array", "items": { "type": "string" } }, "dataAsOf": { "type": "string" }, "expiresAt": { "type": "string" } } } }, "coverage": { "anyOf": [ { "type": "object", "required": [ "members", "available", "unavailable", "unknown", "suppliers" ], "properties": { "members": { "type": "integer", "minimum": 0 }, "available": { "type": "integer", "minimum": 0 }, "unavailable": { "type": "integer", "minimum": 0 }, "unknown": { "type": "integer", "minimum": 0 }, "suppliers": { "type": "array", "items": { "type": "object", "required": [ "supplier", "checked", "complete" ], "properties": { "supplier": { "type": "string" }, "checked": { "type": "integer", "minimum": 0 }, "complete": { "type": "boolean" } } } } } }, { "type": "object", "required": [ "windows", "completeWindows", "byArrival" ], "properties": { "windows": { "type": "integer", "minimum": 0 }, "completeWindows": { "type": "integer", "minimum": 0 }, "byArrival": { "type": "array", "items": { "type": "object", "required": [ "checkIn", "members", "available", "unavailable", "unknown", "suppliers" ], "properties": { "checkIn": { "type": "string" }, "members": { "type": "integer", "minimum": 0 }, "available": { "type": "integer", "minimum": 0 }, "unavailable": { "type": "integer", "minimum": 0 }, "unknown": { "type": "integer", "minimum": 0 }, "suppliers": { "type": "array", "items": { "type": "object", "required": [ "supplier", "checked", "complete" ], "properties": { "supplier": { "type": "string" }, "checked": { "type": "integer", "minimum": 0 }, "complete": { "type": "boolean" } } } } } } } } } ] }, "reasons": { "type": "array", "items": { "type": "string" } }, "retrievedAt": { "type": "string" }, "dataAsOf": { "type": [ "null", "string" ] }, "expiresAt": { "type": "string" }, "arrivalWindow": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "integer" } } }, "stayLength": { "type": "integer" }, "guests": { "type": "integer" }, "navigation": { "type": "object", "required": [ "url", "status" ], "properties": { "url": { "type": [ "null", "string" ] }, "status": { "type": "string", "enum": [ "declared", "unmapped" ] } } } } } }, "meta": { "type": "object", "required": [ "guests", "host", "retrievedAt", "calendarDayTimezone", "priceKind" ], "properties": { "guests": { "type": "integer" }, "host": { "type": "string" }, "retrievedAt": { "type": "string" }, "calendarDayTimezone": { "type": "string" }, "priceKind": { "type": "string" } } } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience + Pricing", "x-kismet-quota-cost": 1, "x-kismet-freshness": "synced-commercial", "x-kismet-maturity": "beta", "x-kismet-required-capability": "rates.read" } }, "/v1/developer/collections/{collection}/vacation-rentals/availability": { "get": { "operationId": "getCollectionAvailability", "summary": "Summarize stay availability across a collection", "tags": [ "developer-published-resources" ], "description": "One aggregate read answering which published rentals can host a stay, so results pages never download every unit's full calendar. Fit is computed server-side from Kismet's synchronized calendar plane with the same rules Kismet's own booking surfaces enforce: every occupied night open, check-in allowed on arrival, check-out allowed on the departure morning, and the arrival night's minimum stay satisfied. `available` is a tri-state: true (fits every synced rule), false (a synced rule rejects it), null (the synced calendar does not cover the stay — treat as unknown, never as closed; drill into `getVacationRentalCalendar`). Open rows may carry `display` — Kismet's display-pricing convention: required fees folded into the before-tax stay subtotal and divided across nights (\"$X / night + tax\"; taxes are revealed at checkout), computed by the same engine Kismet checkout uses with `guests` applied to per-guest fees. Absent `display` means \"price at the next step\", never zero. This is still not a bookable quote: taxes, payment, and checkout are out of scope.", "parameters": [ { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "checkIn", "required": true }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "checkOut", "required": true }, { "schema": { "type": "integer", "minimum": 1, "maximum": 16, "default": 2 }, "in": "query", "name": "guests", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "group", "required": false, "description": "Optional published bookable-product group id or slug. Availability is evaluated only for live members of that group." }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "available" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "available": { "type": [ "null", "boolean" ] }, "display": { "type": "object", "additionalProperties": false, "required": [ "nightlyMinor", "totalBeforeTaxMinor", "currency" ], "properties": { "nightlyMinor": { "type": "integer" }, "totalBeforeTaxMinor": { "type": "integer" }, "currency": { "type": "string" } } } } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "checkIn", "checkOut", "nights", "guests", "propertiesChecked", "openCount", "lastSyncedAt" ], "properties": { "checkIn": { "type": "string" }, "checkOut": { "type": "string" }, "nights": { "type": "integer" }, "guests": { "type": "integer" }, "propertiesChecked": { "type": "integer" }, "openCount": { "type": "integer" }, "lastSyncedAt": { "type": [ "null", "string" ] } } } } }, "example": { "data": [ { "id": "22222222-2222-4222-8222-222222222222", "slug": "sandbox-chalet", "available": true, "display": { "nightlyMinor": 30000, "totalBeforeTaxMinor": 90000, "currency": "USD" } }, { "id": "33333333-3333-4333-8333-333333333333", "slug": "sandbox-bungalow", "available": false }, { "id": "44444444-4444-4444-8444-444444444444", "slug": "sandbox-cottage", "available": null } ], "meta": { "checkIn": "2026-08-01", "checkOut": "2026-08-04", "nights": 3, "guests": 2, "propertiesChecked": 3, "openCount": 1, "lastSyncedAt": "2026-07-01T00:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Booking Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "synced-commercial", "x-kismet-maturity": "beta", "x-kismet-required-capability": "rates.read" } }, "/v1/developer/collections/{collection}/search": { "post": { "operationId": "searchBookableProducts", "summary": "Search published bookable products with natural language", "tags": [ "Search" ], "description": "Runs a collection-scoped semantic search over published bookable products. Results are ranked discovery candidates, not availability claims, stay quotes, or booking offers. The first release keeps the evidence gate off so each request consumes one bounded quota unit. Optional checkIn, checkOut and guests come from your own form and override what the query text implies; with dates, each hit carries the full before-tax stay price next to its 90-day nightlyFrom: accommodation, cleaning and required fees folded in and divided across nights, the same display convention as getCollectionAvailability and checkout, so a card never shows a number the guest will not see at the next step. Taxes are revealed at checkout. Price is never a quote; use the quote operations to charge. Asks reach the guest journey: send the guest session (an X-Kismet-Guest-Token bearer for a signed-in guest, or guestSessionId, the kid_ session id the browser client holds) and the ask is recorded on that journey and the collection pipeline, exactly like an ask from the drop-in loader, with its own nl_ask event so the journey shows each call separately. TEST installations record sandbox asks that appear only in developer mode; a TEST ask on a session with live activity is refused (capture.reason environment_mismatch), so test traffic never lands on a real guest. No session, no write; the search still answers, and capture.reason says why.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "query" ], "properties": { "query": { "type": "string", "minLength": 2, "maxLength": 500 }, "topK": { "type": "integer", "minimum": 1, "maximum": 24, "default": 12 }, "checkIn": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checkOut": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "guests": { "type": "integer", "minimum": 1, "maximum": 100 }, "guestSessionId": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "x-kismet-guest-token", "required": false, "description": "Optional BFF-held guest access token for journey capture. Takes precedence over guestSessionId; an invalid guest token prevents capture without failing discovery." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "query", "intent", "chips", "remainder", "pool", "poolBeforeGraph", "availability", "graphFilters", "graphRelaxed", "reviewSuppressed", "localityRelaxed", "verifiedFits", "candidates", "matchedCount", "capture", "ranked", "meta" ], "properties": { "ok": { "enum": [ true ] }, "capture": { "type": "object", "additionalProperties": false, "required": [ "recorded", "reason" ], "properties": { "recorded": { "type": "boolean" }, "reason": { "type": [ "null", "string" ], "enum": [ "no_guest_session", "invalid_guest_session", "no_active_journey", "environment_mismatch", "capture_failed", null ] } } }, "query": { "type": "string" }, "intent": { "type": "object", "additionalProperties": true }, "chips": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "remainder": { "type": [ "null", "string" ] }, "pool": { "type": "integer" }, "poolBeforeGraph": { "type": "integer" }, "availability": { "type": "object", "additionalProperties": true }, "graphFilters": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "graphRelaxed": { "enum": [ false ] }, "reviewSuppressed": { "type": "integer" }, "localityRelaxed": { "enum": [ false, "region", "dropped" ] }, "verifiedFits": { "type": "integer" }, "candidates": { "type": "integer" }, "matchedCount": { "type": [ "null", "integer" ] }, "note": { "type": "string" }, "ranked": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "product", "score", "reason", "verifiedFeatures", "typeMatch", "matched", "evidence", "price" ], "properties": { "resourceType": { "enum": [ "bookable_product_search_hit" ] }, "type": { "enum": [ "vacation_rental" ] }, "product": { "type": "object", "additionalProperties": false, "required": [ "slug", "name", "heroImageUrl", "servingUrl", "maxGuests", "bedrooms", "bathrooms", "location", "homeCollection" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "heroImageUrl": { "type": [ "null", "string" ] }, "servingUrl": { "type": [ "null", "string" ] }, "maxGuests": { "type": [ "null", "integer" ] }, "bedrooms": { "type": [ "null", "integer" ] }, "bathrooms": { "type": [ "null", "number" ] }, "location": { "type": "object", "additionalProperties": false, "required": [ "locality", "region" ], "properties": { "locality": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] } } }, "homeCollection": { "type": [ "null", "object" ], "additionalProperties": false, "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" } } } } }, "price": { "type": "object", "additionalProperties": false, "required": [ "nightlyFrom", "stay" ], "properties": { "nightlyFrom": { "type": [ "null", "object" ], "additionalProperties": false, "required": [ "amountMinor", "currency", "horizonDays" ], "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string" }, "horizonDays": { "type": "integer" } } }, "stay": { "type": [ "null", "object" ], "additionalProperties": false, "required": [ "checkIn", "checkOut", "nights", "nightlyMinor", "totalBeforeTaxMinor", "currency" ], "properties": { "checkIn": { "type": "string" }, "checkOut": { "type": "string" }, "nights": { "type": "integer" }, "nightlyMinor": { "type": "integer" }, "totalBeforeTaxMinor": { "type": "integer" }, "currency": { "type": "string" } } } } }, "score": { "type": "number" }, "reason": { "type": "string" }, "verifiedFeatures": { "type": "array", "items": { "type": "string" } }, "typeMatch": { "type": "boolean" }, "matched": { "type": [ "null", "boolean" ] }, "evidence": { "type": [ "null", "object" ], "additionalProperties": false, "required": [ "chunkId", "kind", "text", "photoUrl", "galleryIndex", "featureRelevant", "review" ], "properties": { "chunkId": { "type": "string" }, "kind": { "type": "string" }, "text": { "type": "string" }, "photoUrl": { "type": [ "null", "string" ] }, "galleryIndex": { "type": [ "null", "integer" ] }, "featureRelevant": { "type": "boolean" }, "review": { "type": [ "null", "object" ], "additionalProperties": true } } } } } }, "meta": { "type": "object", "additionalProperties": true } } }, "example": { "ok": true, "query": "a quiet beach stay for eight with a pool", "intent": { "checkIn": "2026-10-09", "checkOut": "2026-10-12", "guests": 8 }, "chips": [], "remainder": "quiet beach stay", "pool": 5, "poolBeforeGraph": 12, "availability": { "checked": false, "nights": 0, "poolBeforeAvailability": 5, "unknown": 0 }, "graphFilters": [], "graphRelaxed": false, "reviewSuppressed": 0, "localityRelaxed": false, "verifiedFits": 3, "candidates": 5, "matchedCount": 3, "capture": { "recorded": true, "reason": null }, "ranked": [ { "resourceType": "bookable_product_search_hit", "type": "vacation_rental", "product": { "slug": "sandbox-beach-house", "name": "Sandbox Beach House", "heroImageUrl": "https://cdn.kismet.travel/sandbox/beach-house.jpg", "servingUrl": "https://sandbox-stays.example/stays/sandbox-beach-house", "maxGuests": 8, "bedrooms": 4, "bathrooms": 3, "location": { "locality": "Sandbox Beach", "region": "CA" }, "homeCollection": { "slug": "sandbox-stays", "name": "Sandbox Stays" } }, "price": { "nightlyFrom": { "amountMinor": 42000, "currency": "USD", "horizonDays": 90 }, "stay": { "checkIn": "2026-10-09", "checkOut": "2026-10-12", "nights": 3, "nightlyMinor": 52500, "totalBeforeTaxMinor": 157500, "currency": "USD" } }, "score": 8.7, "reason": "Fits the requested capacity and pool preference.", "verifiedFeatures": [ "pool" ], "typeMatch": true, "matched": true, "evidence": null } ], "meta": { "snapshotMs": 4, "parseMs": 80, "recallMs": 24, "gateMs": 0, "totalMs": 108, "source": "developer-api", "recallLeg": "hybrid", "gateLeg": "off", "gate": { "inputTokens": 0, "outputTokens": 0, "estCostUsd": null } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Search + API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "search.read" } }, "/v1/developer/collections/{collection}/content/types": { "get": { "operationId": "listContentTypes", "summary": "list Content Types", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.read", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" }, "post": { "operationId": "registerContentType", "summary": "register Content Type", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.configure", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/channel": { "get": { "operationId": "getContentChannel", "summary": "get Content Channel", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "parameters": [ { "schema": { "type": "string", "enum": [ "staging", "production" ] }, "in": "query", "name": "channel", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.drafts.read", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "staging", "production" ] }, "origin": { "type": "string", "format": "uri", "maxLength": 255 }, "templates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "name", "origin", "templates" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" }, "put": { "operationId": "configureContentChannel", "summary": "configure Content Channel", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "staging", "production" ] }, "origin": { "type": "string", "format": "uri", "maxLength": 255 }, "templates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "name", "origin", "templates" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.configure", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "staging", "production" ] }, "origin": { "type": "string", "format": "uri", "maxLength": 255 }, "templates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "name", "origin", "templates" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/drafts": { "post": { "operationId": "createContentDraft", "summary": "create Content Draft", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "idempotencyKey": { "type": "string", "minLength": 8, "maxLength": 128 }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "contentType", "template", "path", "fields", "seo", "source" ], "additionalProperties": false } }, "required": [ "key", "idempotencyKey", "document" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.write", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/drafts/{id}": { "get": { "operationId": "getContentDraft", "summary": "get Content Draft", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.drafts.read", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" }, "put": { "operationId": "updateContentDraft", "summary": "update Content Draft", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "exclusiveMinimum": 0 }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "contentType", "template", "path", "fields", "seo", "source" ], "additionalProperties": false } }, "required": [ "expectedRevision", "document" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.write", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/imports/plan": { "post": { "operationId": "planContentImport", "summary": "plan Content Import", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "expectedRevision": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "contentType", "template", "path", "fields", "seo", "source" ], "additionalProperties": false } }, "required": [ "key", "expectedRevision", "document" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.write", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create", "update" ] }, "planDigest": { "type": "string" }, "input": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "expectedRevision": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "contentType", "template", "path", "fields", "seo", "source" ], "additionalProperties": false } }, "required": [ "key", "expectedRevision", "document" ], "additionalProperties": false }, "changes": { "type": "array", "items": { "type": "string" } } }, "required": [ "action", "planDigest", "input", "changes" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/imports/apply": { "post": { "operationId": "applyContentImport", "summary": "apply Content Import", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "expectedRevision": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "contentType", "template", "path", "fields", "seo", "source" ], "additionalProperties": false }, "planDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "idempotencyKey": { "type": "string", "minLength": 8, "maxLength": 128 } }, "required": [ "key", "expectedRevision", "document", "planDigest", "idempotencyKey" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.write", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/drafts/{id}/reviews": { "post": { "operationId": "createContentReview", "summary": "create Content Review", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "exclusiveMinimum": 0 }, "channel": { "type": "string", "enum": [ "staging" ] } }, "required": [ "expectedRevision", "channel" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.write", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "release": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, "previewUrl": { "type": "string", "format": "uri" } }, "required": [ "release", "previewUrl" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/reviews/{id}": { "get": { "operationId": "getContentReview", "summary": "get Content Review", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.drafts.read", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/reviews/{id}/publish": { "post": { "operationId": "publishContentReview", "summary": "publish Content Review", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.publish", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/reviews/{id}/restore": { "post": { "operationId": "restoreContentReview", "summary": "restore Content Review", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "expectedRevision" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.write", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/pages": { "get": { "operationId": "listContentPages", "summary": "list Content Pages", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "parameters": [ { "schema": { "type": "string", "enum": [ "staging", "production" ] }, "in": "query", "name": "channel", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.read", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false } }, "page": { "type": "object", "properties": { "nextCursor": { "type": [ "null", "string" ] } }, "required": [ "nextCursor" ], "additionalProperties": false } }, "required": [ "data", "page" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/pages/resolve": { "get": { "operationId": "resolveContentPage", "summary": "resolve Content Page", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "parameters": [ { "schema": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "in": "query", "name": "path", "required": true }, { "schema": { "type": "string", "enum": [ "staging", "production" ] }, "in": "query", "name": "channel", "required": false }, { "schema": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "in": "query", "name": "preview", "required": false }, { "schema": { "anyOf": [ { "type": "string", "format": "uri", "maxLength": 255 }, { "type": "null" } ] }, "in": "query", "name": "origin", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.read", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "release": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false } }, "required": [ "release", "contentType", "template" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/drafts/{id}/production": { "get": { "operationId": "getContentProductionStatus", "summary": "get Content Production Status", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.drafts.read", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" }, "origin": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0 }, "staging": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, { "type": "null" } ] }, "production": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, { "type": "null" } ] }, "previous": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "documentId", "origin", "version", "staging", "production", "previous" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/reviews/{id}/promote": { "post": { "operationId": "promoteContentReview", "summary": "promote Content Review", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedProductionVersion": { "type": "integer", "minimum": 0 }, "expectedProductionOrigin": { "type": "string", "format": "uri", "maxLength": 255 }, "idempotencyKey": { "type": "string", "minLength": 8, "maxLength": 128 } }, "required": [ "expectedProductionVersion", "expectedProductionOrigin", "idempotencyKey" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.production.publish", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" }, "origin": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0 }, "staging": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, { "type": "null" } ] }, "production": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, { "type": "null" } ] }, "previous": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "documentId", "origin", "version", "staging", "production", "previous" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/content/drafts/{id}/production/rollback": { "post": { "operationId": "rollbackContentProduction", "summary": "rollback Content Production", "tags": [ "developer-content" ], "description": "Typed custom-page content with draft isolation and exact reviewed publication. Production promotion requires an independent grant and the exact staged release. Privileged operations require independent grants. Content channel is separate from booking TEST/LIVE.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedProductionVersion": { "type": "integer", "minimum": 0 }, "expectedProductionOrigin": { "type": "string", "format": "uri", "maxLength": 255 }, "idempotencyKey": { "type": "string", "minLength": 8, "maxLength": 128 } }, "required": [ "expectedProductionVersion", "expectedProductionOrigin", "idempotencyKey" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.production.publish", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" }, "origin": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0 }, "staging": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, { "type": "null" } ] }, "production": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, { "type": "null" } ] }, "previous": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "enum": [ "staging" ] }, "baselineReleaseId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "path": { "type": "string", "maxLength": 255, "pattern": "^\\/(?:[a-z0-9]+(?:[-/][a-z0-9]+)*)?$" }, "fields": { "type": "object", "additionalProperties": {} }, "seo": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "title", "description" ], "additionalProperties": false }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "authored" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "resourceType": { "type": "string", "enum": [ "content" ] }, "type": { "type": "string", "enum": [ "page" ] }, "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "contentType", "template", "path", "fields", "seo", "source", "resourceType", "type", "id", "collectionId", "key", "revision", "updatedAt" ], "additionalProperties": false }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-zA-Z0-9]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "text", "textarea", "prose", "image", "gallery" ] }, "required": { "type": "boolean" }, "maxLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50000 }, { "type": "null" } ] } }, "required": [ "name", "label", "kind", "required" ], "additionalProperties": false }, "minItems": 1, "maxItems": 40 } }, "required": [ "id", "version", "name", "fields" ], "additionalProperties": false }, "template": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 }, "contentType": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "version": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "id", "version" ], "additionalProperties": false }, "pageType": { "type": "string", "enum": [ "ABOUT", "CUSTOM" ] } }, "required": [ "id", "version", "contentType", "pageType" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "channel", "baselineReleaseId", "document", "contentType", "template", "createdAt" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "documentId", "origin", "version", "staging", "production", "previous" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "CMS + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/articles": { "get": { "operationId": "listCollectionArticles", "summary": "List published articles for a manager", "tags": [ "developer-articles" ], "description": "Returns published, Kismet-authored articles for the granted manager: editorial content with a bounded typed block body, author bylines, and a publisher-derived schema.org BlogPosting node builders re-point at their own pages. Draft content is never returned.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "string", "enum": [ "production", "staging" ] }, "in": "query", "name": "channel", "required": false, "description": "Defaults to production. Staging returns only explicitly published import revisions and requires a server key." }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "title", "displayType", "categories", "publication", "links" ], "properties": { "resourceType": { "enum": [ "content" ] }, "type": { "enum": [ "article" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "displayType": { "type": "string" }, "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, "author": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "avatarUrl": { "type": "string" } } }, "categories": { "type": "array", "items": { "type": "string" } }, "publication": { "type": "object", "additionalProperties": false, "required": [ "publishedAt", "updatedAt" ], "properties": { "publishedAt": { "type": "string" }, "sourcePublishedAt": { "type": "string", "format": "date-time" }, "stagedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string" }, "channel": { "enum": [ "staging" ] }, "revisionId": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "minimum": 1 } } }, "links": { "type": "object", "additionalProperties": false, "required": [ "self" ], "properties": { "self": { "type": "string" } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor", "total" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": "integer", "minimum": 0 } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "availableCategories" ], "properties": { "availableCategories": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "data": [ { "resourceType": "content", "type": "article", "id": "33333333-3333-4333-8333-333333333333", "slug": "three-perfect-days-in-sandbox-cove", "title": "Three perfect days in Sandbox Cove", "excerpt": "A long-weekend itinerary built around the tide pools.", "displayType": "default", "hero": { "url": "https://cdn.kismet.travel/sandbox/cove-hero.jpg", "alt": "Tide pools at dusk" }, "author": { "name": "Jamie Sandbox", "title": "General Manager" }, "categories": [ "Travel guides" ], "publication": { "publishedAt": "2026-06-20T00:00:00.000Z", "updatedAt": "2026-07-01T00:00:00.000Z" }, "links": { "self": "/v1/developer/collections/11111111-1111-4111-8111-111111111111/articles/three-perfect-days-in-sandbox-cove" } } ], "page": { "limit": 20, "nextCursor": null } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience + Content", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "articles.read" } }, "/v1/developer/collections/{collection}/articles/{article}": { "get": { "operationId": "getCollectionArticle", "summary": "Get one published article", "tags": [ "developer-articles" ], "description": "Returns published, Kismet-authored articles for the granted manager: editorial content with a bounded typed block body, author bylines, and a publisher-derived schema.org BlogPosting node builders re-point at their own pages. Draft content is never returned.", "parameters": [ { "schema": { "type": "string", "enum": [ "production", "staging" ] }, "in": "query", "name": "channel", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "article", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "type", "id", "slug", "title", "displayType", "categories", "publication", "links", "bodyFormat", "body" ], "properties": { "resourceType": { "enum": [ "content" ] }, "type": { "enum": [ "article" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "displayType": { "type": "string" }, "hero": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, "author": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "avatarUrl": { "type": "string" } } }, "categories": { "type": "array", "items": { "type": "string" } }, "publication": { "type": "object", "additionalProperties": false, "required": [ "publishedAt", "updatedAt" ], "properties": { "publishedAt": { "type": "string" }, "sourcePublishedAt": { "type": "string", "format": "date-time" }, "stagedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string" }, "channel": { "enum": [ "staging" ] }, "revisionId": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "minimum": 1 } } }, "links": { "type": "object", "additionalProperties": false, "required": [ "self" ], "properties": { "self": { "type": "string" } } }, "bodyFormat": { "enum": [ "kismet-blocks@1" ] }, "body": { "type": "array", "items": { "anyOf": [ { "type": "object", "additionalProperties": false, "required": [ "type", "html" ], "properties": { "type": { "enum": [ "prose" ] }, "html": { "type": "string" } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "url" ], "properties": { "type": { "enum": [ "image" ] }, "url": { "type": "string" }, "alt": { "type": "string" }, "caption": { "type": "string" } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "text" ], "properties": { "type": { "enum": [ "pullquote" ] }, "text": { "type": "string" }, "cite": { "type": "string" } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "items" ], "properties": { "type": { "enum": [ "faq" ] }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "q", "a" ], "properties": { "q": { "type": "string" }, "a": { "type": "string" } } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "vacationRentalId", "links" ], "properties": { "type": { "enum": [ "property" ] }, "vacationRentalId": { "type": "string" }, "links": { "type": "object", "additionalProperties": false, "required": [ "vacationRental" ], "properties": { "vacationRental": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "originalType" ], "properties": { "type": { "enum": [ "redacted" ] }, "originalType": { "type": "string" } } } ] } }, "schemaOrg": { "type": "object", "additionalProperties": true }, "relatedArticleIds": { "type": "array", "items": { "type": "string" } }, "featuredVacationRentalIds": { "type": "array", "items": { "type": "string" } } } }, "example": { "resourceType": "content", "type": "article", "id": "33333333-3333-4333-8333-333333333333", "slug": "three-perfect-days-in-sandbox-cove", "title": "Three perfect days in Sandbox Cove", "excerpt": "A long-weekend itinerary built around the tide pools.", "displayType": "default", "hero": { "url": "https://cdn.kismet.travel/sandbox/cove-hero.jpg", "alt": "Tide pools at dusk" }, "author": { "name": "Jamie Sandbox", "title": "General Manager" }, "categories": [ "Travel guides" ], "publication": { "publishedAt": "2026-06-20T00:00:00.000Z", "updatedAt": "2026-07-01T00:00:00.000Z" }, "links": { "self": "/v1/developer/collections/11111111-1111-4111-8111-111111111111/articles/three-perfect-days-in-sandbox-cove" }, "bodyFormat": "kismet-blocks@1", "body": [ { "type": "prose", "html": "

Start at the north jetty before the fog lifts…

" }, { "type": "image", "url": "https://cdn.kismet.travel/sandbox/cove-jetty.jpg", "alt": "North jetty at dawn" }, { "type": "property", "vacationRentalId": "22222222-2222-4222-8222-222222222222", "links": { "vacationRental": "/v1/developer/vacation-rentals/22222222-2222-4222-8222-222222222222" } }, { "type": "redacted", "originalType": "capture" } ], "schemaOrg": { "@context": "https://schema.org", "@type": "BlogPosting", "headline": "Three perfect days in Sandbox Cove", "datePublished": "2026-06-20T00:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience + Content", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "articles.read" } }, "/v1/developer/collections/{collection}/white-label-routes": { "get": { "operationId": "listWhiteLabelRoutes", "summary": "List declared white-label routes for a manager", "tags": [ "developer-white-label-routes" ], "description": "Returns the collection's declared white-label routes: where each property, group, article, collection listing and singleton page lives on the manager's own websites. `isPrimary` marks the canonical page; aliases are returned only with `primary=false`. Only hosts in the key's allowed websites are readable, and a publishable key reads only the host of the page making the request. Link an entity only to its declared route; an entity with no route has no page.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 260 }, "in": "query", "name": "host", "required": false }, { "schema": { "type": "string", "enum": [ "PROPERTY", "PROPERTY_GROUP", "BLOG_POST", "COLLECTION", "GROUP_INDEX", "BLOG_INDEX", "HOMEPAGE", "FAQ", "ABOUT", "CONTACT", "OWNER_LANDING", "CUSTOM" ] }, "in": "query", "name": "pageType", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "query", "name": "vacationRental", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "query", "name": "group", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "query", "name": "article", "required": false }, { "schema": { "type": "boolean", "default": true }, "in": "query", "name": "primary", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "updatedSince", "required": false }, { "schema": { "type": "string", "enum": [ "page-type-asc", "entity-slug-asc", "updated-desc", "serving-url-asc" ], "default": "page-type-asc" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2000 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "type", "pageType", "host", "servingUrl", "path", "isPrimary", "entity", "customSlug", "createdAt", "updatedAt", "links" ], "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "white_label_route" ] }, "pageType": { "type": "string", "enum": [ "PROPERTY", "PROPERTY_GROUP", "BLOG_POST", "COLLECTION", "GROUP_INDEX", "BLOG_INDEX", "HOMEPAGE", "FAQ", "ABOUT", "CONTACT", "OWNER_LANDING", "CUSTOM" ] }, "host": { "type": "string" }, "servingUrl": { "type": "string" }, "path": { "type": "string" }, "isPrimary": { "type": "boolean" }, "entity": { "type": [ "null", "object" ], "additionalProperties": false, "required": [ "type", "id", "slug" ], "properties": { "type": { "type": "string", "enum": [ "vacation_rental", "bookable_product_group", "article", "collection" ] }, "id": { "type": "string" }, "slug": { "type": "string" } } }, "customSlug": { "type": [ "null", "string" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "links": { "type": "object", "additionalProperties": false, "required": [ "self" ], "properties": { "self": { "type": "string" } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "example": { "data": [ { "id": "55555555-5555-4555-8555-555555555555", "type": "white_label_route", "pageType": "PROPERTY", "host": "www.sandbox-stays.example", "servingUrl": "https://www.sandbox-stays.example/rooms/sandbox-chalet/", "path": "/rooms/sandbox-chalet/", "isPrimary": true, "entity": { "type": "vacation_rental", "id": "22222222-2222-4222-8222-222222222222", "slug": "sandbox-chalet" }, "customSlug": null, "createdAt": "2026-06-01T00:00:00.000Z", "updatedAt": "2026-07-01T00:00:00.000Z", "links": { "self": "/v1/developer/white-label-routes/55555555-5555-4555-8555-555555555555" } } ], "page": { "limit": 20, "nextCursor": null } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "preview", "x-kismet-required-capability": "white_label_routes.read" } }, "/v1/developer/white-label-routes/{whiteLabelRoute}": { "get": { "operationId": "getWhiteLabelRoute", "summary": "Get one declared white-label route", "tags": [ "developer-white-label-routes" ], "description": "Returns the collection's declared white-label routes: where each property, group, article, collection listing and singleton page lives on the manager's own websites. `isPrimary` marks the canonical page; aliases are returned only with `primary=false`. Only hosts in the key's allowed websites are readable, and a publishable key reads only the host of the page making the request. Link an entity only to its declared route; an entity with no route has no page.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "whiteLabelRoute", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "id", "type", "pageType", "host", "servingUrl", "path", "isPrimary", "entity", "customSlug", "createdAt", "updatedAt", "links" ], "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "white_label_route" ] }, "pageType": { "type": "string", "enum": [ "PROPERTY", "PROPERTY_GROUP", "BLOG_POST", "COLLECTION", "GROUP_INDEX", "BLOG_INDEX", "HOMEPAGE", "FAQ", "ABOUT", "CONTACT", "OWNER_LANDING", "CUSTOM" ] }, "host": { "type": "string" }, "servingUrl": { "type": "string" }, "path": { "type": "string" }, "isPrimary": { "type": "boolean" }, "entity": { "type": [ "null", "object" ], "additionalProperties": false, "required": [ "type", "id", "slug" ], "properties": { "type": { "type": "string", "enum": [ "vacation_rental", "bookable_product_group", "article", "collection" ] }, "id": { "type": "string" }, "slug": { "type": "string" } } }, "customSlug": { "type": [ "null", "string" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "links": { "type": "object", "additionalProperties": false, "required": [ "self" ], "properties": { "self": { "type": "string" } } } } }, "example": { "id": "66666666-6666-4666-8666-666666666666", "type": "white_label_route", "pageType": "PROPERTY_GROUP", "host": "www.sandbox-stays.example", "servingUrl": "https://www.sandbox-stays.example/groups/waterfront/", "path": "/groups/waterfront/", "isPrimary": true, "entity": { "type": "bookable_product_group", "id": "44444444-4444-4444-8444-444444444444", "slug": "waterfront" }, "customSlug": null, "createdAt": "2026-06-01T00:00:00.000Z", "updatedAt": "2026-07-01T00:00:00.000Z", "links": { "self": "/v1/developer/white-label-routes/66666666-6666-4666-8666-666666666666" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "preview", "x-kismet-required-capability": "white_label_routes.read" } }, "/v1/developer/fixtures": { "get": { "operationId": "listFixtures", "summary": "List fixture manifests", "tags": [ "developer-fixtures" ], "description": "Fixture manifests are global, versioned metadata describing what each fixture renders, the developer operations that satisfy its data requirements, its dashboard-editable settings, and its install targets. Coding agents can inspect fixtures here without reading React implementation files.", "parameters": [ { "schema": { "type": "string", "enum": [ "supported", "preview", "unsupported" ] }, "in": "query", "name": "status", "required": false } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "manifestSchemaVersion", "id", "title", "description", "fixtureVersion", "status", "statusReason", "source", "installMethods", "renderTargets", "requires", "themeTokens", "data", "settings", "enablement" ], "properties": { "manifestSchemaVersion": { "enum": [ 1 ] }, "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "fixtureVersion": { "type": "string" }, "status": { "type": "string", "enum": [ "supported", "preview", "unsupported" ] }, "statusReason": { "type": "string" }, "source": { "type": "object", "additionalProperties": false, "required": [ "package", "contractPath", "propsExport" ], "properties": { "package": { "enum": [ "@kismet-tech/elements" ] }, "contractPath": { "type": "string" }, "propsExport": { "type": [ "null", "string" ] } } }, "installMethods": { "type": "array", "items": { "type": "string", "enum": [ "block", "shortcode", "embedjs", "npm", "iframe" ] } }, "renderTargets": { "type": "array", "items": { "enum": [ "dom" ] } }, "requires": { "type": "array", "items": { "type": "string" } }, "optional": { "type": "array", "items": { "type": "string" } }, "themeTokens": { "type": "array", "items": { "type": "string" } }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "need", "description", "required", "operationId", "capability", "coverage" ], "properties": { "need": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "operationId": { "type": [ "null", "string" ] }, "capability": { "type": [ "null", "string" ] }, "coverage": { "type": "string", "enum": [ "full", "partial", "missing" ] }, "gaps": { "type": "array", "items": { "type": "string" } }, "compatibilityEndpoint": { "type": "string" } } } }, "commercialActions": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "need", "description", "required", "operationId", "coverage" ], "properties": { "need": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "operationId": { "type": "null" }, "coverage": { "enum": [ "missing" ] } } } }, "settings": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "elementType", "configSchemaVersion", "schema", "defaults", "dashboardEditable" ], "properties": { "elementType": { "type": "string", "enum": [ "results_page", "property_detail" ] }, "configSchemaVersion": { "enum": [ 1 ] }, "schema": { "type": "object", "additionalProperties": true }, "defaults": { "type": "object", "additionalProperties": true }, "dashboardEditable": { "enum": [ true ] } } } ] }, "enablement": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "fixtureType", "defaultEnabled" ], "properties": { "fixtureType": { "type": "string" }, "defaultEnabled": { "type": "boolean" } } } ] }, "page": { "type": "object", "additionalProperties": false, "properties": { "pageType": { "type": "string" }, "singleRoute": { "type": "string" } } } } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "total", "registrySchemaVersion" ], "properties": { "total": { "type": "integer" }, "registrySchemaVersion": { "enum": [ 1 ] } } } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Elements + Polymer + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "registry-metadata", "x-kismet-maturity": "beta", "x-kismet-required-capability": "fixtures.read" } }, "/v1/developer/fixtures/{fixture}": { "get": { "operationId": "getFixture", "summary": "Get one fixture manifest", "tags": [ "developer-fixtures" ], "description": "Fixture manifests are global, versioned metadata describing what each fixture renders, the developer operations that satisfy its data requirements, its dashboard-editable settings, and its install targets. Coding agents can inspect fixtures here without reading React implementation files.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "fixture", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "manifestSchemaVersion", "id", "title", "description", "fixtureVersion", "status", "statusReason", "source", "installMethods", "renderTargets", "requires", "themeTokens", "data", "settings", "enablement" ], "properties": { "manifestSchemaVersion": { "enum": [ 1 ] }, "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "fixtureVersion": { "type": "string" }, "status": { "type": "string", "enum": [ "supported", "preview", "unsupported" ] }, "statusReason": { "type": "string" }, "source": { "type": "object", "additionalProperties": false, "required": [ "package", "contractPath", "propsExport" ], "properties": { "package": { "enum": [ "@kismet-tech/elements" ] }, "contractPath": { "type": "string" }, "propsExport": { "type": [ "null", "string" ] } } }, "installMethods": { "type": "array", "items": { "type": "string", "enum": [ "block", "shortcode", "embedjs", "npm", "iframe" ] } }, "renderTargets": { "type": "array", "items": { "enum": [ "dom" ] } }, "requires": { "type": "array", "items": { "type": "string" } }, "optional": { "type": "array", "items": { "type": "string" } }, "themeTokens": { "type": "array", "items": { "type": "string" } }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "need", "description", "required", "operationId", "capability", "coverage" ], "properties": { "need": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "operationId": { "type": [ "null", "string" ] }, "capability": { "type": [ "null", "string" ] }, "coverage": { "type": "string", "enum": [ "full", "partial", "missing" ] }, "gaps": { "type": "array", "items": { "type": "string" } }, "compatibilityEndpoint": { "type": "string" } } } }, "commercialActions": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "need", "description", "required", "operationId", "coverage" ], "properties": { "need": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "operationId": { "type": "null" }, "coverage": { "enum": [ "missing" ] } } } }, "settings": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "elementType", "configSchemaVersion", "schema", "defaults", "dashboardEditable" ], "properties": { "elementType": { "type": "string", "enum": [ "results_page", "property_detail" ] }, "configSchemaVersion": { "enum": [ 1 ] }, "schema": { "type": "object", "additionalProperties": true }, "defaults": { "type": "object", "additionalProperties": true }, "dashboardEditable": { "enum": [ true ] } } } ] }, "enablement": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "fixtureType", "defaultEnabled" ], "properties": { "fixtureType": { "type": "string" }, "defaultEnabled": { "type": "boolean" } } } ] }, "page": { "type": "object", "additionalProperties": false, "properties": { "pageType": { "type": "string" }, "singleRoute": { "type": "string" } } } } }, "example": { "manifestSchemaVersion": 1, "id": "action-bar", "title": "Action bar", "description": "Results-page control strip: grid/map view toggle, saved toggle, mobile filter-drawer trigger.", "fixtureVersion": "0.1.0", "status": "supported", "statusReason": "Props-only fixture with no backend data requirement.", "source": { "package": "@kismet-tech/elements", "contractPath": "packages/elements/src/elements/ActionBar.contract.ts", "propsExport": "ActionBarProps" }, "installMethods": [ "block", "shortcode", "embedjs" ], "renderTargets": [ "dom" ], "requires": [], "themeTokens": [ "accent", "surface", "text", "textMuted", "border" ], "data": [], "settings": null, "enablement": null } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Elements + Polymer + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "registry-metadata", "x-kismet-maturity": "beta", "x-kismet-required-capability": "fixtures.read" } }, "/v1/developer/vacation-rentals/{vacationRental}/booking-requests": { "post": { "operationId": "createVacationRentalBookingRequest", "summary": "Create a sandbox booking request for a vacation rental", "tags": [ "developer-bookings" ], "description": "Create a sandbox booking request to test reservation, guest-account, and tracking behavior without charging a payment method or creating a reservation in the connected booking system. Requires a TEST installation; LIVE credentials receive 409 SANDBOX_ONLY. For production booking and payment, integrate Kismet Checkout separately. Kismet Checkout supports your own payment processor or Stripe and is designed to work with Agent Pay, which lets agents book directly with managers. The Developer Bearer credential authorizes the installation. For a signed-in guest, your same-origin backend also sends X-Kismet-Guest-Token, a validated X-Kismet-CSRF proof, and the kidSid verified during sign-in. The token identifies the guest; optional contact details may update only that same person. Without a guest token, guest contact details are required. Kismet checks the stay against synchronized availability and calculates the price on the server; client-supplied prices are not accepted. Repeating the same installation, rental, dates, and guest email returns the same request and confirmation code. Use Idempotency-Key when creating a deliberate additional request for the same guest and stay. This TEST operation does not record revenue attribution or send advertising conversion events.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "checkIn", "checkOut", "guests" ], "properties": { "checkIn": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "checkOut": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "guests": { "type": "integer", "minimum": 1, "maximum": 99 }, "guest": { "type": "object", "additionalProperties": false, "required": [ "firstName", "lastName", "email" ], "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 100 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 100 }, "email": { "type": "string", "minLength": 3, "maxLength": 254 }, "phone": { "type": [ "string", "null" ], "maxLength": 40 } } }, "kidSid": { "type": [ "string", "null" ], "pattern": "^kid_[A-Za-z0-9]{6,40}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "vacationRental", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "in": "header", "name": "idempotency-key", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-kismet-guest-token", "required": false, "description": "Optional server-only guest access token. When present, the token subject is the booking human and guest contact cannot select another identity." }, { "schema": { "type": "string" }, "in": "header", "name": "x-kismet-csrf", "required": false, "description": "Required with X-Kismet-Guest-Token. Same-origin proof validated by the host BFF." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "requestId", "confirmationCode", "status", "sandbox", "stay", "vacationRental" ], "properties": { "requestId": { "type": "string" }, "confirmationCode": { "type": "string" }, "status": { "type": "string", "enum": [ "received" ] }, "sandbox": { "type": "boolean", "enum": [ true ] }, "stay": { "type": "object", "additionalProperties": false, "required": [ "checkIn", "checkOut", "nights", "guests" ], "properties": { "checkIn": { "type": "string" }, "checkOut": { "type": "string" }, "nights": { "type": "integer" }, "guests": { "type": "integer" } } }, "vacationRental": { "type": "object", "additionalProperties": false, "required": [ "id", "slug" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" } } }, "display": { "type": "object", "additionalProperties": false, "required": [ "nightlyMinor", "totalBeforeTaxMinor", "currency" ], "properties": { "nightlyMinor": { "type": "integer" }, "totalBeforeTaxMinor": { "type": "integer" }, "currency": { "type": "string" } } } } }, "example": { "requestId": "55555555-5555-4555-8555-555555555555", "confirmationCode": "SBX-K7QM2H9", "status": "received", "sandbox": true, "stay": { "checkIn": "2026-08-01", "checkOut": "2026-08-04", "nights": 3, "guests": 2 }, "vacationRental": { "id": "22222222-2222-4222-8222-222222222222", "slug": "sandbox-chalet" }, "display": { "nightlyMinor": 30000, "totalBeforeTaxMinor": 90000, "currency": "USD" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Booking Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "sandbox-write", "x-kismet-maturity": "beta", "x-kismet-required-capability": "bookings.write" } }, "/v1/developer/guest-auth/google/authorizations": { "post": { "operationId": "startDeveloperGuestGoogleAuthorization", "summary": "Start hosted Google guest sign-in", "tags": [ "developer-guest-auth" ], "description": "Starts Google sign-in using Kismet’s registered callback. Requires a server credential with guest_auth.write, an exact authorized HTTPS Origin and a same-origin BFF CSRF proof. The BFF supplies S256 PKCE and state; returnPath stays on that origin. No guest session or marketing consent is created. TEST requires a registered test identity unless an unexpired, manager-enabled real-Google staging participation policy covers this exact verified staging origin.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "returnPath", "kidSid", "state", "codeChallenge" ], "properties": { "returnPath": { "type": "string", "maxLength": 2048 }, "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" }, "state": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{43}$" }, "codeChallenge": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{43}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true }, { "schema": { "type": "string", "format": "uri" }, "in": "header", "name": "origin", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "authorizationUrl", "expiresAt" ], "properties": { "authorizationUrl": { "type": "string", "format": "uri" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "example": { "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth?client_id=example&response_type=code", "expiresAt": "2026-09-27T18:10:00.000Z" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/google/authorizations/redeem": { "post": { "operationId": "redeemDeveloperGuestGoogleAuthorization", "summary": "Complete hosted Google guest sign-in", "tags": [ "developer-guest-auth" ], "description": "Redeems a single-use, 60-second return code using the originating BFF’s PKCE verifier and canonical kidSid. Re-authorizes the installation, environment, origin and guest_auth.write grant. Returns guest session tokens only to the server. TEST requires a registered identity or an unexpired real-Google staging participation policy for this installation and exact verified staging origin. This operation never sends email or enrolls the guest in an offer; deterministic TEST email-code authentication remains restricted.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "code", "codeVerifier", "kidSid" ], "properties": { "code": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{43}$" }, "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" }, "codeVerifier": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{43,128}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true }, { "schema": { "type": "string", "format": "uri" }, "in": "header", "name": "origin", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "kidSid", "guest", "session" ], "properties": { "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" }, "guest": { "type": "object", "required": [ "id", "email", "guestProfileId" ], "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "guestProfileId": { "type": "string" } } }, "session": { "type": "object", "required": [ "accessToken", "refreshToken", "expiresAt" ], "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } } } }, "example": { "kidSid": "kid_AbCdEf12", "guest": { "id": "77777777-7777-4777-8777-777777777777", "email": "developer-test@example.com", "guestProfileId": "88888888-8888-4888-8888-888888888888" }, "session": { "accessToken": "", "refreshToken": "", "expiresAt": "2026-10-27T18:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/wallet/authorizations": { "post": { "operationId": "startDeveloperGuestWalletAuthorization", "summary": "Start a card invitation sign-in", "tags": [ "developer-guest-wallet-requests" ], "description": "BFF-only. Requires guest_auth.write and guest_wallet_requests.write, an exact registered callback and Origin, state and S256 PKCE. Returns a Kismet authorization URL. This does not prove guest identity: the browser must hold Kismet’s HttpOnly invitation grant. No membership, consent or payment is created. Deployment gated beta.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "requestId": { "type": "string", "format": "uuid" }, "callbackUrl": { "type": "string", "maxLength": 2048, "pattern": "^https?://[^\\s]+$" }, "codeChallenge": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "state": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" } }, "required": [ "requestId", "callbackUrl", "codeChallenge", "state", "kidSid" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "pattern": "^https?://[^\\s]+$", "maxLength": 2048 }, "in": "header", "name": "origin", "required": true }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "authorizationUrl": { "type": "string", "maxLength": 2048, "pattern": "^https?://[^\\s]+$" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "authorizationUrl", "expiresAt" ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } } }, "x-kismet-owner": "Guest Experience + Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/wallet/authorizations/redeem": { "post": { "operationId": "redeemDeveloperGuestWalletAuthorization", "summary": "Redeem a card invitation return code", "tags": [ "developer-guest-wallet-requests" ], "description": "BFF-only. Exchanges the single-use 60-second return code with its original S256 verifier and kidSid. Rechecks installation, collection, environment, callback, permissions and the unchanged verified guest. Session tokens belong only in the BFF; never browser storage. TEST requires an explicitly registered test guest.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "codeVerifier": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{43,128}$" }, "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" } }, "required": [ "code", "codeVerifier", "kidSid" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "pattern": "^https?://[^\\s]+$", "maxLength": 2048 }, "in": "header", "name": "origin", "required": true }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" }, "requestId": { "type": "string", "format": "uuid" }, "returnUrl": { "type": "string", "maxLength": 2048, "pattern": "^https?://[^\\s]+$" }, "guest": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "guestProfileId": { "type": "string" } }, "required": [ "id", "email", "guestProfileId" ] }, "session": { "type": "object", "additionalProperties": false, "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "accessToken", "refreshToken", "expiresAt" ] } }, "required": [ "kidSid", "requestId", "returnUrl", "guest", "session" ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ] } } } } }, "x-kismet-owner": "Guest Experience + Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/challenges": { "post": { "operationId": "challengeDeveloperGuestAuth", "summary": "Start branded email verification", "tags": [ "developer-guest-auth" ], "description": "Creates an email OTP challenge bound to this installation, collection, exact Kismet identity anchor (`kidSid`), and an authorized branded host. Requires a server credential and a same-origin BFF CSRF proof. By default, registered TEST recipients receive a deterministic code in the server response and other TEST addresses receive a generic accepted response without delivery. An unexpired manager-enabled real-email-sign-in staging policy instead sends a random single-use code with a [STAGING] subject, never returned by the API. That challenge is bound to the exact verified staging origin; verification rechecks the origin and policy. Signing in does not enroll membership, subscribe to marketing or request an offer email.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "email", "kidSid" ], "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 254 }, "emailLinkMode": { "type": [ "string", "null" ], "enum": [ "portable", null ], "description": "Opt in to cross-browser email verification. Requires emailLinkReturnUrl." }, "emailLinkContinuation": { "type": [ "string", "null" ], "maxLength": 1024, "description": "Opaque application intent retained server-side and returned only after portable verification. Never include credentials or personal data." }, "emailLinkReturnUrl": { "type": [ "string", "null" ], "maxLength": 2048, "description": "Optional HTTPS callback on the exact authorized Origin, without query or fragment. Sends a single-use link instead of an OTP. The token is in the URL fragment; never log it. TEST link delivery requires active real-email-sign-in staging permission. With emailLinkMode=portable, verification may use another browser; otherwise the original identity anchor is required." }, "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet. Never a Kismet credential." }, { "schema": { "type": "string" }, "in": "header", "name": "origin", "required": false, "description": "Original branded browser origin forwarded by the same-origin BFF. Must match Collection.authorizedDomains." }, { "schema": { "type": "string" }, "in": "header", "name": "x-forwarded-host", "required": false, "description": "Original branded host fallback for server route handlers that do not forward Origin. Must match Collection.authorizedDomains." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "accepted", "challengeId", "expiresAt", "branding" ], "properties": { "accepted": { "type": "boolean", "enum": [ true ] }, "challengeId": { "type": "string", "format": "uuid" }, "expiresAt": { "type": "string", "format": "date-time" }, "testVerificationCode": { "type": "string", "pattern": "^\\d{6}$", "description": "TEST only, and only for an address registered on this installation. Never returned in LIVE." }, "branding": { "type": "object", "additionalProperties": false, "required": [ "displayName", "logoUrl", "faviconUrl", "supportEmail", "policyLinks", "accountProvider" ], "properties": { "displayName": { "type": "string" }, "logoUrl": { "type": [ "null", "string" ] }, "faviconUrl": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] }, "policyLinks": { "type": "object", "additionalProperties": false, "required": [ "termsUrl", "privacyUrl" ], "properties": { "termsUrl": { "type": [ "null", "string" ] }, "privacyUrl": { "type": [ "null", "string" ] } } }, "accountProvider": { "type": "string", "enum": [ "Kismet" ] } } } } }, "example": { "accepted": true, "challengeId": "66666666-6666-4666-8666-666666666666", "expiresAt": "2026-08-18T18:05:00.000Z", "testVerificationCode": "042817", "branding": { "displayName": "Sandbox Vacation Rentals", "logoUrl": "https://cdn.kismet.travel/sandbox/logo.svg", "faviconUrl": "https://cdn.kismet.travel/sandbox/favicon.ico", "supportEmail": "support@example.invalid", "policyLinks": { "termsUrl": "https://example.invalid/terms", "privacyUrl": "https://example.invalid/privacy" }, "accountProvider": "Kismet" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "sandbox-write", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/challenges/{challengeId}/verify": { "post": { "operationId": "verifyDeveloperGuestAuth", "summary": "Verify a branded guest authentication challenge", "tags": [ "developer-guest-auth" ], "description": "Consumes a single-use challenge only from an authorized branded host and returns guest session tokens to the host BFF. OTP and legacy links require the original kidSid. Portable links require the exact stored callback and authenticate the destination browser’s canonical kidSid, returning only the original server-retained continuation. Source session identity is not transferred. The BFF must set its own branded HttpOnly cookie; session tokens must never enter browser JavaScript.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "code", "kidSid" ], "properties": { "code": { "type": "string", "pattern": "^(?:\\d{6}|[A-Za-z0-9_-]{43})$" }, "emailLinkReturnUrl": { "type": [ "string", "null" ], "maxLength": 2048, "description": "Exact server-configured callback used to start a portable email link. Never accept this value from browser input." }, "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "challengeId", "required": true }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet. Never a Kismet credential." }, { "schema": { "type": "string" }, "in": "header", "name": "origin", "required": false, "description": "Original branded browser origin forwarded by the same-origin BFF. Must match Collection.authorizedDomains." }, { "schema": { "type": "string" }, "in": "header", "name": "x-forwarded-host", "required": false, "description": "Original branded host fallback for server route handlers that do not forward Origin. Must match Collection.authorizedDomains." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "kidSid", "guest", "session" ], "properties": { "emailLinkContinuation": { "type": "string", "maxLength": 1024, "description": "Original application intent for a successfully consumed portable link. Absent for legacy authentication." }, "kidSid": { "type": "string" }, "guest": { "type": "object", "additionalProperties": false, "required": [ "id", "email", "guestProfileId" ], "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "guestProfileId": { "type": "string" } } }, "session": { "type": "object", "additionalProperties": false, "required": [ "accessToken", "refreshToken", "expiresAt" ], "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "emailLinkAttributionProof": { "type": "string", "maxLength": 256, "description": "Server-only, 15-minute proof for preserving source offer attribution after portable email verification. Keep in the sealed server session; never expose it in browser JSON, URLs or logs. Does not authenticate a guest or grant consent." } } }, "example": { "kidSid": "kid_AbCdEf12", "guest": { "id": "77777777-7777-4777-8777-777777777777", "email": "developer-test@example.com", "guestProfileId": "88888888-8888-4888-8888-888888888888" }, "session": { "accessToken": "", "refreshToken": "", "expiresAt": "2026-09-17T18:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "sandbox-write", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/google/verify": { "post": { "operationId": "verifyDeveloperGuestGoogleAuth", "summary": "Verify Google sign-in for a branded guest", "tags": [ "developer-guest-auth" ], "description": "Exchanges a Google authorization code with PKCE and nonce verification on an explicitly configured installation callback, resolves the canonical guest, and returns tokens only to the host BFF. Requires a server credential, CSRF proof and authorized branded origin. TEST and LIVE callbacks are configured separately; unsupported installations fail closed.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "code", "codeVerifier", "nonce", "kidSid" ], "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 4096 }, "codeVerifier": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{43,128}$" }, "nonce": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{43}$" }, "kidSid": { "type": "string", "pattern": "^kid_[A-Za-z0-9]{8}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet. Never a Kismet credential." }, { "schema": { "type": "string" }, "in": "header", "name": "origin", "required": false, "description": "Original branded browser origin forwarded by the same-origin BFF. Must match Collection.authorizedDomains." }, { "schema": { "type": "string" }, "in": "header", "name": "x-forwarded-host", "required": false, "description": "Original branded host fallback for server route handlers that do not forward Origin. Must match Collection.authorizedDomains." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "kidSid", "guest", "session" ], "properties": { "kidSid": { "type": "string" }, "guest": { "type": "object", "additionalProperties": false, "required": [ "id", "email", "guestProfileId" ], "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "guestProfileId": { "type": "string" } } }, "session": { "type": "object", "additionalProperties": false, "required": [ "accessToken", "refreshToken", "expiresAt" ], "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } } } }, "example": { "kidSid": "kid_AbCdEf12", "guest": { "id": "77777777-7777-4777-8777-777777777777", "email": "developer-test@example.com", "guestProfileId": "88888888-8888-4888-8888-888888888888" }, "session": { "accessToken": "", "refreshToken": "", "expiresAt": "2026-09-17T18:00:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "sandbox-write", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/session/refresh": { "post": { "operationId": "refreshDeveloperGuestSession", "summary": "Refresh a branded guest session", "tags": [ "developer-guest-auth" ], "description": "Exchanges a BFF-held Kismet refresh token for a new short-lived guest access token after re-authorizing the Developer installation, same-origin CSRF proof, and branded host. The refresh token remains server-side and is not rotated in this contract version.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "refreshToken" ], "properties": { "refreshToken": { "type": "string", "minLength": 1, "maxLength": 4096 } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet. Never a Kismet credential." }, { "schema": { "type": "string" }, "in": "header", "name": "origin", "required": false, "description": "Original branded browser origin forwarded by the same-origin BFF. Must match Collection.authorizedDomains." }, { "schema": { "type": "string" }, "in": "header", "name": "x-forwarded-host", "required": false, "description": "Original branded host fallback for server route handlers that do not forward Origin. Must match Collection.authorizedDomains." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "session" ], "properties": { "session": { "type": "object", "additionalProperties": false, "required": [ "accessToken", "expiresAt" ], "properties": { "accessToken": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } } } }, "example": { "session": { "accessToken": "", "expiresAt": "2026-08-18T18:15:00.000Z" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest-auth/session/logout": { "post": { "operationId": "logoutDeveloperGuestSession", "summary": "Log out a branded guest session", "tags": [ "developer-guest-auth" ], "description": "Idempotently revokes the BFF-held Kismet refresh token after re-authorizing the Developer installation, same-origin CSRF proof, and branded host. The public response is identical when the session is already absent, expired, or revoked so callers can always clear their sealed same-origin cookie.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "refreshToken" ], "properties": { "refreshToken": { "type": "string", "minLength": 1, "maxLength": 4096 } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet. Never a Kismet credential." }, { "schema": { "type": "string" }, "in": "header", "name": "origin", "required": false, "description": "Original branded browser origin forwarded by the same-origin BFF. Must match Collection.authorizedDomains." }, { "schema": { "type": "string" }, "in": "header", "name": "x-forwarded-host", "required": false, "description": "Original branded host fallback for server route handlers that do not forward Origin. Must match Collection.authorizedDomains." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "success" ], "properties": { "success": { "type": "boolean", "enum": [ true ] } } }, "example": { "success": true } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/credential": { "get": { "operationId": "getDeveloperCredential", "summary": "Read the collection and environment this key belongs to", "tags": [ "developer-credential" ], "description": "Returns the presenting key's collection (id, slug, name), its TEST/LIVE environment, and the capabilities it grants. Use the slug in /v1/developer/collections/{collection} routes.", "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "resourceType", "collection", "environment", "capabilities" ], "properties": { "resourceType": { "type": "string", "enum": [ "credential" ] }, "collection": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "capabilities": { "type": "array", "items": { "type": "string" } } } }, "example": { "resourceType": "credential", "collection": { "id": "22222222-2222-4222-8222-222222222222", "slug": "coastal-reference-rentals", "name": "Coastal Reference Rentals" }, "environment": "TEST", "capabilities": [ "collections.read", "vacation_rentals.read" ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "collections.read" } }, "/v1/developer/guest/me/contact": { "post": { "operationId": "updateDeveloperGuestContact", "summary": "Edit the authenticated guest contact information", "tags": [ "developer-guest-account" ], "description": "LIVE identities only. Email replacement requires codes to both the existing verified email and the new email. Guest selection comes exclusively from the authenticated guest token. TEST requests fail closed because identities are shared.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "firstName", "lastName", "phone" ], "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 100 }, "lastName": { "type": "string", "maxLength": 100 }, "phone": { "type": [ "string", "null" ], "maxLength": 16, "pattern": "^\\+[1-9]\\d{1,14}$", "description": "Valid international phone in E.164 format (+ and country code, digits only), or null to clear. Normalize local input with an explicit country before sending. Extensions are not supported. This does not verify phone ownership." } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "challengeId": { "type": "string", "format": "uuid" }, "stage": { "type": "string", "enum": [ "current", "new", "complete" ] }, "expiresAt": { "type": "string", "format": "date-time" }, "identity": { "type": "object", "additionalProperties": false, "required": [ "id", "guestProfileId", "email", "phone", "firstName", "lastName", "displayName", "avatarUrl", "emailVerified", "phoneVerified" ], "properties": { "id": { "type": "string" }, "guestProfileId": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "avatarUrl": { "type": [ "null", "string" ] }, "emailVerified": { "type": "boolean" }, "phoneVerified": { "type": "boolean" } } } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/me/email-change": { "post": { "operationId": "startDeveloperGuestEmailChange", "summary": "Edit the authenticated guest contact information", "tags": [ "developer-guest-account" ], "description": "LIVE identities only. Email replacement requires codes to both the existing verified email and the new email. Guest selection comes exclusively from the authenticated guest token. TEST requests fail closed because identities are shared.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "maxLength": 254 } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "challengeId": { "type": "string", "format": "uuid" }, "stage": { "type": "string", "enum": [ "current", "new", "complete" ] }, "expiresAt": { "type": "string", "format": "date-time" }, "identity": { "type": "object", "additionalProperties": false, "required": [ "id", "guestProfileId", "email", "phone", "firstName", "lastName", "displayName", "avatarUrl", "emailVerified", "phoneVerified" ], "properties": { "id": { "type": "string" }, "guestProfileId": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "avatarUrl": { "type": [ "null", "string" ] }, "emailVerified": { "type": "boolean" }, "phoneVerified": { "type": "boolean" } } } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/me/email-change/verify": { "post": { "operationId": "verifyDeveloperGuestEmailChange", "summary": "Edit the authenticated guest contact information", "tags": [ "developer-guest-account" ], "description": "LIVE identities only. Email replacement requires codes to both the existing verified email and the new email. Guest selection comes exclusively from the authenticated guest token. TEST requests fail closed because identities are shared.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "challengeId", "code" ], "properties": { "challengeId": { "type": "string", "format": "uuid" }, "code": { "type": "string", "pattern": "^\\d{6}$" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "challengeId": { "type": "string", "format": "uuid" }, "stage": { "type": "string", "enum": [ "current", "new", "complete" ] }, "expiresAt": { "type": "string", "format": "date-time" }, "identity": { "type": "object", "additionalProperties": false, "required": [ "id", "guestProfileId", "email", "phone", "firstName", "lastName", "displayName", "avatarUrl", "emailVerified", "phoneVerified" ], "properties": { "id": { "type": "string" }, "guestProfileId": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "avatarUrl": { "type": [ "null", "string" ] }, "emailVerified": { "type": "boolean" }, "phoneVerified": { "type": "boolean" } } } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/me": { "get": { "operationId": "getDeveloperGuestSelf", "summary": "Read the signed-in guest account for this installation", "tags": [ "developer-guest-account" ], "description": "Returns self identity plus memberships, bookings, saves, and canonical payment-on-file state filtered to this installation collection. TEST returns sandbox bookings and personal partner benefits only; LIVE excludes sandbox rows. membershipProgram contains the advertised benefit catalog, not guest eligibility. Personal benefits do not require membership. An active, unexpired award includes redemption.code and redemption.expiresAt only for the authenticated guest with a verified email; otherwise redemption is null. Capture with an email does not authenticate its owner: sign in with that same verified email to read saved offers. Keep codes out of logs, analytics, URLs and public HTML. Other personal perk types are not yet projected.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "bookingCursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "bookingLimit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "saveCursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "saveLimit", "required": false }, { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "identity", "memberships", "bookings", "saves", "hasPaymentOnFile" ], "properties": { "identity": { "type": "object", "additionalProperties": false, "required": [ "id", "guestProfileId", "email", "phone", "firstName", "lastName", "displayName", "avatarUrl", "emailVerified", "phoneVerified" ], "properties": { "id": { "type": "string" }, "guestProfileId": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "avatarUrl": { "type": [ "null", "string" ] }, "emailVerified": { "type": "boolean" }, "phoneVerified": { "type": "boolean" } } }, "memberships": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "collection", "status", "tier", "joinedAt" ], "properties": { "collection": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "status": { "type": "string", "enum": [ "ACTIVE", "CANCELED" ] }, "tier": { "type": [ "null", "string" ] }, "joinedAt": { "type": "string", "format": "date-time" } } } }, "bookings": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "confirmationCode", "status", "isSandbox", "checkIn", "checkOut", "nights", "guests", "currency", "totalPaidMinor", "balanceDueMinor", "vacationRental" ], "properties": { "id": { "type": "string" }, "confirmationCode": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "isSandbox": { "type": "boolean" }, "checkIn": { "type": "string", "format": "date-time" }, "checkOut": { "type": "string", "format": "date-time" }, "nights": { "type": "integer" }, "guests": { "type": [ "null", "integer" ] }, "currency": { "type": "string" }, "totalPaidMinor": { "type": [ "null", "integer" ] }, "balanceDueMinor": { "type": [ "null", "integer" ] }, "vacationRental": { "type": "object", "additionalProperties": false, "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "saves": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "savedAt", "checkIn", "checkOut", "vacationRental" ], "properties": { "id": { "type": "string" }, "savedAt": { "type": "string", "format": "date-time" }, "checkIn": { "type": [ "null", "string" ], "format": "date-time" }, "checkOut": { "type": [ "null", "string" ], "format": "date-time" }, "quote": { "type": [ "null", "object" ], "additionalProperties": false, "required": [ "totalMinor", "currency", "quotedAt", "expiresAt" ], "properties": { "totalMinor": { "type": "integer" }, "currency": { "type": "string" }, "quotedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "vacationRental": { "type": "object", "additionalProperties": false, "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "imageUrl": { "type": [ "null", "string" ] } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "hasPaymentOnFile": { "type": "boolean" }, "benefits": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "perkId", "name", "headline", "promise", "provider", "state", "awardedAt", "redeemBy", "deliveredVia", "redemption" ], "properties": { "perkId": { "type": "string" }, "name": { "type": "string" }, "headline": { "type": "string" }, "promise": { "type": "string" }, "provider": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "awarded", "redeemed", "expired", "revoked", "failed" ] }, "awardedAt": { "type": [ "null", "string" ] }, "redeemBy": { "type": [ "null", "string" ] }, "deliveredVia": { "type": [ "null", "string" ], "enum": [ "email", null ] }, "redemption": { "type": [ "null", "object" ], "additionalProperties": false, "required": [ "code", "expiresAt" ], "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 512 }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "membershipProgram": { "type": [ "null", "object" ], "additionalProperties": false, "description": "Collection-wide advertised benefits, not personal entitlements. Null means unavailable. Membership and offer conditions still apply; reading never joins or awards.", "required": [ "programEnabled", "collectionId", "benefits", "partnerBenefits" ], "properties": { "programEnabled": { "type": "boolean" }, "collectionId": { "type": "string" }, "benefits": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "description", "items" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "label" ], "properties": { "label": { "type": "string" }, "description": { "type": [ "null", "string" ] } } } } } } }, "partnerBenefits": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "headline", "promise", "provider", "awardWhen" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "headline": { "type": "string" }, "promise": { "type": "string" }, "provider": { "type": "string" }, "awardWhen": { "type": "string" } } } } } } } }, "example": { "identity": { "id": "77777777-7777-4777-8777-777777777777", "guestProfileId": "88888888-8888-4888-8888-888888888888", "email": "developer-test@example.com", "phone": null, "firstName": "Taylor", "lastName": "Guest", "displayName": "Taylor Guest", "avatarUrl": null, "emailVerified": true, "phoneVerified": false }, "memberships": [], "bookings": { "data": [], "page": { "limit": 20, "nextCursor": null } }, "saves": { "data": [], "page": { "limit": 20, "nextCursor": null } }, "hasPaymentOnFile": false, "benefits": [] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/me/saves": { "get": { "operationId": "listDeveloperGuestSaves", "summary": "List the signed-in guest saved vacation rentals", "tags": [ "developer-guest-account" ], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "savedAt", "checkIn", "checkOut", "vacationRental" ], "properties": { "id": { "type": "string" }, "savedAt": { "type": "string", "format": "date-time" }, "checkIn": { "type": [ "null", "string" ], "format": "date-time" }, "checkOut": { "type": [ "null", "string" ], "format": "date-time" }, "quote": { "type": [ "null", "object" ], "additionalProperties": false, "required": [ "totalMinor", "currency", "quotedAt", "expiresAt" ], "properties": { "totalMinor": { "type": "integer" }, "currency": { "type": "string" }, "quotedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "vacationRental": { "type": "object", "additionalProperties": false, "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "imageUrl": { "type": [ "null", "string" ] } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "limit", "nextCursor" ], "properties": { "limit": { "type": "integer" }, "nextCursor": { "type": [ "null", "string" ] } } } } }, "example": { "data": [], "page": { "limit": 20, "nextCursor": null } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/me/saves/{vacationRentalSlug}": { "put": { "operationId": "saveDeveloperGuestVacationRental", "summary": "Save a vacation rental for the signed-in guest", "tags": [ "developer-guest-account" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "vacationRentalSlug", "required": true }, { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "saved", "vacationRentalSlug" ], "properties": { "saved": { "type": "boolean" }, "vacationRentalSlug": { "type": "string" } } }, "example": { "saved": true, "vacationRentalSlug": "sandbox-chalet" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" }, "delete": { "operationId": "unsaveDeveloperGuestVacationRental", "summary": "Remove a vacation rental from the signed-in guest saves", "tags": [ "developer-guest-account" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "vacationRentalSlug", "required": true }, { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "saved", "vacationRentalSlug" ], "properties": { "saved": { "type": "boolean" }, "vacationRentalSlug": { "type": "string" } } }, "example": { "saved": false, "vacationRentalSlug": "sandbox-chalet" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Identity + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/me/wallet": { "get": { "operationId": "listDeveloperGuestWallet", "summary": "List the signed-in guest's saved cards", "tags": [ "developer-guest-account" ], "description": "The guest's Kismet wallet: cards saved for future charges across the Kismet network, one wallet per guest. LIVE returns the chargeable cards. TEST returns the cards captured by this sandbox in Stripe test mode, never the live wallet.", "parameters": [ { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "livemode", "hasPaymentOnFile", "paymentMethods" ], "properties": { "livemode": { "type": "boolean", "description": "False for a TEST installation: the list is the sandbox test captures, not the live wallet." }, "hasPaymentOnFile": { "type": "boolean", "description": "LIVE: Kismet can charge the guest off-session now. TEST: a test card was captured." }, "paymentMethods": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "brand", "last4", "expMonth", "expYear", "isDefault", "addedAt" ], "properties": { "id": { "type": "string" }, "brand": { "type": [ "null", "string" ] }, "last4": { "type": [ "null", "string" ] }, "expMonth": { "type": [ "null", "integer" ] }, "expYear": { "type": [ "null", "integer" ] }, "isDefault": { "type": "boolean", "description": "Display preference only. Never decides which card Kismet charges." }, "addedAt": { "type": "string", "format": "date-time" } } } } } }, "example": { "livemode": false, "hasPaymentOnFile": true, "paymentMethods": [ { "id": "99999999-9999-4999-8999-999999999999", "brand": "visa", "last4": "4242", "expMonth": 12, "expYear": 2031, "isDefault": false, "addedAt": "2026-09-23T00:00:00.000Z" } ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Kismet Pay", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/me/wallet/capture": { "post": { "operationId": "prepareDeveloperGuestWalletCapture", "summary": "Start saving a card for the signed-in guest", "tags": [ "developer-guest-account" ], "description": "Creates a Kismet platform SetupIntent for the guest and returns a single-use, Kismet-hosted capture page URL that your page frames from parentOrigin. The guest enters the card there; on success Kismet attaches it to the guest's wallet for future off-session charges and the frame posts kismet:guest-wallet:complete to parentOrigin. The card details and the Stripe client secret never reach your page. LIVE installations save a real card; TEST installations capture in Stripe test mode (use 4242 4242 4242 4242) and never write the live wallet.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "parentOrigin" ], "properties": { "walletRequestId": { "type": "string", "format": "uuid", "description": "Optional invitation context. Must match the authenticated guest, installation, environment and parent origin." }, "parentOrigin": { "type": "string", "minLength": 8, "maxLength": 255, "description": "The origin of the page that will frame the capture (scheme + host + optional port). Must be https, or http on localhost. When the credential carries an origin allowlist it must be one of those origins." } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Server-only Kismet guest access token held by the same-origin BFF. Never expose it to browser JavaScript." }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "captureUrl", "expiresAt", "livemode" ], "properties": { "captureUrl": { "type": "string", "description": "Kismet-hosted capture page (an https URL on kismet.travel). Embed it in an iframe from parentOrigin, or open it in a dialog. Single use; the card details never touch your page." }, "expiresAt": { "type": "string", "format": "date-time" }, "livemode": { "type": "boolean", "description": "False for a TEST installation: the capture runs in Stripe test mode." } } }, "example": { "captureUrl": "https://kismet.travel/embed/guest-wallet?request=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "expiresAt": "2026-09-23T00:10:00.000Z", "livemode": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Kismet Pay", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_auth.write" } }, "/v1/developer/guest/wallet/requests": { "post": { "operationId": "createDeveloperWalletRequest", "summary": "Request a saved card from a verified guest", "tags": [ "developer-guest-wallet-requests" ], "description": "Requires a server credential with guest_wallet_requests.write and an existing verified guest visible to this collection (or explicitly registered TEST identity). Kismet sends authentication proof only to the verified guest. partner_link returns navigation context that requires independent guest authentication. Does not charge a card or grant marketing consent. Beta availability is deployment gated.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "guestProfileId", "returnUrl", "delivery" ], "properties": { "guestProfileId": { "type": "string", "format": "uuid", "description": "Canonical guest reference previously obtained through authorized guest account APIs; inaccessible guests return the same not-found response." }, "returnUrl": { "type": "string", "pattern": "^https?://[^\\s]+$", "maxLength": 2048, "description": "Start page on an explicitly registered installation origin, without query or fragment. This is not an OAuth callback." }, "delivery": { "type": "string", "enum": [ "partner_link", "kismet_email" ] }, "reference": { "type": [ "null", "string" ], "maxLength": 128, "pattern": "^[A-Za-z0-9_.:-]{1,128}$", "description": "Opaque caller correlation, not guest contact information." } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{8,128}$" }, "in": "header", "name": "idempotency-key", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "id", "status", "delivery", "deliveryState", "reference", "createdAt", "expiresAt", "livemode", "startUrl" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "in_progress", "succeeded", "expired", "revoked" ] }, "delivery": { "type": "string", "enum": [ "partner_link", "kismet_email" ] }, "deliveryState": { "type": "string", "enum": [ "not_requested", "pending", "sent", "failed" ] }, "reference": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "livemode": { "type": "boolean" }, "startUrl": { "type": [ "null", "string" ], "description": "Partner navigation context only. Never authenticates a guest. Null for Kismet-delivered email and closed requests." } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Guest Experience + Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "guest_wallet_requests.write" } }, "/v1/developer/guest/wallet/requests/{requestId}": { "get": { "operationId": "getDeveloperWalletRequest", "summary": "Read a card request status", "tags": [ "developer-guest-wallet-requests" ], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "requestId", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "id", "status", "delivery", "deliveryState", "reference", "createdAt", "expiresAt", "livemode", "startUrl" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "in_progress", "succeeded", "expired", "revoked" ] }, "delivery": { "type": "string", "enum": [ "partner_link", "kismet_email" ] }, "deliveryState": { "type": "string", "enum": [ "not_requested", "pending", "sent", "failed" ] }, "reference": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "livemode": { "type": "boolean" }, "startUrl": { "type": [ "null", "string" ], "description": "Partner navigation context only. Never authenticates a guest. Null for Kismet-delivered email and closed requests." } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Guest Experience + Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "guest_wallet_requests.write" } }, "/v1/developer/guest/wallet/requests/{requestId}/revoke": { "post": { "operationId": "revokeDeveloperWalletRequest", "summary": "Revoke an unfinished card request", "tags": [ "developer-guest-wallet-requests" ], "description": "Prevents new authorization or capture. A genuinely completed provider save is still reconciled as success.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": {} } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "requestId", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "id", "status", "delivery", "deliveryState", "reference", "createdAt", "expiresAt", "livemode", "startUrl" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "in_progress", "succeeded", "expired", "revoked" ] }, "delivery": { "type": "string", "enum": [ "partner_link", "kismet_email" ] }, "deliveryState": { "type": "string", "enum": [ "not_requested", "pending", "sent", "failed" ] }, "reference": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "livemode": { "type": "boolean" }, "startUrl": { "type": [ "null", "string" ], "description": "Partner navigation context only. Never authenticates a guest. Null for Kismet-delivered email and closed requests." } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Guest Experience + Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "guest_wallet_requests.write" } }, "/v1/developer/guest/wallet/requests/{requestId}/resend": { "post": { "operationId": "resendDeveloperWalletRequest", "summary": "Resend the Kismet login link", "tags": [ "developer-guest-wallet-requests" ], "description": "Only kismet_email requests. Replaces the previous proof. Maximum five sends per request, at least 60 seconds apart. Allows recovery from failed or interrupted delivery without revealing authentication proof to the caller.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": {} } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "requestId", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "id", "status", "delivery", "deliveryState", "reference", "createdAt", "expiresAt", "livemode", "startUrl" ], "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "in_progress", "succeeded", "expired", "revoked" ] }, "delivery": { "type": "string", "enum": [ "partner_link", "kismet_email" ] }, "deliveryState": { "type": "string", "enum": [ "not_requested", "pending", "sent", "failed" ] }, "reference": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "livemode": { "type": "boolean" }, "startUrl": { "type": [ "null", "string" ], "description": "Partner navigation context only. Never authenticates a guest. Null for Kismet-delivered email and closed requests." } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "410": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Guest Experience + Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "guest_wallet_requests.write" } }, "/v1/developer/collections/{collection}/offers/{offerId}": { "get": { "operationId": "getDeveloperOffer", "summary": "Read an offer and its capture disclosure", "tags": [ "developer-offers" ], "description": "Read a configured welcome offer before an explicit guest submission. Requires a server credential with offers.read and an exact collection-owned origin registered on the installation. TEST requires a STAGING domain and allows DRAFT or ARMED offers for rehearsal. LIVE requires a VERIFIED PRODUCTION domain and an ARMED offer. Only immediate lead-capture awards with an email template are supported. The response environment comes from the installation; delivery.subjectPrefix is [STAGING] for TEST and null for LIVE.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 160 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "offerId", "required": true }, { "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "in": "header", "name": "origin", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "id", "environment", "headline", "promise", "terms", "disclosure", "delivery" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Canonical offer identifier. Equals perkId on the authenticated guest account benefit for this offer. Match within the same collection and environment; a catalog offer is not proof of a personal award." }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "headline": { "type": "string" }, "promise": { "type": "string" }, "terms": { "type": [ "null", "string" ] }, "disclosure": { "type": "object", "additionalProperties": false, "required": [ "version", "text", "hash" ], "properties": { "version": { "type": "string" }, "text": { "type": "string" }, "hash": { "type": "string" } } }, "delivery": { "type": "object", "additionalProperties": false, "required": [ "email", "subjectPrefix" ], "properties": { "email": { "type": "string", "enum": [ "real" ] }, "subjectPrefix": { "type": [ "null", "string" ], "enum": [ "[STAGING]", null ] } } }, "deliveryDisclosure": { "type": "object", "additionalProperties": false, "required": [ "version", "text", "hash" ], "properties": { "version": { "type": "string" }, "text": { "type": "string" }, "hash": { "type": "string" } } } } }, "example": { "id": "11111111-1111-4111-8111-111111111111", "environment": "TEST", "headline": "A welcome offer", "promise": "Enjoy an experience during your stay.", "terms": null, "disclosure": { "version": "staging-offer-email-v1", "text": "Send me this offer by email. This staging test sends one real email; it does not subscribe me to marketing or enroll me in a membership.", "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "delivery": { "email": "real", "subjectPrefix": "[STAGING]" } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Guest Experience + Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "offers.read" } }, "/v1/developer/collections/{collection}/offers/{offerId}/captures": { "post": { "operationId": "captureDeveloperOffer", "summary": "Capture an offer and request its email", "tags": [ "developer-offers" ], "description": "On explicit guest submission, award the configured offer and send one requested real email. Requires a server key with offers.write, the current disclosure hash, and an exact collection-owned origin registered on the installation. TEST requires a STAGING domain and adds [STAGING] to the subject; the recipient must be registered unless an unexpired, manager-enabled requested-offer-email participation policy permits it for the exact verified staging origin. LIVE requires a VERIFIED PRODUCTION domain and an ARMED offer; it uses production fulfillment without a staging subject prefix or test-recipient policy. Does not authenticate the guest, enroll membership or change marketing consent. Reuse the idempotency key on retry. A recipient receives at most one email per offer and installation, including across different keys. accepted means provider acceptance, not inbox delivery; pending or unknown must not be shown as sent and must not trigger a new send.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "email", "origin", "idempotencyKey", "consent" ], "properties": { "email": { "type": "string", "format": "email", "maxLength": 254 }, "origin": { "type": "string", "minLength": 8, "maxLength": 255 }, "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "consent": { "type": "object", "additionalProperties": false, "required": [ "accepted", "disclosureHash" ], "properties": { "accepted": { "type": "boolean", "enum": [ true ] }, "disclosureHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "attribution": { "type": [ "object", "null" ], "additionalProperties": false, "required": [ "enrollmentId", "sessionId" ], "properties": { "enrollmentId": { "type": "string", "format": "uuid" }, "sessionId": { "type": "string", "minLength": 8, "maxLength": 255 }, "verificationProof": { "type": [ "string", "null" ], "maxLength": 256, "description": "Server-only proof from portable email verification. sessionId remains the destination browser. The API resolves the original source session solely for enrollment attribution, preserving ownership checks." } } } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 160 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "offerId", "required": true }, { "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "in": "header", "name": "origin", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "captureId", "environment", "offer", "email", "replayed" ], "properties": { "captureId": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "offer": { "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "issued", "pending", "unavailable" ] } } }, "email": { "type": "object", "additionalProperties": false, "required": [ "status", "acceptedAt" ], "properties": { "status": { "type": "string", "enum": [ "not_sent", "pending", "accepted", "unknown", "failed" ] }, "acceptedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "replayed": { "type": "boolean" } } }, "example": { "captureId": "22222222-2222-4222-8222-222222222222", "environment": "TEST", "offer": { "id": "11111111-1111-4111-8111-111111111111", "status": "issued" }, "email": { "status": "accepted", "acceptedAt": "2026-09-29T03:00:00.000Z" }, "replayed": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Guest Experience + Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "offers.write" } }, "/v1/developer/guest/me/preferences": { "get": { "operationId": "getDeveloperGuestPreferences", "summary": "Read guest preferences and current disclosures", "tags": [ "developer-guest-preferences" ], "description": "Returns marketing and membership separately for the authenticated guest and installed collection. TEST is installation-isolated rehearsal with no real effects. LIVE reads canonical collection preferences and membership. Requires a verified guest and explicit guest_preferences.write grant. Discovery does not enroll or subscribe the guest.", "parameters": [ { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Verified guest access token held by your same-origin BFF, never browser JavaScript." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "disclosure", "disclosureHash", "state" ], "properties": { "disclosure": { "type": "object", "additionalProperties": false, "required": [ "version", "collection", "membership", "emailMarketing", "privacyUrl", "notice" ], "properties": { "version": { "type": "string" }, "collection": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "membership": { "type": "object", "additionalProperties": false, "required": [ "available", "name", "termsUrl" ], "properties": { "available": { "type": "boolean" }, "name": { "type": "string" }, "termsUrl": { "type": "string", "format": "uri" } } }, "emailMarketing": { "type": "object", "additionalProperties": false, "required": [ "channel", "confirmation", "text" ], "properties": { "channel": { "type": "string", "enum": [ "email" ] }, "confirmation": { "type": "string", "enum": [ "double_opt_in" ] }, "text": { "type": "string" } } }, "privacyUrl": { "type": "string", "format": "uri" }, "notice": { "type": "string" } } }, "disclosureHash": { "type": "string" }, "state": { "type": "object", "additionalProperties": false, "required": [ "environment", "revision", "emailMarketing", "membership", "deliveries" ], "properties": { "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "revision": { "type": "integer", "minimum": 0 }, "emailMarketing": { "type": "string", "enum": [ "NEVER_SUBSCRIBED", "PENDING", "SUBSCRIBED", "UNSUBSCRIBED" ] }, "membership": { "type": "object", "additionalProperties": false, "required": [ "status", "joinedAt" ], "properties": { "status": { "type": "string", "enum": [ "NOT_JOINED", "ACTIVE" ] }, "joinedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "deliveries": { "type": "string", "enum": [ "SIMULATED", "LIVE" ] } } } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Guest Accounts + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_preferences.write" } }, "/v1/developer/guest/me/preferences/captures": { "post": { "operationId": "prepareDeveloperGuestPreferenceCapture", "summary": "Open a Kismet-hosted preference confirmation", "tags": [ "developer-guest-preferences" ], "description": "Prepares a confirmation URL valid for at most ten minutes, bound to this guest, installation, collection, registered website origin and disclosure. Open it as a standalone popup or tab. Do not collect consent in your own form. TEST simulates double opt-in with no real effects. LIVE independently records optional free membership and marketing choices; subscriptions remain pending until the guest confirms the code emailed to their verified address. Existing suppression is preserved.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "parentOrigin" ], "properties": { "parentOrigin": { "type": "string", "minLength": 8, "maxLength": 255, "description": "Exact registered website origin; HTTPS except local development. Empty origin allowlists do not authorize capture." } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Verified guest access token held by your same-origin BFF, never browser JavaScript." }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true, "description": "CSRF proof validated by the same-origin BFF before forwarding." } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "captureId", "confirmationUrl", "expiresAt", "environment" ], "properties": { "captureId": { "type": "string", "format": "uuid" }, "confirmationUrl": { "type": "string", "format": "uri" }, "expiresAt": { "type": "string", "format": "date-time" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Guest Accounts + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta", "x-kismet-required-capability": "guest_preferences.write" } }, "/v1/developer/collections/{collection}/activity": { "get": { "operationId": "getDeveloperActivitySummary", "summary": "Read installation activity", "tags": [ "developer-activity" ], "description": "Read recorded installation activity for an elapsed period of up to 31 days. Verified sign-ins require server authentication evidence. Offer metrics include only this installation’s linked captures; the optional offerId narrows only those metrics. Email acceptance is not inbox delivery. Confirmed redemption is not issuance and may have incomplete provider confirmation coverage. TEST and LIVE remain separate. This report is not software-module or variant attribution.", "parameters": [ { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "from", "required": true }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "to", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "offerId", "required": false }, { "schema": { "type": "string", "enum": [ "offer_links" ] }, "in": "query", "name": "include", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "telemetry.read", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "installationId": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "scope": { "type": "string", "enum": [ "installation" ] }, "period": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "basis": { "type": "string", "enum": [ "occurred_at" ] } }, "required": [ "from", "to", "basis" ], "additionalProperties": false }, "generatedAt": { "type": "string", "format": "date-time" }, "offerId": { "type": "string", "format": "uuid", "nullable": true }, "basis": { "type": "string", "enum": [ "recorded_events" ] }, "metrics": { "type": "object", "properties": { "verifiedSignIns": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "coverage": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "type": "array", "items": { "type": "string", "enum": [ "BEFORE_RETAINED_COVERAGE", "SOURCE_NOT_AVAILABLE", "CONFIRMATION_COVERAGE_UNKNOWN", "AUTOMATED_CLICKS_POSSIBLE" ] } }, "earliestAvailableAt": { "type": "string", "format": "date-time", "nullable": true }, "lastObservedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "count", "coverage", "reasons", "earliestAvailableAt", "lastObservedAt" ], "additionalProperties": false }, "offersIssued": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "coverage": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "type": "array", "items": { "type": "string", "enum": [ "BEFORE_RETAINED_COVERAGE", "SOURCE_NOT_AVAILABLE", "CONFIRMATION_COVERAGE_UNKNOWN", "AUTOMATED_CLICKS_POSSIBLE" ] } }, "earliestAvailableAt": { "type": "string", "format": "date-time", "nullable": true }, "lastObservedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "count", "coverage", "reasons", "earliestAvailableAt", "lastObservedAt" ], "additionalProperties": false }, "offerEmailsAccepted": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "coverage": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "type": "array", "items": { "type": "string", "enum": [ "BEFORE_RETAINED_COVERAGE", "SOURCE_NOT_AVAILABLE", "CONFIRMATION_COVERAGE_UNKNOWN", "AUTOMATED_CLICKS_POSSIBLE" ] } }, "earliestAvailableAt": { "type": "string", "format": "date-time", "nullable": true }, "lastObservedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "count", "coverage", "reasons", "earliestAvailableAt", "lastObservedAt" ], "additionalProperties": false }, "confirmedRedemptions": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "coverage": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "type": "array", "items": { "type": "string", "enum": [ "BEFORE_RETAINED_COVERAGE", "SOURCE_NOT_AVAILABLE", "CONFIRMATION_COVERAGE_UNKNOWN", "AUTOMATED_CLICKS_POSSIBLE" ] } }, "earliestAvailableAt": { "type": "string", "format": "date-time", "nullable": true }, "lastObservedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "count", "coverage", "reasons", "earliestAvailableAt", "lastObservedAt" ], "additionalProperties": false }, "offerLinksClicked": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "coverage": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "type": "array", "items": { "type": "string", "enum": [ "BEFORE_RETAINED_COVERAGE", "SOURCE_NOT_AVAILABLE", "CONFIRMATION_COVERAGE_UNKNOWN", "AUTOMATED_CLICKS_POSSIBLE" ] } }, "earliestAvailableAt": { "type": "string", "format": "date-time", "nullable": true }, "lastObservedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "count", "coverage", "reasons", "earliestAvailableAt", "lastObservedAt" ], "additionalProperties": false } }, "required": [ "verifiedSignIns", "offersIssued", "offerEmailsAccepted", "confirmedRedemptions" ], "additionalProperties": false } }, "required": [ "installationId", "collectionId", "environment", "scope", "period", "generatedAt", "offerId", "basis", "metrics" ], "additionalProperties": false }, "example": { "installationId": "10000000-0000-4000-8000-000000000003", "collectionId": "10000000-0000-4000-8000-000000000002", "environment": "TEST", "scope": "installation", "period": { "from": "2026-09-28T00:00:00.000Z", "to": "2026-09-29T00:00:00.000Z", "basis": "occurred_at" }, "generatedAt": "2026-09-29T04:00:00.000Z", "offerId": null, "basis": "recorded_events", "metrics": { "verifiedSignIns": { "count": 2, "coverage": "complete", "reasons": [], "earliestAvailableAt": "2026-09-01T00:00:00.000Z", "lastObservedAt": "2026-09-28T18:00:00.000Z" }, "offersIssued": { "count": 1, "coverage": "complete", "reasons": [], "earliestAvailableAt": "2026-09-01T00:00:00.000Z", "lastObservedAt": "2026-09-28T18:00:00.000Z" }, "offerEmailsAccepted": { "count": 1, "coverage": "complete", "reasons": [], "earliestAvailableAt": "2026-09-01T00:00:00.000Z", "lastObservedAt": "2026-09-28T18:00:00.000Z" }, "confirmedRedemptions": { "count": 0, "coverage": "partial", "reasons": [ "CONFIRMATION_COVERAGE_UNKNOWN" ], "earliestAvailableAt": "2026-09-01T00:00:00.000Z", "lastObservedAt": null } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/collections/{collection}/software/{module}/panel-launches/redeem": { "post": { "operationId": "redeemDeveloperSoftwarePanelLaunch", "summary": "Authorize rendering a manager panel", "tags": [ "developer-software" ], "description": "Server-only page-render authorization. Redeem the one-use, 30-second code issued by the signed-in Kismet Software dashboard before rendering the registered panel HTML. Requires the matching installation server credential with telemetry.read. Rechecks the current manager collection role, installation, grants and exact registered panel URL. Returns no manager identity, session or data capability. Expired, reused or mismatched codes are refused; manager data remains protected by the account bridge. Never cache this response or expose the server credential in browser code.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^kspl_[A-Za-z0-9_-]{43}$" }, "panelUrl": { "type": "string", "format": "uri", "maxLength": 2048 } }, "required": [ "code", "panelUrl" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "in": "path", "name": "module", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "telemetry.read", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "purpose": { "type": "string", "enum": [ "software-panel-render" ] }, "moduleId": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "applicationId": { "type": "string", "format": "uuid" }, "installationId": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "panelUrl": { "type": "string", "format": "uri" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "purpose", "moduleId", "applicationId", "installationId", "collectionId", "environment", "panelUrl", "expiresAt" ], "additionalProperties": false }, "example": { "purpose": "software-panel-render", "moduleId": "welcome-offer", "applicationId": "10000000-0000-4000-8000-000000000001", "installationId": "10000000-0000-4000-8000-000000000003", "collectionId": "10000000-0000-4000-8000-000000000002", "environment": "TEST", "panelUrl": "https://staging.example.com/our/welcome-offer", "expiresAt": "2026-09-28T12:00:30.000Z" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview" } }, "/v1/developer/collections/{collection}/software/{module}/presentation": { "get": { "operationId": "getDeveloperSoftwarePresentation", "summary": "Get app presentation", "tags": [ "developer-software" ], "description": "Installation-scoped custom software. Requires a server credential. Collection, application and TEST/LIVE environment come from the credential. Settings are revisioned; engagement is client-reported, not consent or booking authority. Canonical outcome attribution is currently unavailable. Browser components use their same-origin server boundary; never expose the server credential.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "in": "path", "name": "module", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "telemetry.read", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 320, "nullable": true }, "iconUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "builder": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "logoUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "websiteUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true } }, "required": [ "name" ], "additionalProperties": false, "nullable": true }, "integrations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "logoUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "websiteUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true } }, "required": [ "name" ], "additionalProperties": false }, "maxItems": 12, "default": [] } }, "additionalProperties": false }, "example": { "description": "Help guests discover a welcome offer.", "builder": { "name": "Example Studio", "websiteUrl": "https://studio.example.com" }, "integrations": [ { "name": "Offer provider", "logoUrl": "https://assets.example.com/provider.png" } ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" }, "put": { "operationId": "updateDeveloperSoftwarePresentation", "summary": "Replace app presentation", "tags": [ "developer-software" ], "description": "Installation-scoped custom software. Requires a server credential. Collection, application and TEST/LIVE environment come from the credential. Settings are revisioned; engagement is client-reported, not consent or booking authority. Canonical outcome attribution is currently unavailable. Browser components use their same-origin server boundary; never expose the server credential.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 320, "nullable": true }, "iconUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "builder": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "logoUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "websiteUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true } }, "required": [ "name" ], "additionalProperties": false, "nullable": true }, "integrations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "logoUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "websiteUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true } }, "required": [ "name" ], "additionalProperties": false }, "maxItems": 12, "default": [] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "in": "path", "name": "module", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "telemetry.configure", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 320, "nullable": true }, "iconUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "builder": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "logoUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "websiteUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true } }, "required": [ "name" ], "additionalProperties": false, "nullable": true }, "integrations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "logoUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "websiteUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true } }, "required": [ "name" ], "additionalProperties": false }, "maxItems": 12, "default": [] } }, "additionalProperties": false }, "example": { "description": "Help guests discover a welcome offer.", "builder": { "name": "Example Studio" }, "integrations": [] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/collections/{collection}/software/{module}": { "put": { "operationId": "registerDeveloperSoftwareModule", "summary": "Register a software module", "tags": [ "developer-software" ], "description": "Installation-scoped custom software. Requires a server credential. Collection, application and TEST/LIVE environment come from the credential. Settings are revisioned; engagement is client-reported, not consent or booking authority. Canonical outcome attribution is currently unavailable. Browser components use their same-origin server boundary; never expose the server credential.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "displayName": { "type": "string", "minLength": 1, "maxLength": 160 }, "panelUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "presentation": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 320, "nullable": true }, "iconUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "builder": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "logoUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "websiteUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true } }, "required": [ "name" ], "additionalProperties": false, "nullable": true }, "integrations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "logoUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true }, "websiteUrl": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true } }, "required": [ "name" ], "additionalProperties": false }, "maxItems": 12, "default": [] } }, "additionalProperties": false, "nullable": true }, "settingsSchema": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "boolean" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 } }, "required": [ "type", "label" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "integer" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" } }, "required": [ "type", "label", "minimum", "maximum" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "enum" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "values": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "label", "values" ], "additionalProperties": false } ] } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "weight": { "type": "integer", "minimum": 0, "maximum": 10000 }, "settings": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "id", "label", "weight", "settings" ], "additionalProperties": false }, "minItems": 1, "maxItems": 8 }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 160 } }, "required": [ "id", "label" ], "additionalProperties": false }, "maxItems": 12 }, "enabled": { "type": "boolean" }, "signedOutOnly": { "type": "boolean", "default": true } }, "required": [ "displayName", "settingsSchema", "variants", "actions", "enabled" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "in": "path", "name": "module", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "telemetry.configure", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "signedOutOnly": { "type": "boolean" }, "assignmentUnit": { "type": "string", "enum": [ "session" ] }, "settingsSchema": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "boolean" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 } }, "required": [ "type", "label" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "integer" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" } }, "required": [ "type", "label", "minimum", "maximum" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "enum" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "values": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "label", "values" ], "additionalProperties": false } ] } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "weight": { "type": "integer", "minimum": 0, "maximum": 10000 }, "settings": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "id", "label", "weight", "settings" ], "additionalProperties": false } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": false } }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "revision", "enabled", "signedOutOnly", "assignmentUnit", "settingsSchema", "variants", "actions", "updatedAt" ], "additionalProperties": false }, "example": { "revision": 1, "enabled": true, "signedOutOnly": true, "assignmentUnit": "session", "settingsSchema": { "eligiblePage": { "type": "integer", "label": "Eligible page", "minimum": 1, "maximum": 2 } }, "variants": [ { "id": "first-page", "label": "First page", "weight": 5000, "settings": { "eligiblePage": 1 } }, { "id": "second-page", "label": "Second page", "weight": 5000, "settings": { "eligiblePage": 2 } } ], "actions": [ { "id": "claim", "label": "Claim selected" } ], "updatedAt": "2026-09-01T00:00:00.000Z" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/collections/{collection}/software/{module}/configuration": { "get": { "operationId": "getDeveloperSoftwareConfiguration", "summary": "Read software configuration", "tags": [ "developer-software" ], "description": "Installation-scoped custom software. Requires a server credential. Collection, application and TEST/LIVE environment come from the credential. Settings are revisioned; engagement is client-reported, not consent or booking authority. Canonical outcome attribution is currently unavailable. Browser components use their same-origin server boundary; never expose the server credential.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "in": "path", "name": "module", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "telemetry.read", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "signedOutOnly": { "type": "boolean" }, "assignmentUnit": { "type": "string", "enum": [ "session" ] }, "settingsSchema": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "boolean" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 } }, "required": [ "type", "label" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "integer" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" } }, "required": [ "type", "label", "minimum", "maximum" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "enum" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "values": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "label", "values" ], "additionalProperties": false } ] } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "weight": { "type": "integer", "minimum": 0, "maximum": 10000 }, "settings": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "id", "label", "weight", "settings" ], "additionalProperties": false } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": false } }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "revision", "enabled", "signedOutOnly", "assignmentUnit", "settingsSchema", "variants", "actions", "updatedAt" ], "additionalProperties": false }, "example": { "revision": 1, "enabled": true, "signedOutOnly": true, "assignmentUnit": "session", "settingsSchema": { "eligiblePage": { "type": "integer", "label": "Eligible page", "minimum": 1, "maximum": 2 } }, "variants": [ { "id": "first-page", "label": "First page", "weight": 5000, "settings": { "eligiblePage": 1 } }, { "id": "second-page", "label": "Second page", "weight": 5000, "settings": { "eligiblePage": 2 } } ], "actions": [ { "id": "claim", "label": "Claim selected" } ], "updatedAt": "2026-09-01T00:00:00.000Z" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" }, "patch": { "operationId": "updateDeveloperSoftwareConfiguration", "summary": "Update software configuration", "tags": [ "developer-software" ], "description": "Atomically create a configuration revision using expectedRevision. Ordinary updates preserve declared variant identities and labels. To evolve the experiment, provide the complete settingsSchema plus fully valid variants and labels for every new variant. Historical revisions, assigned visits and receipts remain unchanged. Requires telemetry.configure in this installation; TEST and LIVE are separate.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "signedOutOnly": { "type": "boolean" }, "settingsSchema": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "boolean" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 } }, "required": [ "type", "label" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "integer" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" } }, "required": [ "type", "label", "minimum", "maximum" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "enum" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "values": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "label", "values" ], "additionalProperties": false } ] }, "nullable": true }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 160, "nullable": true }, "weight": { "type": "integer", "minimum": 0, "maximum": 10000 }, "settings": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "id", "weight", "settings" ], "additionalProperties": false }, "minItems": 1, "maxItems": 8 } }, "required": [ "expectedRevision", "enabled", "signedOutOnly", "variants" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "in": "path", "name": "module", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "telemetry.configure", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "signedOutOnly": { "type": "boolean" }, "assignmentUnit": { "type": "string", "enum": [ "session" ] }, "settingsSchema": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "boolean" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 } }, "required": [ "type", "label" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "integer" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" } }, "required": [ "type", "label", "minimum", "maximum" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "enum" ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "values": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "label", "values" ], "additionalProperties": false } ] } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "weight": { "type": "integer", "minimum": 0, "maximum": 10000 }, "settings": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "id", "label", "weight", "settings" ], "additionalProperties": false } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": false } }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "revision", "enabled", "signedOutOnly", "assignmentUnit", "settingsSchema", "variants", "actions", "updatedAt" ], "additionalProperties": false }, "example": { "revision": 2, "enabled": true, "signedOutOnly": true, "assignmentUnit": "session", "settingsSchema": { "eligiblePage": { "type": "integer", "label": "Eligible page", "minimum": 1, "maximum": 2 } }, "variants": [ { "id": "first-page", "label": "First page", "weight": 5000, "settings": { "eligiblePage": 1 } }, { "id": "second-page", "label": "Second page", "weight": 5000, "settings": { "eligiblePage": 2 } } ], "actions": [ { "id": "claim", "label": "Claim selected" } ], "updatedAt": "2026-09-01T00:00:00.000Z" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/collections/{collection}/software/{module}/performance": { "get": { "operationId": "getDeveloperSoftwarePerformance", "summary": "Read software performance", "tags": [ "developer-software" ], "description": "Installation-scoped custom software. Requires a server credential. Collection, application and TEST/LIVE environment come from the credential. Settings are revisioned; engagement is client-reported, not consent or booking authority. Canonical outcome attribution is currently unavailable. Browser components use their same-origin server boundary; never expose the server credential.", "parameters": [ { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "from", "required": true }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "to", "required": true }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "revision", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "in": "path", "name": "module", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "telemetry.read", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "installationId": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "assignmentUnit": { "type": "string", "enum": [ "session" ] }, "revision": { "type": "integer", "minimum": 1 }, "period": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "basis": { "type": "string", "enum": [ "enrolled_at" ] } }, "required": [ "from", "to", "basis" ], "additionalProperties": false }, "generatedAt": { "type": "string", "format": "date-time" }, "lastEventAt": { "type": "string", "format": "date-time", "nullable": true }, "coverage": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "basis": { "type": "string", "enum": [ "received_events" ] }, "reasons": { "type": "array", "items": { "type": "string" } }, "earliestAvailableAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "status", "basis", "reasons", "earliestAvailableAt" ], "additionalProperties": false }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string" }, "assignedVisits": { "type": "integer", "minimum": 0 }, "displayedVisits": { "type": "integer", "minimum": 0 }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "label": { "type": "string" }, "visits": { "type": "integer", "minimum": 0 }, "events": { "type": "integer", "minimum": 0 } }, "required": [ "id", "label", "visits", "events" ], "additionalProperties": false } }, "verifiedOutcomes": { "type": "object", "properties": { "marketingSignup": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "available", "partial", "unavailable" ] }, "convertedVisits": { "type": "integer", "minimum": 0, "nullable": true }, "rate": { "type": "number", "minimum": 0, "maximum": 1, "nullable": true }, "reason": { "type": "string", "nullable": true } }, "required": [ "status", "convertedVisits", "rate", "reason" ], "additionalProperties": false }, "confirmedBooking": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "available", "partial", "unavailable" ] }, "convertedVisits": { "type": "integer", "minimum": 0, "nullable": true }, "rate": { "type": "number", "minimum": 0, "maximum": 1, "nullable": true }, "reason": { "type": "string", "nullable": true } }, "required": [ "status", "convertedVisits", "rate", "reason" ], "additionalProperties": false } }, "required": [ "marketingSignup", "confirmedBooking" ], "additionalProperties": false }, "offerOutcomes": { "type": "object", "properties": { "offersIssued": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "convertedVisits": { "type": "integer", "minimum": 0, "nullable": true }, "rate": { "type": "number", "minimum": 0, "maximum": 1, "nullable": true }, "coverage": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "type": "array", "items": { "type": "string" } }, "lastObservedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "count", "convertedVisits", "rate", "coverage", "reasons", "lastObservedAt" ], "additionalProperties": false }, "offerEmailsAccepted": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "convertedVisits": { "type": "integer", "minimum": 0, "nullable": true }, "rate": { "type": "number", "minimum": 0, "maximum": 1, "nullable": true }, "coverage": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "type": "array", "items": { "type": "string" } }, "lastObservedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "count", "convertedVisits", "rate", "coverage", "reasons", "lastObservedAt" ], "additionalProperties": false }, "offerEmailsDelivered": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "convertedVisits": { "type": "integer", "minimum": 0, "nullable": true }, "rate": { "type": "number", "minimum": 0, "maximum": 1, "nullable": true }, "coverage": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "type": "array", "items": { "type": "string" } }, "lastObservedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "count", "convertedVisits", "rate", "coverage", "reasons", "lastObservedAt" ], "additionalProperties": false }, "offerLinksClicked": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "convertedVisits": { "type": "integer", "minimum": 0, "nullable": true }, "rate": { "type": "number", "minimum": 0, "maximum": 1, "nullable": true }, "coverage": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "type": "array", "items": { "type": "string" } }, "lastObservedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "count", "convertedVisits", "rate", "coverage", "reasons", "lastObservedAt" ], "additionalProperties": false }, "confirmedRedemptions": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "convertedVisits": { "type": "integer", "minimum": 0, "nullable": true }, "rate": { "type": "number", "minimum": 0, "maximum": 1, "nullable": true }, "coverage": { "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "type": "array", "items": { "type": "string" } }, "lastObservedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "count", "convertedVisits", "rate", "coverage", "reasons", "lastObservedAt" ], "additionalProperties": false } }, "required": [ "offersIssued", "offerEmailsAccepted", "offerEmailsDelivered", "confirmedRedemptions" ], "additionalProperties": false } }, "required": [ "id", "label", "assignedVisits", "displayedVisits", "actions", "verifiedOutcomes" ], "additionalProperties": false } } }, "required": [ "moduleId", "installationId", "collectionId", "environment", "assignmentUnit", "revision", "period", "generatedAt", "lastEventAt", "coverage", "variants" ], "additionalProperties": false }, "example": { "moduleId": "welcome-offer", "installationId": "33333333-3333-4333-8333-333333333333", "collectionId": "44444444-4444-4444-8444-444444444444", "environment": "TEST", "assignmentUnit": "session", "revision": 1, "period": { "from": "2026-09-01T00:00:00.000Z", "to": "2026-09-02T00:00:00.000Z", "basis": "enrolled_at" }, "generatedAt": "2026-09-02T00:00:00.000Z", "lastEventAt": "2026-09-01T12:00:00.000Z", "coverage": { "status": "complete", "basis": "received_events", "reasons": [], "earliestAvailableAt": "2026-09-01T00:00:00.000Z" }, "variants": [ { "id": "first-page", "label": "First page", "assignedVisits": 205, "displayedVisits": 40, "actions": [ { "id": "claim", "label": "Claim selected", "visits": 3, "events": 4 } ], "verifiedOutcomes": { "marketingSignup": { "status": "unavailable", "convertedVisits": null, "rate": null, "reason": "Canonical outcome attribution is not available for software modules." }, "confirmedBooking": { "status": "unavailable", "convertedVisits": null, "rate": null, "reason": "Canonical outcome attribution is not available for software modules." } } }, { "id": "second-page", "label": "Second page", "assignedVisits": 205, "displayedVisits": 20, "actions": [ { "id": "claim", "label": "Claim selected", "visits": 3, "events": 4 } ], "verifiedOutcomes": { "marketingSignup": { "status": "unavailable", "convertedVisits": null, "rate": null, "reason": "Canonical outcome attribution is not available for software modules." }, "confirmedBooking": { "status": "unavailable", "convertedVisits": null, "rate": null, "reason": "Canonical outcome attribution is not available for software modules." } } } ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/collections/{collection}/software/{module}/enrollments": { "post": { "operationId": "enrollDeveloperSoftwareVisit", "summary": "Enroll a visit in software", "tags": [ "developer-software" ], "description": "Installation-scoped custom software. Requires a server credential. Collection, application and TEST/LIVE environment come from the credential. Settings are revisioned; engagement is client-reported, not consent or booking authority. Canonical outcome attribution is currently unavailable. Browser components use their same-origin server boundary; never expose the server credential.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "minLength": 8, "maxLength": 255 }, "pageUrl": { "type": "string", "format": "uri", "maxLength": 2048 }, "pageEnvironment": { "type": "string", "enum": [ "production", "staging", "development", "preview", "local" ] }, "userAgent": { "type": "string", "maxLength": 1024, "nullable": true } }, "required": [ "sessionId", "pageUrl", "pageEnvironment", "userAgent" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "in": "path", "name": "module", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "telemetry.write", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "moduleId": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "revision": { "type": "integer", "minimum": 1 }, "assignmentUnit": { "type": "string", "enum": [ "session" ] }, "variant": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "settings": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "id", "settings" ], "additionalProperties": false }, "enrolledAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "moduleId", "revision", "assignmentUnit", "variant", "enrolledAt", "expiresAt" ], "additionalProperties": false }, "example": { "id": "22222222-2222-4222-8222-222222222222", "moduleId": "welcome-offer", "revision": 1, "assignmentUnit": "session", "variant": { "id": "first-page", "settings": { "eligiblePage": 1 } }, "enrolledAt": "2026-09-01T01:00:00.000Z", "expiresAt": "2026-09-02T01:00:00.000Z" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/collections/{collection}/software/{module}/events": { "post": { "operationId": "recordDeveloperSoftwareEvent", "summary": "Record software engagement", "tags": [ "developer-software" ], "description": "Installation-scoped custom software. Requires a server credential. Collection, application and TEST/LIVE environment come from the credential. Settings are revisioned; engagement is client-reported, not consent or booking authority. Canonical outcome attribution is currently unavailable. Browser components use their same-origin server boundary; never expose the server credential.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "minLength": 8, "maxLength": 255 }, "pageUrl": { "type": "string", "format": "uri", "maxLength": 2048 }, "pageEnvironment": { "type": "string", "enum": [ "production", "staging", "development", "preview", "local" ] }, "userAgent": { "type": "string", "maxLength": 1024, "nullable": true }, "enrollmentId": { "type": "string", "format": "uuid" }, "eventId": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "display", "action" ] }, "actionId": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$", "nullable": true } }, "required": [ "sessionId", "pageUrl", "pageEnvironment", "userAgent", "enrollmentId", "eventId", "kind" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "in": "path", "name": "module", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "telemetry.write", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "eventId": { "type": "string", "format": "uuid" }, "received": { "type": "boolean", "enum": [ true ] } }, "required": [ "eventId", "received" ], "additionalProperties": false }, "example": { "eventId": "55555555-5555-4555-8555-555555555555", "received": true } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/events": { "get": { "operationId": "listDeveloperEvents", "summary": "List installation events", "tags": [ "developer-events" ], "description": "Lists durable events, including those recorded with no webhook destinations. Only currently granted event families are visible. Filter by type before pagination; an explicitly ungranted type is refused. Pass nextCursor as after with the same type selection. Default limit 25, maximum 100; order is recording time then event ID. Server credentials only. Application, installation, collection, and TEST/LIVE scope are resolved from the credential. Legacy collection webhook destinations are separate. TEST and LIVE events are isolated; neither event grants charging, booking or marketing authority.", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "in": "query", "name": "after", "required": false }, { "schema": { "type": "string", "enum": [ "payment_method.added", "guest.wallet_request.completed" ] }, "in": "query", "name": "type", "required": false } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "events.read", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "x-kismet-required-capabilities": [ "events.read" ], "x-kismet-event-family-capabilities": { "payment_method.added": "payment_methods.events.read", "guest.wallet_request.completed": "guest_wallet_requests.events.read" }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^evt_[0-9a-f-]{36}$" }, "version": { "type": "string", "enum": [ "2" ] }, "api_version": { "type": "string", "enum": [ "2026-09-23" ] }, "created_at": { "type": "string", "format": "date-time" }, "occurred_at": { "type": "string", "format": "date-time" }, "timestamp": { "type": "string", "format": "date-time" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "livemode": { "type": "boolean" }, "source": { "type": "object", "properties": { "application_id": { "type": "string", "format": "uuid" }, "installation_id": { "type": "string", "format": "uuid" } }, "required": [ "application_id", "installation_id" ], "additionalProperties": false }, "collection": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" } }, "required": [ "id", "slug" ], "additionalProperties": false }, "subject": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "guest" ] }, "id": { "type": "string", "pattern": "^dgs_[0-9a-f-]{36}$" } }, "required": [ "type", "id" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "payment_method.added" ] }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payment_method" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "type", "id" ], "additionalProperties": false }, "data": { "type": "object", "properties": { "payment_method_id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "request_id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$", "nullable": true }, "reference": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9_.:-]+$", "nullable": true } }, "required": [ "payment_method_id" ], "additionalProperties": false } }, "required": [ "id", "version", "api_version", "created_at", "occurred_at", "timestamp", "environment", "livemode", "source", "collection", "subject", "type", "object", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^evt_[0-9a-f-]{36}$" }, "version": { "type": "string", "enum": [ "2" ] }, "api_version": { "type": "string", "enum": [ "2026-09-23" ] }, "created_at": { "type": "string", "format": "date-time" }, "occurred_at": { "type": "string", "format": "date-time" }, "timestamp": { "type": "string", "format": "date-time" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "livemode": { "type": "boolean" }, "source": { "type": "object", "properties": { "application_id": { "type": "string", "format": "uuid" }, "installation_id": { "type": "string", "format": "uuid" } }, "required": [ "application_id", "installation_id" ], "additionalProperties": false }, "collection": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" } }, "required": [ "id", "slug" ], "additionalProperties": false }, "subject": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "guest" ] }, "id": { "type": "string", "pattern": "^dgs_[0-9a-f-]{36}$" } }, "required": [ "type", "id" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "guest.wallet_request.completed" ] }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "guest_wallet_request" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "type", "id" ], "additionalProperties": false }, "data": { "type": "object", "properties": { "request_id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "payment_method_id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "outcome": { "type": "string", "enum": [ "added", "already_present" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9_.:-]+$", "nullable": true } }, "required": [ "request_id", "payment_method_id", "outcome" ], "additionalProperties": false } }, "required": [ "id", "version", "api_version", "created_at", "occurred_at", "timestamp", "environment", "livemode", "source", "collection", "subject", "type", "object", "data" ], "additionalProperties": false } ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "data", "nextCursor" ], "additionalProperties": false }, "example": { "data": [ { "id": "evt_11111111-1111-4111-8111-111111111111", "type": "payment_method.added", "version": "2", "api_version": "2026-09-23", "created_at": "2026-09-23T12:00:01.000Z", "occurred_at": "2026-09-23T12:00:00.000Z", "timestamp": "2026-09-23T12:00:00.000Z", "environment": "TEST", "livemode": false, "source": { "application_id": "22222222-2222-4222-8222-222222222222", "installation_id": "33333333-3333-4333-8333-333333333333" }, "collection": { "id": "44444444-4444-4444-8444-444444444444", "slug": "sandbox-stays" }, "subject": { "type": "guest", "id": "dgs_55555555-5555-4555-8555-555555555555" }, "object": { "type": "payment_method", "id": "66666666-6666-4666-8666-666666666666" }, "data": { "payment_method_id": "66666666-6666-4666-8666-666666666666", "request_id": null, "reference": null } } ], "nextCursor": null } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/events/{eventId}": { "get": { "operationId": "getDeveloperEvent", "summary": "Get an installation event", "tags": [ "developer-events" ], "description": "Returns one immutable event envelope. Unknown, foreign, and no-longer-granted events return 404. Server credentials only. Application, installation, collection, and TEST/LIVE scope are resolved from the credential. Legacy collection webhook destinations are separate. TEST and LIVE events are isolated; neither event grants charging, booking or marketing authority.", "parameters": [ { "schema": { "type": "string", "pattern": "^evt_[0-9a-f-]{36}$" }, "in": "path", "name": "eventId", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "events.read", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "x-kismet-required-capabilities": [ "events.read" ], "x-kismet-event-family-capabilities": { "payment_method.added": "payment_methods.events.read", "guest.wallet_request.completed": "guest_wallet_requests.events.read" }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^evt_[0-9a-f-]{36}$" }, "version": { "type": "string", "enum": [ "2" ] }, "api_version": { "type": "string", "enum": [ "2026-09-23" ] }, "created_at": { "type": "string", "format": "date-time" }, "occurred_at": { "type": "string", "format": "date-time" }, "timestamp": { "type": "string", "format": "date-time" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "livemode": { "type": "boolean" }, "source": { "type": "object", "properties": { "application_id": { "type": "string", "format": "uuid" }, "installation_id": { "type": "string", "format": "uuid" } }, "required": [ "application_id", "installation_id" ], "additionalProperties": false }, "collection": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" } }, "required": [ "id", "slug" ], "additionalProperties": false }, "subject": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "guest" ] }, "id": { "type": "string", "pattern": "^dgs_[0-9a-f-]{36}$" } }, "required": [ "type", "id" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "payment_method.added" ] }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payment_method" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "type", "id" ], "additionalProperties": false }, "data": { "type": "object", "properties": { "payment_method_id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "request_id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$", "nullable": true }, "reference": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9_.:-]+$", "nullable": true } }, "required": [ "payment_method_id" ], "additionalProperties": false } }, "required": [ "id", "version", "api_version", "created_at", "occurred_at", "timestamp", "environment", "livemode", "source", "collection", "subject", "type", "object", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^evt_[0-9a-f-]{36}$" }, "version": { "type": "string", "enum": [ "2" ] }, "api_version": { "type": "string", "enum": [ "2026-09-23" ] }, "created_at": { "type": "string", "format": "date-time" }, "occurred_at": { "type": "string", "format": "date-time" }, "timestamp": { "type": "string", "format": "date-time" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "livemode": { "type": "boolean" }, "source": { "type": "object", "properties": { "application_id": { "type": "string", "format": "uuid" }, "installation_id": { "type": "string", "format": "uuid" } }, "required": [ "application_id", "installation_id" ], "additionalProperties": false }, "collection": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" } }, "required": [ "id", "slug" ], "additionalProperties": false }, "subject": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "guest" ] }, "id": { "type": "string", "pattern": "^dgs_[0-9a-f-]{36}$" } }, "required": [ "type", "id" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "guest.wallet_request.completed" ] }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "guest_wallet_request" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "type", "id" ], "additionalProperties": false }, "data": { "type": "object", "properties": { "request_id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "payment_method_id": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" }, "outcome": { "type": "string", "enum": [ "added", "already_present" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9_.:-]+$", "nullable": true } }, "required": [ "request_id", "payment_method_id", "outcome" ], "additionalProperties": false } }, "required": [ "id", "version", "api_version", "created_at", "occurred_at", "timestamp", "environment", "livemode", "source", "collection", "subject", "type", "object", "data" ], "additionalProperties": false } ] }, "example": { "id": "evt_11111111-1111-4111-8111-111111111111", "type": "payment_method.added", "version": "2", "api_version": "2026-09-23", "created_at": "2026-09-23T12:00:01.000Z", "occurred_at": "2026-09-23T12:00:00.000Z", "timestamp": "2026-09-23T12:00:00.000Z", "environment": "TEST", "livemode": false, "source": { "application_id": "22222222-2222-4222-8222-222222222222", "installation_id": "33333333-3333-4333-8333-333333333333" }, "collection": { "id": "44444444-4444-4444-8444-444444444444", "slug": "sandbox-stays" }, "subject": { "type": "guest", "id": "dgs_55555555-5555-4555-8555-555555555555" }, "object": { "type": "payment_method", "id": "66666666-6666-4666-8666-666666666666" }, "data": { "payment_method_id": "66666666-6666-4666-8666-666666666666", "request_id": null, "reference": null } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/webhook-subscriptions": { "get": { "operationId": "listDeveloperWebhookSubscriptions", "summary": "List webhook destinations", "tags": [ "developer-events" ], "description": "Lists this installation's version-2 destinations, including disabled destinations. At most 100 destinations may exist per installation. Signing secrets are not returned. Server credentials only. Application, installation, collection, and TEST/LIVE scope are resolved from the credential. Legacy collection webhook destinations are separate. TEST and LIVE events are isolated; neither event grants charging, booking or marketing authority.", "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "webhooks.read", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "x-kismet-required-capabilities": [ "webhooks.read" ], "x-kismet-event-family-capabilities": { "payment_method.added": "payment_methods.events.read", "guest.wallet_request.completed": "guest_wallet_requests.events.read" }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "envelopeVersion": { "type": "string", "enum": [ "2" ] }, "applicationId": { "type": "string", "format": "uuid" }, "installationId": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "secretHint": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "url", "eventTypes", "enabled", "envelopeVersion", "applicationId", "installationId", "collectionId", "environment", "secretHint", "createdAt" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false }, "example": { "data": [ { "id": "77777777-7777-4777-8777-777777777777", "name": "Application events", "url": "https://builder.example/webhooks/kismet", "eventTypes": [ "payment_method.added" ], "enabled": true, "envelopeVersion": "2", "applicationId": "22222222-2222-4222-8222-222222222222", "installationId": "33333333-3333-4333-8333-333333333333", "collectionId": "44444444-4444-4444-8444-444444444444", "environment": "TEST", "secretHint": "abcd", "createdAt": "2026-09-23T12:00:01.000Z" } ] } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" }, "post": { "operationId": "createDeveloperWebhookSubscription", "summary": "Create a signed webhook destination", "tags": [ "developer-events" ], "description": "Creates a signed generic HTTPS destination with an explicit event-type allowlist and envelopeVersion 2. Requires events.read, webhooks.read, webhooks.write and each selected event-family grant. Wildcards, URL credentials, private destinations, fragments and redirect delivery are unsupported. The signingSecret is revealed only in this response. Registration does not automatically replay historical events. Server credentials only. Application, installation, collection, and TEST/LIVE scope are resolved from the credential. Legacy collection webhook destinations are separate. TEST and LIVE events are isolated; neither event grants charging, booking or marketing authority.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "name", "url", "eventTypes", "envelopeVersion" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "eventTypes": { "type": "array", "minItems": 1, "maxItems": 2, "uniqueItems": true, "items": { "type": "string", "enum": [ "payment_method.added", "guest.wallet_request.completed" ] } }, "envelopeVersion": { "type": "string", "enum": [ "2" ] } } } } }, "required": true }, "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "webhooks.write", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "x-kismet-required-capabilities": [ "webhooks.write", "webhooks.read", "events.read" ], "x-kismet-event-family-capabilities": { "payment_method.added": "payment_methods.events.read", "guest.wallet_request.completed": "guest_wallet_requests.events.read" }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "subscription": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "envelopeVersion": { "type": "string", "enum": [ "2" ] }, "applicationId": { "type": "string", "format": "uuid" }, "installationId": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "secretHint": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "url", "eventTypes", "enabled", "envelopeVersion", "applicationId", "installationId", "collectionId", "environment", "secretHint", "createdAt" ], "additionalProperties": false }, "signingSecret": { "type": "string" } }, "required": [ "subscription", "signingSecret" ], "additionalProperties": false }, "example": { "subscription": { "id": "77777777-7777-4777-8777-777777777777", "name": "Application events", "url": "https://builder.example/webhooks/kismet", "eventTypes": [ "payment_method.added" ], "enabled": true, "envelopeVersion": "2", "applicationId": "22222222-2222-4222-8222-222222222222", "installationId": "33333333-3333-4333-8333-333333333333", "collectionId": "44444444-4444-4444-8444-444444444444", "environment": "TEST", "secretHint": "abcd", "createdAt": "2026-09-23T12:00:01.000Z" }, "signingSecret": "whsec_example_only_store_your_returned_secret" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/webhook-subscriptions/{subscriptionId}": { "patch": { "operationId": "updateDeveloperWebhookSubscription", "summary": "Enable or disable a webhook destination", "tags": [ "developer-events" ], "description": "Changes enabled only; URL, scope, event types and envelope version remain fixed. Disabling requires webhooks.write. Enabling additionally requires events.read, webhooks.read and every selected event-family grant. Create a replacement destination to change its contract. Server credentials only. Application, installation, collection, and TEST/LIVE scope are resolved from the credential. Legacy collection webhook destinations are separate. TEST and LIVE events are isolated; neither event grants charging, booking or marketing authority.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "subscriptionId", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "webhooks.write", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "x-kismet-required-capabilities": [ "webhooks.write" ], "x-kismet-event-family-capabilities": { "payment_method.added": "payment_methods.events.read", "guest.wallet_request.completed": "guest_wallet_requests.events.read" }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "envelopeVersion": { "type": "string", "enum": [ "2" ] }, "applicationId": { "type": "string", "format": "uuid" }, "installationId": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "secretHint": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "url", "eventTypes", "enabled", "envelopeVersion", "applicationId", "installationId", "collectionId", "environment", "secretHint", "createdAt" ], "additionalProperties": false }, "example": { "id": "77777777-7777-4777-8777-777777777777", "name": "Application events", "url": "https://builder.example/webhooks/kismet", "eventTypes": [ "payment_method.added" ], "enabled": false, "envelopeVersion": "2", "applicationId": "22222222-2222-4222-8222-222222222222", "installationId": "33333333-3333-4333-8333-333333333333", "collectionId": "44444444-4444-4444-8444-444444444444", "environment": "TEST", "secretHint": "abcd", "createdAt": "2026-09-23T12:00:01.000Z" } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/webhook-subscriptions/{subscriptionId}/deliveries": { "get": { "operationId": "listDeveloperWebhookDeliveries", "summary": "List webhook delivery attempts", "tags": [ "developer-events" ], "description": "Lists delivery status for currently granted event families on this destination. Includes attempts and response codes, not response bodies, secrets or event payloads. Default limit 25, maximum 100. Use the event API to read the canonical envelope. Server credentials only. Application, installation, collection, and TEST/LIVE scope are resolved from the credential. Legacy collection webhook destinations are separate. TEST and LIVE events are isolated; neither event grants charging, booking or marketing authority.", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "in": "query", "name": "after", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "subscriptionId", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "webhooks.read", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "x-kismet-required-capabilities": [ "webhooks.read", "events.read" ], "x-kismet-event-family-capabilities": { "payment_method.added": "payment_methods.events.read", "guest.wallet_request.completed": "guest_wallet_requests.events.read" }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "eventId": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "SENDING", "SUCCEEDED", "FAILED", "DEAD" ] }, "attempts": { "type": "integer" }, "responseCode": { "type": "integer", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "deliveredAt": { "type": "string", "format": "date-time", "nullable": true }, "nextRetryAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "id", "eventId", "status", "attempts", "responseCode", "createdAt", "deliveredAt", "nextRetryAt" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "data", "nextCursor" ], "additionalProperties": false }, "example": { "data": [ { "id": "88888888-8888-4888-8888-888888888888", "eventId": "evt_11111111-1111-4111-8111-111111111111", "status": "SUCCEEDED", "attempts": 1, "responseCode": 204, "createdAt": "2026-09-23T12:00:01.000Z", "deliveredAt": "2026-09-23T12:00:02.000Z", "nextRetryAt": null } ], "nextCursor": null } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/events/{eventId}/replay": { "post": { "operationId": "replayDeveloperEvent", "summary": "Replay an event to a webhook destination", "tags": [ "developer-events" ], "description": "Queues a retained event for an enabled, same-installation destination subscribed to its type. Requires events.read, webhooks.read, webhooks.write and the event-family grant. The event ID and body stay unchanged; dispatch uses a fresh signature timestamp. queued=false means an attempt is already sending. Repeated queued requests coalesce; receivers must deduplicate by event ID. Server credentials only. Application, installation, collection, and TEST/LIVE scope are resolved from the credential. Legacy collection webhook destinations are separate. TEST and LIVE events are isolated; neither event grants charging, booking or marketing authority.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "subscriptionId" ], "properties": { "subscriptionId": { "type": "string", "format": "uuid" } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "pattern": "^evt_[0-9a-f-]{36}$" }, "in": "path", "name": "eventId", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "webhooks.write", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "x-kismet-required-capabilities": [ "webhooks.write", "webhooks.read", "events.read" ], "x-kismet-event-family-capabilities": { "payment_method.added": "payment_methods.events.read", "guest.wallet_request.completed": "guest_wallet_requests.events.read" }, "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deliveryId": { "type": "string", "format": "uuid" }, "queued": { "type": "boolean" } }, "required": [ "deliveryId", "queued" ], "additionalProperties": false }, "example": { "deliveryId": "88888888-8888-4888-8888-888888888888", "queued": true } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "beta" } }, "/v1/developer/guest/signup-disclosure": { "get": { "operationId": "getDeveloperGuestSignupDisclosure", "summary": "Read inline email signup terms before sign-in", "tags": [ "developer-guest-preferences" ], "description": "Server-only, requires guest_preferences.write and an exact registered Origin. Display the returned text and environment notice beside the explicit signup action. Reading terms does not subscribe anyone.", "parameters": [ { "schema": { "type": "string" }, "in": "header", "name": "origin", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "disclosure", "disclosureHash" ], "properties": { "disclosure": { "type": "object", "additionalProperties": false, "required": [ "version", "collection", "environment", "text", "privacyUrl", "notice" ], "properties": { "version": { "type": "string" }, "collection": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "text": { "type": "string" }, "privacyUrl": { "type": "string", "format": "uri" }, "notice": { "type": [ "null", "string" ] } } }, "disclosureHash": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Guest Accounts + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "guest_preferences.write" } }, "/v1/developer/guest/me/email-subscriptions": { "post": { "operationId": "subscribeDeveloperGuestEmail", "summary": "Record explicit inline marketing signup after verification", "tags": [ "developer-guest-preferences" ], "description": "Requires guest_preferences.write, a verified guest token, CSRF proof and registered parentOrigin. Display current signup terms before the action; preserve the explicit choice through Google or email-link verification. No additional confirmation email and no membership enrollment. TEST stores an isolated rehearsal receipt, never LIVE marketing permission. Replays return current preference without undoing later withdrawal. Offer-email consent is separate.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accepted": { "type": "boolean", "enum": [ true ] }, "expectedGuestId": { "type": "string", "minLength": 1, "maxLength": 128 }, "disclosureVersion": { "type": "string", "minLength": 1, "maxLength": 40 }, "disclosureHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 100, "pattern": "^[A-Za-z0-9_-]+$" }, "parentOrigin": { "type": "string", "format": "uri" } }, "required": [ "accepted", "expectedGuestId", "disclosureVersion", "disclosureHash", "idempotencyKey", "parentOrigin" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 20, "maxLength": 4096 }, "in": "header", "name": "x-kismet-guest-token", "required": true, "description": "Verified guest access token held by your same-origin BFF, never browser JavaScript." }, { "schema": { "type": "string", "minLength": 16, "maxLength": 512 }, "in": "header", "name": "x-kismet-csrf", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "receiptId", "environment", "emailMarketing", "replayed" ], "properties": { "receiptId": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "emailMarketing": { "type": "string", "enum": [ "NEVER_SUBSCRIBED", "PENDING", "SUBSCRIBED", "UNSUBSCRIBED" ] }, "replayed": { "type": "boolean" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Guest Accounts + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview", "x-kismet-required-capability": "guest_preferences.write" } }, "/v1/developer/collections/{collection}/tracked-links": { "post": { "operationId": "createDeveloperTrackedLink", "summary": "Create a tracked link", "tags": [ "developer-tracked-links" ], "description": "Server-only, installation-scoped tracked links. TEST and LIVE come from the credential. Destinations must use HTTPS on an origin registered to the installation. No credentials, authentication links, unsubscribe URLs or personal data should be included. Click observations may include scanners and never prove consent, human activity, payment or redemption.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "destinationUrl": { "type": "string", "format": "uri", "maxLength": 4096 }, "channel": { "type": "string", "enum": [ "email", "application" ] }, "reference": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time" }, "idempotencyKey": { "type": "string", "pattern": "^[A-Za-z0-9_-]{16,200}$" } }, "required": [ "destinationUrl", "channel", "expiresAt", "idempotencyKey" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 160 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "x-kismet-required-capability": "links.write", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "url": { "type": "string", "format": "uri" }, "destinationOrigin": { "type": "string", "format": "uri" }, "channel": { "type": "string", "enum": [ "email", "application" ] }, "reference": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "createdAt": { "type": "string", "format": "date-time" }, "engagement": { "type": "object", "properties": { "clicked": { "type": "boolean" }, "firstClickedAt": { "type": "string", "format": "date-time", "nullable": true }, "humanVerified": { "type": "boolean", "enum": [ false ] }, "redemptionVerified": { "type": "boolean", "enum": [ false ] } }, "required": [ "clicked", "firstClickedAt", "humanVerified", "redemptionVerified" ], "additionalProperties": false } }, "required": [ "id", "environment", "url", "destinationOrigin", "channel", "reference", "expiresAt", "status", "createdAt", "engagement" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview" } }, "/v1/developer/collections/{collection}/tracked-links/{linkId}": { "get": { "operationId": "getDeveloperTrackedLink", "summary": "Read a tracked link and engagement", "tags": [ "developer-tracked-links" ], "description": "Server-only, installation-scoped tracked links. TEST and LIVE come from the credential. Destinations must use HTTPS on an origin registered to the installation. No credentials, authentication links, unsubscribe URLs or personal data should be included. Click observations may include scanners and never prove consent, human activity, payment or redemption.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 160 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "linkId", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "x-kismet-required-capability": "links.read", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "TEST", "LIVE" ] }, "url": { "type": "string", "format": "uri" }, "destinationOrigin": { "type": "string", "format": "uri" }, "channel": { "type": "string", "enum": [ "email", "application" ] }, "reference": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "createdAt": { "type": "string", "format": "date-time" }, "engagement": { "type": "object", "properties": { "clicked": { "type": "boolean" }, "firstClickedAt": { "type": "string", "format": "date-time", "nullable": true }, "humanVerified": { "type": "boolean", "enum": [ false ] }, "redemptionVerified": { "type": "boolean", "enum": [ false ] } }, "required": [ "clicked", "firstClickedAt", "humanVerified", "redemptionVerified" ], "additionalProperties": false } }, "required": [ "id", "environment", "url", "destinationOrigin", "channel", "reference", "expiresAt", "status", "createdAt", "engagement" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview" }, "delete": { "operationId": "revokeDeveloperTrackedLink", "summary": "Revoke a tracked link", "tags": [ "developer-tracked-links" ], "description": "Server-only, installation-scoped tracked links. TEST and LIVE come from the credential. Destinations must use HTTPS on an origin registered to the installation. No credentials, authentication links, unsubscribe URLs or personal data should be included. Click observations may include scanners and never prove consent, human activity, payment or redemption.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 160 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "linkId", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "x-kismet-required-capability": "links.write", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "revoked" ] } }, "required": [ "id", "status" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "code", "detail", "requestId", "instance" ], "additionalProperties": false } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state", "x-kismet-maturity": "preview" } }, "/v1/developer/collections/{collection}/articles/imports/plan": { "post": { "operationId": "planArticleImport", "summary": "plan Article Import", "tags": [ "developer-articles" ], "description": "Import canonical Articles as isolated drafts. Review the returned immutable revision and explicitly publish it to staging. Production Article reads and serving routes remain unchanged. Requires collection-scoped server credentials; content channel is independent of TEST/LIVE transaction mode.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "expectedRevision": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" }, "title": { "type": "string", "minLength": 1, "maxLength": 500 }, "sourcePublishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "excerpt": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "hero": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "caption": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "url", "alt" ], "additionalProperties": false }, { "type": "null" } ] }, "body": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "prose" ] }, "html": { "type": "string", "minLength": 1, "maxLength": 100000 } }, "required": [ "type", "html" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image" ] }, "src": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "caption": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "type", "src", "alt" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "pullquote" ] }, "text": { "type": "string", "minLength": 1, "maxLength": 5000 }, "cite": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "faq" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "q": { "type": "string", "minLength": 1, "maxLength": 500 }, "a": { "type": "string", "minLength": 1, "maxLength": 5000 } }, "required": [ "q", "a" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 } }, "required": [ "type", "items" ], "additionalProperties": false } ] }, "minItems": 1, "maxItems": 200 }, "authorId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 30, "default": [] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false } }, "required": [ "slug", "title", "body", "source" ], "additionalProperties": false } }, "required": [ "key", "expectedRevision", "document" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.write", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create", "update" ] }, "planDigest": { "type": "string" }, "input": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "expectedRevision": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" }, "title": { "type": "string", "minLength": 1, "maxLength": 500 }, "sourcePublishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "excerpt": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "hero": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "caption": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "url", "alt" ], "additionalProperties": false }, { "type": "null" } ] }, "body": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "prose" ] }, "html": { "type": "string", "minLength": 1, "maxLength": 100000 } }, "required": [ "type", "html" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image" ] }, "src": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "caption": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "type", "src", "alt" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "pullquote" ] }, "text": { "type": "string", "minLength": 1, "maxLength": 5000 }, "cite": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "faq" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "q": { "type": "string", "minLength": 1, "maxLength": 500 }, "a": { "type": "string", "minLength": 1, "maxLength": 5000 } }, "required": [ "q", "a" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 } }, "required": [ "type", "items" ], "additionalProperties": false } ] }, "minItems": 1, "maxItems": 200 }, "authorId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 30, "default": [] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false } }, "required": [ "slug", "title", "body", "source" ], "additionalProperties": false } }, "required": [ "key", "expectedRevision", "document" ], "additionalProperties": false }, "path": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } } }, "required": [ "action", "planDigest", "input", "path", "warnings" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/articles/imports/apply": { "post": { "operationId": "applyArticleImport", "summary": "apply Article Import", "tags": [ "developer-articles" ], "description": "Import canonical Articles as isolated drafts. Review the returned immutable revision and explicitly publish it to staging. Production Article reads and serving routes remain unchanged. Requires collection-scoped server credentials; content channel is independent of TEST/LIVE transaction mode.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "expectedRevision": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "document": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" }, "title": { "type": "string", "minLength": 1, "maxLength": 500 }, "sourcePublishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "excerpt": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "hero": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "caption": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "url", "alt" ], "additionalProperties": false }, { "type": "null" } ] }, "body": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "prose" ] }, "html": { "type": "string", "minLength": 1, "maxLength": 100000 } }, "required": [ "type", "html" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image" ] }, "src": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "caption": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "type", "src", "alt" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "pullquote" ] }, "text": { "type": "string", "minLength": 1, "maxLength": 5000 }, "cite": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "faq" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "q": { "type": "string", "minLength": 1, "maxLength": 500 }, "a": { "type": "string", "minLength": 1, "maxLength": 5000 } }, "required": [ "q", "a" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 } }, "required": [ "type", "items" ], "additionalProperties": false } ] }, "minItems": 1, "maxItems": 200 }, "authorId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 30, "default": [] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false } }, "required": [ "slug", "title", "body", "source" ], "additionalProperties": false }, "planDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "idempotencyKey": { "type": "string", "minLength": 8, "maxLength": 128 } }, "required": [ "key", "expectedRevision", "document", "planDigest", "idempotencyKey" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.write", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "articleId": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "createdAt": { "type": "string", "format": "date-time" }, "document": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" }, "title": { "type": "string", "minLength": 1, "maxLength": 500 }, "sourcePublishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "excerpt": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "hero": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "caption": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "url", "alt" ], "additionalProperties": false }, { "type": "null" } ] }, "body": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "prose" ] }, "html": { "type": "string", "minLength": 1, "maxLength": 100000 } }, "required": [ "type", "html" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image" ] }, "src": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "caption": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "type", "src", "alt" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "pullquote" ] }, "text": { "type": "string", "minLength": 1, "maxLength": 5000 }, "cite": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "faq" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "q": { "type": "string", "minLength": 1, "maxLength": 500 }, "a": { "type": "string", "minLength": 1, "maxLength": 5000 } }, "required": [ "q", "a" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 } }, "required": [ "type", "items" ], "additionalProperties": false } ] }, "minItems": 1, "maxItems": 200 }, "authorId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 30, "default": [] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false } }, "required": [ "slug", "title", "body", "source" ], "additionalProperties": false } }, "required": [ "id", "articleId", "collectionId", "key", "revision", "createdAt", "document" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/articles/imports/revisions/{id}": { "get": { "operationId": "getArticleImportRevision", "summary": "get Article Import Revision", "tags": [ "developer-articles" ], "description": "Import canonical Articles as isolated drafts. Review the returned immutable revision and explicitly publish it to staging. Production Article reads and serving routes remain unchanged. Requires collection-scoped server credentials; content channel is independent of TEST/LIVE transaction mode.", "parameters": [ { "schema": { "type": "boolean" }, "in": "query", "name": "includeSourceDates", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.drafts.read", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "articleId": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string" }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,79}$" }, "revision": { "type": "integer", "exclusiveMinimum": 0 }, "createdAt": { "type": "string", "format": "date-time" }, "document": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" }, "title": { "type": "string", "minLength": 1, "maxLength": 500 }, "sourcePublishedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "excerpt": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ] }, "hero": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "caption": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "url", "alt" ], "additionalProperties": false }, { "type": "null" } ] }, "body": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "prose" ] }, "html": { "type": "string", "minLength": 1, "maxLength": 100000 } }, "required": [ "type", "html" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image" ] }, "src": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "caption": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "type", "src", "alt" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "pullquote" ] }, "text": { "type": "string", "minLength": 1, "maxLength": 5000 }, "cite": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "faq" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "q": { "type": "string", "minLength": 1, "maxLength": 500 }, "a": { "type": "string", "minLength": 1, "maxLength": 5000 } }, "required": [ "q", "a" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 } }, "required": [ "type", "items" ], "additionalProperties": false } ] }, "minItems": 1, "maxItems": 200 }, "authorId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 30, "default": [] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "imported" ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "url", "capturedAt", "sha256" ], "additionalProperties": false } }, "required": [ "slug", "title", "body", "source" ], "additionalProperties": false } }, "required": [ "id", "articleId", "collectionId", "key", "revision", "createdAt", "document" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/articles/imports/revisions/{id}/publish": { "post": { "operationId": "publishArticleStagingRevision", "summary": "publish Article Staging Revision", "tags": [ "developer-articles" ], "description": "Import canonical Articles as isolated drafts. Review the returned immutable revision and explicitly publish it to staging. Production Article reads and serving routes remain unchanged. Requires collection-scoped server credentials; content channel is independent of TEST/LIVE transaction mode.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string", "enum": [ "staging" ] }, "expectedPublishedRevisionId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "channel", "expectedPublishedRevisionId" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "content.publish", "x-kismet-maturity": "preview", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string", "enum": [ "staging" ] }, "articleId": { "type": "string", "format": "uuid" }, "revisionId": { "type": "string", "format": "uuid" }, "path": { "type": "string" }, "publishedAt": { "type": "string", "format": "date-time" } }, "required": [ "channel", "articleId", "revisionId", "path", "publishedAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/media/imports/plan": { "post": { "operationId": "planCollectionMediaImport", "summary": "plan Collection Media Import", "tags": [ "developer-media" ], "description": "Collection-owned image library import. Plan first, then confirm the exact digest. Persistent jobs and authority fail closed; HTTPS DNS/redirect checks, MIME/bytes/pixel/10 MiB bounds apply before the canonical uploader. Four new jobs per collection per refill hour, up to 50 images per job. Source query strings remain private. This does not publish Articles or activate serving routes. Jobs/results expire after 24 hours; explicit resume skips already settled sources. CMS library writes are distinct from TEST/LIVE booking authority.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "urls": { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "src" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 } }, "required": [ "requestId", "urls" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "media.import", "x-kismet-maturity": "preview", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "collectionId": { "type": "string", "format": "uuid" }, "input": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "urls": { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "src" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 } }, "required": [ "requestId", "urls" ], "additionalProperties": false }, "planDigest": { "type": "string" }, "publication": { "type": "string", "enum": [ "library_only" ] }, "warnings": { "type": "array", "items": { "type": "string" } } }, "required": [ "collectionId", "input", "planDigest", "publication", "warnings" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/media/imports": { "post": { "operationId": "createCollectionMediaImport", "summary": "create Collection Media Import", "tags": [ "developer-media" ], "description": "Collection-owned image library import. Plan first, then confirm the exact digest. Persistent jobs and authority fail closed; HTTPS DNS/redirect checks, MIME/bytes/pixel/10 MiB bounds apply before the canonical uploader. Four new jobs per collection per refill hour, up to 50 images per job. Source query strings remain private. This does not publish Articles or activate serving routes. Jobs/results expire after 24 hours; explicit resume skips already settled sources. CMS library writes are distinct from TEST/LIVE booking authority.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "urls": { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string", "format": "uri", "maxLength": 2048 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "src" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 }, "planDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "confirm": { "type": "boolean", "enum": [ true ] } }, "required": [ "requestId", "urls", "planDigest", "confirm" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "media.import", "x-kismet-maturity": "preview", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed" ] }, "publication": { "type": "string", "enum": [ "library_only" ] }, "totalCount": { "type": "integer", "minimum": 0 }, "processedCount": { "type": "integer", "minimum": 0 }, "importedCount": { "type": "integer", "minimum": 0 }, "existingCount": { "type": "integer", "minimum": 0 }, "failedCount": { "type": "integer", "minimum": 0 }, "results": { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "status": { "type": "string", "enum": [ "imported", "existing", "failed" ] }, "image": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "url" ], "additionalProperties": false }, "code": { "type": "string" } }, "required": [ "src", "status" ], "additionalProperties": false } }, "errorCode": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "collectionId", "status", "publication", "totalCount", "processedCount", "importedCount", "existingCount", "failedCount", "results", "errorCode", "createdAt", "updatedAt", "expiresAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/media/imports/{id}": { "get": { "operationId": "getCollectionMediaImport", "summary": "get Collection Media Import", "tags": [ "developer-media" ], "description": "Collection-owned image library import. Plan first, then confirm the exact digest. Persistent jobs and authority fail closed; HTTPS DNS/redirect checks, MIME/bytes/pixel/10 MiB bounds apply before the canonical uploader. Four new jobs per collection per refill hour, up to 50 images per job. Source query strings remain private. This does not publish Articles or activate serving routes. Jobs/results expire after 24 hours; explicit resume skips already settled sources. CMS library writes are distinct from TEST/LIVE booking authority.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "media.read", "x-kismet-maturity": "preview", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed" ] }, "publication": { "type": "string", "enum": [ "library_only" ] }, "totalCount": { "type": "integer", "minimum": 0 }, "processedCount": { "type": "integer", "minimum": 0 }, "importedCount": { "type": "integer", "minimum": 0 }, "existingCount": { "type": "integer", "minimum": 0 }, "failedCount": { "type": "integer", "minimum": 0 }, "results": { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "status": { "type": "string", "enum": [ "imported", "existing", "failed" ] }, "image": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "url" ], "additionalProperties": false }, "code": { "type": "string" } }, "required": [ "src", "status" ], "additionalProperties": false } }, "errorCode": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "collectionId", "status", "publication", "totalCount", "processedCount", "importedCount", "existingCount", "failedCount", "results", "errorCode", "createdAt", "updatedAt", "expiresAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/collections/{collection}/media/imports/{id}/resume": { "post": { "operationId": "resumeCollectionMediaImport", "summary": "resume Collection Media Import", "tags": [ "developer-media" ], "description": "Collection-owned image library import. Plan first, then confirm the exact digest. Persistent jobs and authority fail closed; HTTPS DNS/redirect checks, MIME/bytes/pixel/10 MiB bounds apply before the canonical uploader. Four new jobs per collection per refill hour, up to 50 images per job. Source query strings remain private. This does not publish Articles or activate serving routes. Jobs/results expire after 24 hours; explicit resume skips already settled sources. CMS library writes are distinct from TEST/LIVE booking authority.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm": { "type": "boolean", "enum": [ true ] } }, "required": [ "confirm" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "collection", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "security": [ { "kismetDeveloperKey": [] } ], "x-kismet-required-capability": "media.import", "x-kismet-maturity": "preview", "x-kismet-credential-kinds": [ "SERVER_SECRET" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "collectionId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed" ] }, "publication": { "type": "string", "enum": [ "library_only" ] }, "totalCount": { "type": "integer", "minimum": 0 }, "processedCount": { "type": "integer", "minimum": 0 }, "importedCount": { "type": "integer", "minimum": 0 }, "existingCount": { "type": "integer", "minimum": 0 }, "failedCount": { "type": "integer", "minimum": 0 }, "results": { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "status": { "type": "string", "enum": [ "imported", "existing", "failed" ] }, "image": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "url" ], "additionalProperties": false }, "code": { "type": "string" } }, "required": [ "src", "status" ], "additionalProperties": false } }, "errorCode": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "collectionId", "status", "publication", "totalCount", "processedCount", "importedCount", "existingCount", "failedCount", "results", "errorCode", "createdAt", "updatedAt", "expiresAt" ], "additionalProperties": false } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "title", "status", "code", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "Developer Platform", "x-kismet-quota-cost": 1, "x-kismet-freshness": "authenticated-state" } }, "/v1/developer/vacation-rental-manager/reviews": { "get": { "operationId": "listVacationRentalManagerReviews", "summary": "List published reviews across a vacation rental manager", "tags": [ "developer-published-resources" ], "description": "Returns collection-wide published reviews, newest first. Ratings are normalized to a 1–5 scale before minRating filtering; Booking.com raw ratings use a 1–10 scale and are divided by two. meta.aggregate covers all public reviews of published homes in the granted collection, regardless of recentDays, minRating or pagination. reviewCount includes unrated reviews; ratedReviewCount is the denominator of overallRating (null when none are rated). stayMonth is emitted only when the review raw payload matches a stored reservation confirmation code.", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 60 }, "in": "query", "name": "recentDays", "required": false, "description": "Include reviews from this many days before the request time." }, { "schema": { "type": "number", "minimum": 1, "maximum": 5 }, "in": "query", "name": "minRating", "required": false, "description": "Minimum normalized 1–5 rating." }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "cursor", "required": false } ], "security": [ { "kismetDeveloperKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "page", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "channel", "overallRating", "reviewText", "hostResponse", "reviewerDisplayName", "reviewDate", "categoryRatings", "personas", "features", "season", "platform", "vacationRental" ], "properties": { "id": { "type": "string" }, "channel": { "type": "string" }, "overallRating": { "type": [ "null", "number" ] }, "reviewText": { "type": [ "null", "string" ] }, "hostResponse": { "type": [ "null", "string" ] }, "reviewerDisplayName": { "type": [ "null", "string" ] }, "reviewDate": { "type": [ "null", "string" ], "format": "date-time" }, "categoryRatings": { "type": "object", "additionalProperties": false, "required": [ "cleanliness", "accuracy", "checkin", "communication", "location", "value" ], "properties": { "cleanliness": { "type": [ "null", "number" ] }, "accuracy": { "type": [ "null", "number" ] }, "checkin": { "type": [ "null", "number" ] }, "communication": { "type": [ "null", "number" ] }, "location": { "type": [ "null", "number" ] }, "value": { "type": [ "null", "number" ] } } }, "personas": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "slug", "label", "confidence", "source" ], "properties": { "slug": { "type": "string" }, "label": { "type": "string" }, "confidence": { "type": [ "null", "number" ] }, "source": { "type": "string", "enum": [ "ai", "manual" ] } } } }, "features": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "slug", "label", "confidence", "source" ], "properties": { "slug": { "type": "string" }, "label": { "type": "string" }, "confidence": { "type": [ "null", "number" ] }, "source": { "type": "string", "enum": [ "ai", "manual" ] } } } }, "season": { "anyOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "season", "source" ], "properties": { "season": { "type": "string" }, "source": { "type": "string", "enum": [ "derived", "ai", "manual" ] } } } ] }, "platform": { "type": "string", "enum": [ "airbnb", "vrbo", "booking", "other" ], "description": "Normalized platform; Booking.com ratings are normalized from 1–10 to 1–5 before filtering." }, "stayMonth": { "type": "string", "pattern": "^\\d{4}-\\d{2}$" }, "vacationRental": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } } } } }, "page": { "type": "object", "additionalProperties": false, "required": [ "nextCursor", "limit" ], "properties": { "nextCursor": { "type": [ "null", "string" ] }, "limit": { "type": "integer" } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "asOf", "recentDays" ], "properties": { "asOf": { "type": "string", "format": "date-time" }, "recentDays": { "type": [ "null", "integer" ] }, "aggregate": { "type": "object", "additionalProperties": false, "required": [ "overallRating", "reviewCount", "ratedReviewCount", "scope" ], "properties": { "overallRating": { "type": [ "null", "number" ], "minimum": 0, "maximum": 5 }, "reviewCount": { "type": "integer", "minimum": 0 }, "ratedReviewCount": { "type": "integer", "minimum": 0 }, "scope": { "type": "string", "enum": [ "published_collection" ] } } } } } } }, "example": { "data": [ { "id": "44444444-4444-4444-8444-444444444444", "channel": "airbnb2", "platform": "airbnb", "overallRating": 5, "reviewText": "Wonderful stay — spotless and quiet.", "hostResponse": null, "reviewerDisplayName": "Jamie", "reviewDate": "2026-05-20T00:00:00.000Z", "categoryRatings": { "cleanliness": 5, "accuracy": 5, "checkin": 5, "communication": 5, "location": 4.5, "value": 5 }, "personas": [], "features": [], "season": null, "stayMonth": "2026-04", "vacationRental": { "id": "11111111-1111-4111-8111-111111111111", "slug": "safe-cabin", "name": "Safe Cabin" } } ], "page": { "limit": 20, "nextCursor": null }, "meta": { "asOf": "2026-05-20T00:00:00.000Z", "recentDays": 15, "aggregate": { "overallRating": 4.7, "reviewCount": 120, "ratedReviewCount": 118, "scope": "published_collection" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } }, "headers": { "RateLimit-Limit": { "description": "Requests permitted in the current window", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "string" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying", "schema": { "type": "string" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "type", "title", "status", "detail", "code", "requestId", "instance" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "instance": { "type": "string" } } } } } } }, "x-kismet-owner": "API + Developer Experience", "x-kismet-quota-cost": 1, "x-kismet-freshness": "published-content", "x-kismet-maturity": "beta", "x-kismet-required-capability": "reviews.read" } } }, "x-kismet-contract-extensions": { "inline-email-signup": "0.7.31", "portable-email-links": "0.7.32", "resumed-offer-attribution": "0.7.33", "tracked-links": "0.7.35", "editable-rental-highlights": "0.7.38", "article-imports": "0.7.46", "collection-media-imports": "0.7.46", "root-editorial-pages": "0.7.46", "bounded-nearby-places": "0.7.46", "manager-review-totals": "0.7.43" }, "x-kismet-base-contract-version": "0.7.29", "components": { "securitySchemes": { "kismetDeveloperKey": { "type": "http", "scheme": "bearer", "description": "Kismet developer credential. Publishable keys (`kismet_pk_…`) are browser-safe, origin-bound reads: requests must carry an Origin header exactly matching an allowed origin on the installation. Server keys (`kismet_sk_…`) are secret and server-side only; individual operations can additionally require an exact registered website origin. Credentials are installation-scoped: every request is authorized against the installation’s positive capability grants and collection/entity scope. Revocation is immediate." } } } }