Recommend

POST /api/v1/recommend runs the tenant’s published decision flow for one customer and returns a ranked list of offers, each tagged with an interactionId and recommendationId for downstream attribution. The route is the production hot path for next-best-action delivery.

What it does

The handler at src/app/api/v1/recommend/route.ts resolves a DecisionFlow for the (tenant, channel, placement) tuple, then hands execution to executeDecisionFlow in src/lib/decision-flow-engine.ts. The engine walks the flow’s nodes (Enrich → Qualify → Score → Rank → Compute) and returns a DecisionFlowResult declared at src/lib/decision-flow-engine.ts:69-97 that contains the ranked candidates plus a compact traceSummary. Resolution preference is explicit > routed > auto-selected: an explicit decisionFlowKey (or legacy blueprintKey) wins (route.ts:755-770); if absent, a FlowRoute lookup runs (route.ts:939-945); if no route matches, the most recently updated published or active flow is picked (route.ts:947-955); if no flows exist, ensureBaseFlow lazy-creates a base flow on the first call (route.ts:1278-1284). The route has two synchronous side effects per call. Every returned decision is written to interaction_history as a recommendation row so POST /api/v1/respond can look it up by recommendationId + rank (route.ts:1067-1086). Decisions whose channel does not require explicit impression tracking are also auto-recorded as impression rows in the same partitioned table (route.ts:999-1038). Both writes use raw SQL because Prisma’s createMany({ skipDuplicates }) emits ON CONFLICT (id) which is invalid against a composite primary key on a partitioned table.

Quick start

curl -X POST https://playground.kaireonai.com/api/v1/recommend \
  -H "Content-Type: application/json" \
  -H "X-API-Key: krn_your_api_key" \
  -H "X-Tenant-Id: 5a9904b9-..." \
  -d '{
    "customerId": "cust_42",
    "channel": "email",
    "placement": "hero_banner",
    "limit": 3,
    "sessionId": "9b1d-4e6c",
    "attributes": { "tier": "gold" },
    "locale": "en-US",
    "currency": "USD"
  }'

Response (single-placement shape, abbreviated):

{
  "interactionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "recommendationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "customerId": "cust_42",
  "sessionId": "9b1d-4e6c",
  "decisionFlowKey": "main",
  "decisionFlowVersion": 7,
  "experimentVariant": null,
  "controlGroup": false,
  "direction": "inbound",
  "timestamp": "2026-04-30T14:22:01.123Z",
  "channel": "email",
  "placement": "hero_banner",
  "locale": "en-US",
  "currency": "USD",
  "count": 3,
  "decisions": [
    {
      "rank": 1,
      "score": 0.84,
      "offerId": "off_premium_card",
      "offerName": "Premium Travel Card",
      "channelName": "Email",
      "channelType": "email",
      "placementId": "plc_hero",
      "placementName": "Hero Banner",
      "categoryId": "cat_credit",
      "categoryName": "Credit Cards",
      "subCategory": "Travel",
      "mandatory": false,
      "priority": 80,
      "weight": 100,
      "creativeId": "crv_email_a",
      "creativeName": "Email Variant A",
      "templateType": "html",
      "content": "...",
      "properties": {},
      "abTestVariant": null,
      "constraints": {},
      "expiresAt": null,
      "metadata": {},
      "scoreExplanation": {
        "method": "priority_weighted",
        "priority": 80,
        "weight": 100,
        "fitMultiplier": 1.0,
        "finalScore": 0.84
      },
      "personalization": { "personalized_rate": 4.99, "greeting": "Welcome back" },
      "impressionId": "imp_a3f1..."
    }
  ],
  "meta": {
    "totalCandidates": 12,
    "afterQualification": 8,
    "afterSuppression": 8,
    "afterContactPolicy": 6,
    "degradedScoring": false
  }
}

How it works

Authentication and quota

