Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

A Rafflesia API key, sent as Authorization: Bearer <key>.

Headers

Idempotency-Key
string

Retry identity for foreground or background creation. The original status, body, and Rafflesia response headers are replayed exactly; a different complete create request returns a conflict.

Maximum string length: 255
Rafflesia-Request-Timeout
number<double>

Caller start deadline in seconds. Queue wait and failed attempts count; execution may continue after a runner starts.

Rafflesia-Runner-Hint
string

Best-effort affinity hint for a warm execution worker. It never blocks fallback to another worker.

Maximum string length: 256
Rafflesia-Queue-Priority
enum<string>

Background queue priority. Low-priority runs start after normal-priority work for the same endpoint.

Available options:
normal,
low
Rafflesia-Object-Lifecycle-Preference
string

JSON object whose initial_acl and expiration_duration_seconds apply to every file produced by this run.

Maximum string length: 8192
Rafflesia-Store-IO
enum<string>

Set to 0 to prevent retention of JSON request and response payloads. Generated files remain governed by the object lifecycle preference.

Available options:
0,
1
Rafflesia-No-Retry
string

Set to 1, true, or yes to disable automatic retries. This takes precedence over Rafflesia-Retry-Config.

Maximum string length: 5
Rafflesia-Retry-Config
string

JSON retry budgets for server_error, timeout, and connection_error. Each retries value counts additional attempts; ten total attempts is the ceiling.

Maximum string length: 8192
X-Rafflesia-Disable-Fallback
string

Accepted for portability. Rafflesia never substitutes an unpinned endpoint, so fallback is already disabled.

Maximum string length: 5

Query Parameters

rafflesia_max_queue_length
integer<int64>

Reject with 429 when this endpoint already has more queued runs than the supplied non-negative integer across all callers.

Required range: 0 <= x <= 1000000

Body

application/json
endpoint
enum<string>
required

Canonical callable endpoint id returned by GET /v1/models, for example rafflesia/homology.

Available options:
airi-institute/moderngena/base
Pattern: ^[a-z0-9][a-z0-9.-]{0,63}(/[a-z0-9][a-z0-9.-]{0,127})+$
input
object
required

Endpoint-specific input. Known endpoint schemas are discriminated by RunCreateRequest.oneOf and published in x-rafflesia-run-endpoints.

Example:
background
boolean

Run as a durable background task. Omit or set false to wait for completion on this request.

is_retry_disabled
boolean

Disable automatic retries for this background run. Otherwise explicitly transient failures may use up to ten total attempts.

metadata
object

Caller-defined labels stored on the run and included in idempotency identity, but not scientific execution identity.

priority
enum<string>

Background queue priority. Omit for normal; low work starts only when no normal work for the same endpoint is pending.

Available options:
normal,
low
start_deadline_at
string<date-time>

Background-only absolute RFC 3339 alternative to start_timeout_ms. The retained run fails if no execution slot opens first.

start_timeout_ms
integer<int64>

Maximum time to start. Queue wait and failed attempts count, but execution may continue after a runner starts. Omit for no caller start deadline.

Required range: x >= 0
webhook_endpoint_id
string

Background-only registered webhook endpoint that receives this run's enabled lifecycle events. Raw callback URLs are never accepted here.

Pattern: ^whep_[0-9a-f]{24}$

Response

OK

ok
boolean
required

Whether the operation succeeded.

provenance
object
required

Execution provenance.

warnings
object[] | null
required

Non-fatal warnings.

$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/ExecutionEnvelopeRun.json"

data
object

Operation result data. Absent when the operation did not succeed.

error
object

Structured execution error information.

evidence
object

Mechanical evidence summary for agent inspection and chaining.