Skip to main content
POST
Create or join a Synthetic Book definition

Authorizations

X-Client-Id
string
header
required

Credential client id (kairos_ck_...). Must be sent together with X-Api-Key and X-Api-Secret.

X-Api-Key
string
header
required

64-char hex API key.

X-Api-Secret
string
header
required

64-char hex API secret.

Body

application/json
legs
object[]
required
Required array length: 1 - 15 elements
output_mode
enum<string>
required
Available options:
bbo,
aggregated_l2,
decomposed_l2
depth
integer
required
Required range: 1 <= x <= 50
Example:

50

classification
enum<string>
default:arbitrary_basket

Reviewed economic metadata; Kairos does not infer it from the formula.

Available options:
arbitrary_basket,
relative_value,
exact_equivalence,
complement,
partition,
implication,
range,
guaranteed_payout

Response

Lease created and canonical synthetic id returned.

synthetic_id
string
required
Pattern: ^syn_[0-9a-f]{16}$
Example:

"syn_0123456789abcdef"

subscription_id
string<uuid>
required

Opaque account-owned public lease id. This is not the materializer's private numeric handle.

created
boolean
required

True when this request created the canonical materialization; false when it joined an equivalent one.

fees_updated
boolean
required
sources_subscribed
integer
required
Required range: x >= 0
expires_at_ms
integer<int64>
required
ttl_ms
integer<int64>
required
Example:

600000