Every call goes through requireTenant at src/lib/tenant.ts:88. Requests carrying an X-API-Key that starts with krn_ are validated against the database and the bound tenantId is used (header X-Tenant-Id is ignored to prevent spoofing); other requests fall back to getTenantId(request). Missing tenant context returns 401 (tenant.ts:117); a tenantId that doesn’t exist in the DB returns 403 (tenant.ts:128). After auth, the handler enforces rate limits via rateLimit in src/lib/rate-limit-unified.ts and a lifetime decision quota via enforceDecisionQuota in src/lib/licensing/middleware.ts:5. Playground tenants are capped at 5,000 lifetime decisions (src/lib/licensing/meter.ts:78); past that the route returns 429 with code PLAYGROUND_QUOTA_EXCEEDED. Non-playground tenants face no decision quota.

Anonymous-customer derivation

When customerId is missing or set to "anonymous", the route derives a stable surrogate. With a sessionId present, the surrogate is anon-{sessionId} after validating the session id against ^[a-zA-Z0-9_-]+$ and capping at 64 chars (route.ts:734-740). Without a session id, the surrogate is anon-{8-hex} derived from an FNV-1a hash of x-forwarded-for + user-agent (route.ts:741-751). The GET handler runs the same derivation at route.ts:504-515.

Decision-flow resolution

Resolution order:

Explicit decisionFlowKey (or legacy blueprintKey) in the body. If the value is not a key, the route attempts a case-insensitive name lookup and rewrites it to a key (route.ts:755-770).
FlowRoute lookup keyed by (tenantId, channelId | channel, placement), cached for 120s under route:{tenantId}:{channelId}:{placement} (route.ts:213, 423-486).
Most recently updated published or active flow (route.ts:947-955).
If no flow exists, ensureBaseFlow lazy-creates a base flow on the first call (route.ts:1278-1284).

If none of these produce a key, the handler returns 400 No published decision flow found. (route.ts:1284-1286).

Kill switch and control group

isNbaEnabled(tenantId) reads tenant.settings.nbaEnabled and caches the result for 60s under nba-enabled:{tenantId} (route.ts:282-305). When the flag is false, the route bypasses flow execution and returns the fallbackPriorityResponse shape at route.ts:340-393 (offers sorted by priority descending, with nbaEnabled: false and meta.fallbackMode = "priority_only"). isInControlGroup(customerId, controlGroupPercent) runs an FNV-1a hash of control:{customerId}:{YYYY-MM-DD} to deterministically bucket the customer for the day (route.ts:175-186). The percentage is read from tenant.settings.controlGroupPercent (default 2%, cached 60s under control-group-pct:{tenantId} at route.ts:191-211). Control-group decisions keep qualification and contact-policy filtering but get scores randomized via the same hash function so the rank order is independent of the model.

Engine execution

executeDecisionFlow(decisionFlowKey, ctx) returns DecisionFlowResult declared at src/lib/decision-flow-engine.ts:69-97:

{
  now: Date,
  results: any[],
  customerId: string,
  decisionFlowId: string,
  decisionFlowVersion: number | null,
  variantName: string | null,
  traceSummary: { totalCandidates, afterQualification, afterSuppression, afterContactPolicy, topScores },
  degradedScoring?: boolean,
  debugTrace?: { ... }   // only when ctx.debug = true
}

Per-decision shape produced by the response node is constructed at src/lib/pipeline-runner.ts:2282-2316. scoreExplanation is set on every decision (pipeline-runner.ts:2309-2315) and src/__tests__/integration/block7-response-validation.integration.test.ts:227-236 asserts it must be present.

Realtime EXP3-IX bandit

When tenantSettings.aiAnalyzerSettings.arbitration.exp3IxEnabled is true and arms are configured, selectBanditArmForRecommend at src/lib/arbitration/apply-online-tuning.ts:167 samples one arm before flow execution. The picked armIndex and armId thread into the auto-impression’s response JSON (route.ts:1011-1014) and into the top-level response body (route.ts:1254-1256 for the explicit-key path, route.ts:1407-1411 for the auto-resolve path). When the flag is off or no arms are configured, the call returns null and the response omits banditArmIndex. See EXP3-IX Arbitration for arm configuration.

