Skip to main content
POST
Python (SDK)

Authorizations

Authorization
string
header
required

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Headers

Idempotency-Key
string
required
Required string length: 1 - 255
X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Body

application/json
generator_id
string
required
Required string length: 1 - 64
params
Params · object
required
output
OutputSpec · object
required
inputs
Inputs · object
limits
LimitsRequest · object | null

Each value may only be lower than the generator's default (api.md §3).

name
string | null
Maximum string length: 200
derived_from
string[]
Maximum array length: 100

Response

Successful Response

id
string
required
state
enum<string>
required
Available options:
pending,
running,
publishing,
succeeded,
failed,
cancelling,
cancelled
reason
GenerationReason · object | null
required

api.md §3 reason.

generator
GeneratorRef · object
required
params
Params · object
required
params_hash
string
required
output
OutputRef · object
required
inputs
Inputs · object
required
counts
Counts · object | null
required
llm
LlmRef · object
required
limits
Limits · object
required

api.md §2 limits / default_limits on the wire: B.1's contract.Limits, with max_cost optional and deprecated in the schema while every response still carries it as a number (MK1-722, step 1 of MK1-719). The two must otherwise agree field for field.

usage
GenerationUsage · object | null
required

api.md §3 usage, the shape of the runtime's llm.Usage.

job
JobRef · object | null
required
name
string | null
required
derived_from
string[]
required
created_by
CreatedBy · object
required
created_at
string<date-time>
required
started_at
string<date-time> | null
required
terminal_at
string<date-time> | null
required
duplicate_of
string | null