Klineo/Docs
Open app ↗

API schemas

ResearchProgress

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
schemaVersion Yes Constant agent-research-progress-v1 —
organizationId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
runId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
runResourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
runState Yes string Allowed: QUEUED, RUNNING, WAITING_FOR_INPUT, WAITING_FOR_CHILDREN, COMPLETED, PARTIAL, ABSTAINED, FAILED, CANCELLED
checkedAt Yes string Format: date-time; Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
sourceCutoff Yes string Format: date-time; Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
protocolHash Yes At least one of: string; null —
studyCount Yes At least one of: integer; null —
trials Yes Array of object Max items: 4
trials[].trialKey Yes string Allowed: baseline, alternative-1, alternative-2, alternative-3
trials[].label Yes string Min length: 1; Max length: 120
trials[].state Yes string Allowed: QUEUED, RUNNING, COMPLETED, FAILED, CANCELLED
trials[].chargedComputeUnits Yes string Pattern: ^(0|[1-9][0-9]{0,7})$
trials[].failureCode Yes At least one of: string; null —
trials[].artifactHash Yes At least one of: string; null —
trials[].recordedAt Yes At least one of: string; null —
trials[].inputHash Yes string Pattern: ^0x[0-9a-f]{64}$
financialAuthority Yes Constant false —
publicationAuthority Yes Constant false —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/ResearchProgress in the OpenAPI contract.