Side effects

The auto-impression block at route.ts:999-1038 filters decisions whose channel impressionMode !== "explicit" and inserts one impression row per decision via prisma.$executeRaw. The recommendation-recording block at route.ts:1067-1086 then inserts one recommendation row per decision. Both blocks loop sequentially — N decisions produce up to 2N round-trips against the partitioned interaction_history table. This is intentional: a single batch INSERT … ON CONFLICT (id) DO NOTHING cannot be expressed against a composite primary key on a partitioned table.

Reference

Request body

The POST body is read field-by-field at route.ts:714-776 rather than validated against a single Zod schema. Per-field shape requirements live in the destructure and the inline checks below it. The batch endpoint at /api/v1/recommend/batch does use a single Zod schema, BatchRecommendSchema at src/lib/api-validate.ts:782-790.

customerId

string

default:"anonymous"

Unique customer identifier. When omitted or set to "anonymous", the route derives a stable surrogate from sessionId (preferred) or x-forwarded-for + user-agent (route.ts:732-751).

channel

string

Filter candidates to creatives whose channel matches this channel type or name (route.ts:716).

channelId

string

Channel ID (UUID) used for FlowRoute lookup. When supplied, takes precedence over channel for routing (route.ts:729, 800).

placement

string

Filter candidates to creatives bound to this placement (route.ts:717).

placements

array

Multi-placement request. Each entry is { placementId: string, limit?: number }. When present, the response is the multi-placement shape and the single-placement fields are omitted (route.ts:728, 791-935).

deduplicate

boolean

default:"false"

Multi-placement only. When true, placements are resolved sequentially and each placement excludes offers already returned by earlier placements (route.ts:795, 865-890).

limit

number

default:"5"

Maximum decisions returned. Clamped to [1, 50] (route.ts:778).

sessionId

string

Session identifier. Used both for anonymous-customer derivation and for echoing back into the response and the auto-impression’s context (route.ts:719, 736-740, 1011). Validated as alphanumeric/-/_, max 64 chars.

context

object

default:"{}"

Free-form real-time context (device, page URL, etc.) merged into the auto-impression’s context JSON (route.ts:720, 1011).

segments

array

default:"[]"

Customer segment ids passed through to the engine for qualification rules that match against segments (route.ts:721).

attributes

object

default:"{}"

Per-request customer attributes. Available to the Compute stage as attributes.<key> variables when evaluating computed-field formulas (route.ts:722, decision-flow-engine.ts:331-333).

locale

string

Locale code (e.g. en-US). Echoed back in the response; reserved for content selection in future stages (route.ts:723).

currency

string

Currency code (e.g. USD). Echoed back in the response (route.ts:724).

direction

string

default:"inbound"

inbound or outbound. Stored on the recommendation interaction row (route.ts:725, 1078).

excludeOffers

array

default:"[]"

Offer IDs to exclude from candidates. Legacy alias excludeActions is also accepted (route.ts:775).

excludeCreatives

array

default:"[]"

Creative IDs to exclude. Legacy alias excludeTreatments is also accepted (route.ts:776).

decisionFlowKey

string

Explicit flow key (or name — case-insensitive name lookup runs at route.ts:762-768). Legacy alias blueprintKey is also accepted (route.ts:755).

debug

boolean

default:"false"

When true, the engine attaches a debugTrace block (per-rule pass/fail reasons) to the response (route.ts:773, decision-flow-engine.ts:87-96).

explain

boolean

default:"false"

When true, the route adds an explanation object to each decision and a rejectedOffers[] block built from the debug trace (route.ts:772, 1207-1234). Implies debug: true.

Response (single-placement)

