Skip to main content
POST
Submit a Decisions request

Authorizations

Authorization
string
header
required

API key as bearer token in Authorization header

Body

application/json
model
string
required
questions
object
required
state
required

The content to evaluate: a plain string, or a JSON object or array of related context.

assets
object

Images keyed by reference string, as in TypeSafe's API. Write a reference wherever the image belongs in state, instructions, or criteria; every asset must be referenced at least once, or the request fails with 400 naming the unused key. TypeSafe Jev endpoints receive assets as written and read a reference as a whole string value or inside longer text. Every other provider has each whole-string reference resolved to an image_url part before the request is sent, so it is accepted only where that provider reads image_url parts (top-level state items), and a reference inside longer text fails with 400. image_url parts and assets can be mixed in one request.

provider
object | null

Provider routing preferences for the request.

Example:
session_id
string

A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters.

Maximum string length: 256
Example:

"session-1234"

trace
object

Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.

Example:
user
string
Maximum string length: 256

Response

Decisions response

answers
object
required
model
string
required
usage
object
required
id
string
provider
string