Shape returned at route.ts:1236-1266 (explicit-key path) and route.ts:1389-1420 (auto-resolve path).

{
  "interactionId": "uuid",
  "recommendationId": "uuid",
  "customerId": "cust_42",
  "sessionId": "9b1d-4e6c",
  "decisionFlowKey": "main",
  "decisionFlowVersion": 7,
  "experimentVariant": null,
  "controlGroup": false,
  "direction": "inbound",
  "timestamp": "2026-04-30T14:22:01.123Z",
  "channel": "email",
  "placement": "hero_banner",
  "locale": "en-US",
  "currency": "USD",
  "count": 3,
  "decisions": [ /* see decisions[] below */ ],
  "banditArmIndex": 2,
  "banditArmId": "arm_b",
  "meta": {
    "totalCandidates": 12,
    "afterQualification": 8,
    "afterSuppression": 8,
    "afterContactPolicy": 6,
    "degradedScoring": false,
    "negotiationApply": { "applied": 1, "rejected": 0 }
  }
}

interactionId

string

UUID minted at the start of the request (route.ts:779). Echoed in the auto-impression’s response.interactionId and the recommendation row’s response.interactionId.

recommendationId

string

Same value as interactionId. Use either when calling POST /api/v1/respond.

customerId

string

Either the supplied customerId or the derived anonymous surrogate.

sessionId

string | null

Echoed back from the request body.

decisionFlowKey

string

Key of the flow that ran. In the explicit-key path the value reflects the raw request input (after name-to-key translation); in the auto-resolve path it reflects the resolved key.

decisionFlowVersion

number | null

Version number of the flow’s publishedVersions snapshot, or null when running from draftConfig (decision-flow-engine.ts:584-597).

experimentVariant

string | null

Variant name when the flow has an experiment node and the customer was assigned a variant.

controlGroup

boolean

True when the customer was bucketed into the always-on control group for the current UTC day (route.ts:175-186).

direction

string

Echoed from the request body, default "inbound".

timestamp

string

ISO timestamp from bpResult.now, set when the engine started.

channel

string

Echoed from the channel request field, or "all" when none was supplied.

placement

string

Echoed from the placement request field, or "all" when none was supplied.

locale

string | null

Echoed from the request body.

currency

string | null

Echoed from the request body.

count

number

Number of items in decisions[] after the per-request limit was applied.

decisions

array

Ranked offers. See the per-decision sub-fields below.

rejectedOffers

array

Present only when explain=true and the debug trace contains rejection reasons (route.ts:1253). Each entry is { offerId, offerName, stage: "eligibility" | "contact_policy", reason }.

banditArmIndex

number

Present only when EXP3-IX is enabled for the tenant AND tenantSettings.aiAnalyzerSettings.arbitration has configured arms. Set by selectBanditArmForRecommend at src/lib/arbitration/apply-online-tuning.ts:167 and threaded into the response at route.ts:1254-1256.

banditArmId

string

Companion to banditArmIndex. Echo this value back into interaction.response when calling /respond so the arm’s log-weight gets updated on outcome.

`decisions[]` per-item shape

Built at src/lib/pipeline-runner.ts:2282-2316.

rank

number

1-based rank after sorting and any control-group reshuffle.

score

number

Final score from the scorer (or randomized in control group).

offerId

string

offerName

string

channelName

string | null

Joined from creative.channel.name.

channelType

string | null

Joined from creative.channel.channelType.

placementId

string | null

placementName

string | null

Joined from creative.placement.name.

categoryId

string | null

categoryName

string | null

Joined from offer.categoryRef.name with fallbacks.

subCategory

string | null

Joined from offer.subCategoryRef.name with fallbacks.

mandatory

boolean

Mirrored from offer.mandatory.

priority

number

Mirrored from the candidate’s priority (driven by offer.priority).

weight

number

default:"100"

Mirrored from the candidate’s weight.

creativeId

string | null

creativeName

string | null

templateType

string | null

From creative.templateType.

content

any

From creative.content.

properties

object

Per-candidate property bag from the engine.

abTestVariant

string | null

From creative.abTestVariant.

constraints

object

From creative.constraints.

expiresAt

string | null

ISO timestamp from offer.expiresAt.

metadata

object

From offer.metadata.

scoreExplanation

object

Set on every decision (pipeline-runner.ts:2309-2315); the integration test at src/__tests__/integration/block7-response-validation.integration.test.ts:227-236 asserts it must be present. Shape: { method, priority, weight, fitMultiplier, finalScore }.

personalization

object

Free-form Record<string, any>. Keys are tenant-defined — they come from the category’s customFields of type computed, plus optional flow-level extras and per-flow overrides. Standard examples include personalized_rate or greeting, but the field set is open. The full evaluation contract lives at src/lib/decision-flow-engine.ts:310-374.

impressionId

string

Present only when the candidate’s channel uses implicit impression tracking and the auto-impression INSERT succeeded. Looked up via deduplicationId and threaded into the decision at route.ts:1043-1051.

appliedNegotiation

object

Present only when the realtime apply-mode wire ran and the candidate was accepted (route.ts:1190-1191). Shape: { sessionId, proposal }.

appliedNegotiationReject

object

Present only when the realtime apply-mode wire rejected the candidate (route.ts:1192). Shape: { sessionId, reason }.

Response (multi-placement)

Returned at route.ts:927-934 when the request body supplies a placements[] array.

{
  "placements": {
    "hero_banner": {
      "offers": [
        {
          "rank": 1,
          "score": 0.84,
          "offerId": "off_a",
          "offerName": "...",
          "creativeId": "crv_x",
          "creativeName": "...",
          "channelName": "Email",
          "categoryName": "Cards",
          "mandatory": false,
          "priority": 80,
          "personalization": {}
        }
      ],
      "count": 1
    }
  },
  "customerId": "cust_42",
  "interactionId": "uuid",
  "recommendationId": "uuid",
  "requestId": "uuid",
  "timestamp": "2026-04-30T14:22:01.123Z"
}

placements

object

Map of placementId → { offers: [...], count: number }. Per-offer keys are a subset of the single-placement shape (no weight, templateType, content, scoreExplanation, impressionId, appliedNegotiation).

customerId

string

interactionId

string

recommendationId

string

Same value as interactionId.

requestId

string

Same value as interactionId and recommendationId (route.ts:932). Multi-placement only — kept for legacy callers that key on requestId.

timestamp

string

ISO timestamp set when the response was assembled.

Response (engine-emitted grouped)

Returned at route.ts:1099-1113 when the executed flow’s last node is a Group node that emits placements (V2 grouped response).

{
  "interactionId": "uuid",
  "recommendationId": "uuid",
  "customerId": "cust_42",
  "timestamp": "2026-04-30T14:22:01.123Z",
  "placements": { "hero_banner": { "offers": [], "count": 0 } },
  "meta": {
    "decisionFlowKey": "main",
    "decisionFlowVersion": 7,
    "experimentVariant": null,
    "totalCandidates": 12,
    "degradedScoring": false
  }
}

The engine-emitted grouped response carries a meta block; the request-driven multi-placement response (when the caller supplies placements: [...]) does not.

GET endpoint

GET /api/v1/recommend accepts a subset of POST body fields as query-string parameters: customerId, channel, placement, limit, decisionFlowKey, explain, debug. The handler is at route.ts:494-677. The GET response omits sessionId, locale, and currency because no request body carries them (route.ts:649-669). GET returns 400 decisionFlowKey is required. Multiple active flows exist: … when more than one published/active flow exists and no decisionFlowKey query parameter is set (route.ts:565-569). POST auto-selects in the same situation (route.ts:947-955).

Status codes

Code	When	Source
200	Successful recommendation	`NextResponse.json` paths in `route.ts`
400	Missing required body fields, invalid JSON, or unresolvable flow	`badRequest` from `src/lib/api-error.ts:55`
400	GET only — multiple active flows exist and no `decisionFlowKey` query param	`route.ts:565-569`
401	Missing tenant context	`tenant.ts:117`
403	Invalid tenant identifier	`tenant.ts:128`
429	Rate limit exceeded OR playground 5,000-decision quota exhausted	`src/lib/rate-limit-unified.ts` + `src/lib/licensing/middleware.ts:20-30`
500	Unexpected server error	`serverError` from `src/lib/api-error.ts:90`
504	Request exceeded the 30s timeout	`src/lib/request-timeout.ts:24-27`

Three different error envelope shapes are emitted by this route:

apiError envelope — used by 400 and 500: { error: { code, message, status, traceId, timestamp } }.
tenant.ts envelope — used by 401 and 403: { title, detail } (tenant.ts:102-105, 117, 128).
504 envelope — { error: { code: "TIMEOUT", message: "Request timed out", status: 504 } } (request-timeout.ts:24-27). Omits traceId and timestamp.

The 429 envelope from the playground quota path is { error: { code, message, used, limit } } (licensing/middleware.ts:20-30); the rate-limiter’s 429 envelope is set by rate-limit-unified.ts.

Required headers

Header	Required	Read at	Purpose
`Content-Type`	POST only	Next.js framework	`application/json` for POST bodies
`X-API-Key`	Yes (one of the two)	`tenant.ts:97`, `rate-limit-unified.ts:68`	API key (`krn_…`) — also used as the rate-limit identifier
`X-Tenant-Id`	Yes (one of the two)	`tenant.ts:113` (via `getTenantId`)	Direct tenant id; ignored when `X-API-Key` resolves a tenant
`X-Forwarded-For`	No	`rate-limit-unified.ts:71`, `route.ts:506, 742`	Falls back to anonymous-id derivation and rate-limit identifier
`User-Agent`	No	`route.ts:507, 743`	Used in the FNV-1a hash for anonymous customers
`x-user-id`	No	`route.ts:924, 1094, 1305`	Triggers `markOnboardingStep` for onboarding tracking only

Authorization: Bearer … is not a supported authentication mode on this route. The middleware reads the Authorization header only to gate CSRF; tenant.ts only verifies X-API-Key (when prefixed with krn_) and X-Tenant-Id.

Configuration

Environment variables

Variable	Effect
`NODE_ENV=test`	Disables rate limiting in the test runner (`rate-limit-unified.ts:101`)

The route does not read any other environment variables directly. Verified via grep 'process.env' on route.ts returning 0 hits. Tenant-level behavior is configured through tenant.settings and tenantSettings.aiAnalyzerSettings.

Caches

Cache key	TTL	What it caches
`route:{tenantId}:{channelId}:{placement}`	120s	`FlowRoute` resolution (`route.ts:213, 429`)
`flowkey:{tenantId}:{flowId}`	120s	Flow id → key lookup (`route.ts:214, 403`)
`flow:{tenantId}:{flowKey}`	60s	Compiled `DecisionFlow` object (`decision-flow-engine.ts:569, 578`)
`nba-enabled:{tenantId}`	60s	Tenant kill-switch check (`route.ts:285, 297`)
`control-group-pct:{tenantId}`	60s	Control-group percentage (`route.ts:194, 205`)
`shap-enabled:{tenantId}`	60s	Whether to compute SHAP in the hot path (`route.ts:318, 328`)

Rate limits

Tenant type	Per-window	Window	Lifetime decision quota
Playground (`tenant.isPlayground = true`)	100	60s	5,000 (`PLAYGROUND_DECISION_LIMIT` at `licensing/meter.ts:78`)
Non-playground	1,000	60s	None (`licensing/middleware.ts:34`)

Rate-limit identifier preference: X-API-Key > X-Forwarded-For > "anonymous" (rate-limit-unified.ts:67-77).

Request timeout

The POST handler is wrapped in withTimeout(handler, 30_000) at route.ts:1429. The GET handler is not wrapped (route.ts:494). On timeout the response is 504 { error: { code: "TIMEOUT", message: "Request timed out", status: 504 } }.

Honest limits

The auto-resolve fallthrough response at route.ts:1389-1420 returns a meta block that omits afterSuppression (compare with the explicit-key path at route.ts:1257-1264 which includes all five counters). Tracked as a code-side cleanup.
Auto-impression and recommendation writes are up to 2N round-trips per request — one prisma.$executeRaw per decision in the impression loop at route.ts:1022-1034, plus one per decision in the recommendation loop at route.ts:1069-1086 — because interaction_history is partitioned and Prisma’s batch INSERT cannot use ON CONFLICT (id) against a composite primary key. A request with limit=50 produces up to 100 sequential SQL round-trips.
The POST body is not validated against a single Zod schema. Field validation is per-read in the handler. The batch endpoint at /api/v1/recommend/batch does use a single Zod schema (BatchRecommendSchema at src/lib/api-validate.ts:782-790).
Authorization: Bearer … is not a supported auth mode. The middleware reads the Authorization header only to gate CSRF; tenant.ts only verifies X-API-Key and X-Tenant-Id.
The 504 timeout envelope shape diverges from the standard apiError envelope — it omits traceId and timestamp (request-timeout.ts:24-27). The 401/403 envelope from tenant.ts uses { title, detail } and is also distinct from the apiError envelope.
Bandit arm-index threading fires only when the tenant has both isExp3IxEnabled(...) true AND configured banditConfig.arms in tenantSettings.aiAnalyzerSettings.arbitration. Without arms it is a structured no-op (no banditArmIndex in the response). See EXP3-IX Arbitration for arm configuration.

Respond API — record the outcome of a recommendation.
Decision Flows — the engine that backs this route.
Decisioning Gates — qualification + contact-policy stages.
Arbitration Profiles — multi-objective scoring weights.

Overview

Core APIs

Studio

Data

Algorithms

Content & Metrics

Orchestration

Customers & Traces

Events & Attribution

Analytics

AI

Testing & Simulation

Export & Import

Admin

What it does

Quick start

How it works

Authentication and quota

Anonymous-customer derivation

Decision-flow resolution

Kill switch and control group

Engine execution

Realtime EXP3-IX bandit

Side effects

Reference

Request body

Response (single-placement)

`decisions[]` per-item shape

Response (multi-placement)

Response (engine-emitted grouped)

GET endpoint

Status codes

Required headers

Configuration

Environment variables

Caches

Rate limits

Request timeout

Honest limits

Overview

Core APIs

Studio

Data

Algorithms

Content & Metrics

Orchestration

Customers & Traces

Events & Attribution

Analytics

AI

Testing & Simulation

Export & Import

Admin

Documentation Index

​What it does

​Quick start

​How it works

​Authentication and quota

​Anonymous-customer derivation

​Decision-flow resolution

​Kill switch and control group

​Engine execution

​Realtime EXP3-IX bandit

​Side effects

​Reference

​Request body

​Response (single-placement)

​decisions[] per-item shape

​Response (multi-placement)

​Response (engine-emitted grouped)

​GET endpoint

​Status codes

​Required headers

​Configuration

​Environment variables

​Caches

​Rate limits

​Request timeout

​Honest limits

​Related

What it does

Quick start

How it works

Authentication and quota

Anonymous-customer derivation

Decision-flow resolution

Kill switch and control group

Engine execution

Realtime EXP3-IX bandit

Side effects

Reference

Request body

Response (single-placement)

`decisions[]` per-item shape

Response (multi-placement)

Response (engine-emitted grouped)

GET endpoint

Status codes

Required headers

Configuration

Environment variables

Caches

Rate limits

Request timeout

Honest limits

Related