> ## Documentation Index > Fetch the complete documentation index at: https://docs.firedrill.run/llms.txt > Use this file to discover all available pages before exploring further. # Materialize a case population > Requires `read`. Expands a deterministic matrix or seeded sample into repository-owned scenarios and retains provenance in the returned recipe. Does not create a batch, run a target or generate scenarios with a model. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/recipes/materialize openapi: 3.1.0 info: title: Firedrill API version: '2026-10-14' description: >- Authenticated simulation coordination, retained evidence and controlled Tools. Your customer-owned runner executes the target. This reference covers the documented JSON workflows; Tool-native HTTP routes and MCP methods are discovered from the selected Tool. Structural schemas do not replace canonical validation or capability checks. servers: - url: https://api.firedrill.run security: - FiredrillCredential: [] tags: - name: discovery description: Capabilities, authority and structural authoring schemas. - name: projects description: Projects and their logical environment. - name: simulations description: Preparation, queued batches and cancellation. - name: runs description: Individual recorded executions. - name: reports description: Retained observations, distributions and descriptive comparisons. - name: assessment description: Optional semantic assessment and authored scenario ranking. - name: evidence description: Authenticated captured files. - name: runner-protocol description: Advanced customer-runner coordination; native SDKs manage this protocol. - name: scenarios description: Immutable retained versions of repository-authored scenarios. - name: credentials description: Expiring scoped CI credentials. - name: authentication description: Human-approved sign-in boundaries. - name: tools description: Tool releases, data, instances and observations. - name: tool-connections description: Bounded target/manual grants, separate from control authority. - name: tool-lifecycle description: Epoch-fenced reusable Tool actions and exact-key recovery. paths: /v1/recipes/materialize: post: tags: - simulations summary: Materialize a case population description: >- Requires `read`. Expands a deterministic matrix or seeded sample into repository-owned scenarios and retains provenance in the returned recipe. Does not create a batch, run a target or generate scenarios with a model. operationId: recipes_materialize parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PopulationMaterializeInput' responses: '200': description: The retained resource or operation response. content: application/json: schema: $ref: '#/components/schemas/PopulationMaterialization' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '410': $ref: '#/components/responses/Gone' '413': $ref: '#/components/responses/PayloadTooLarge' '415': $ref: '#/components/responses/UnsupportedMediaType' '422': $ref: '#/components/responses/InvalidInput' '429': $ref: '#/components/responses/Capacity' '500': $ref: '#/components/responses/Internal' '503': $ref: '#/components/responses/Unavailable' components: schemas: PopulationMaterializeInput: type: object properties: projectId: type: string minLength: 1 maxLength: 160 environmentId: type: string minLength: 1 maxLength: 160 schemaVersion: type: string const: 2026-10-15-population.1 recipe: $ref: '#/components/schemas/RecipeInput' axes: minItems: 1 type: array items: type: object properties: path: type: string minLength: 1 maxLength: 1000 pattern: ^\/.* values: minItems: 1 type: array items: $ref: '#/components/schemas/JsonValue' required: - path - values additionalProperties: false selection: oneOf: - type: object properties: method: type: string const: matrix seed: type: string minLength: 1 maxLength: 200 required: - method - seed additionalProperties: false - type: object properties: method: type: string const: sample seed: type: string minLength: 1 maxLength: 200 count: type: integer minimum: 1 maximum: 9007199254740991 required: - method - seed - count additionalProperties: false required: - projectId - environmentId - schemaVersion - recipe - axes - selection additionalProperties: false PopulationMaterialization: type: object properties: schemaVersion: type: string const: 2026-10-15-population.1 recipe: $ref: '#/components/schemas/Recipe' provenance: $ref: '#/components/schemas/PopulationProvenance' required: - schemaVersion - recipe - provenance RecipeInput: type: object properties: schemaVersion: type: string const: '2026-10-14' name: type: string minLength: 1 maxLength: 200 scenarios: minItems: 1 type: array items: $ref: '#/components/schemas/ScenarioInput' target: $ref: '#/components/schemas/TargetInput' targetExecution: type: object properties: schemaVersion: type: string const: 2026-10-16-target-execution.1 nonHermeticParallel: type: string const: acknowledged required: - schemaVersion - nonHermeticParallel additionalProperties: false population: type: object properties: schemaVersion: type: string const: 2026-10-15-population.1 method: type: string enum: - matrix - sample seed: type: string minLength: 1 maxLength: 200 candidateCount: type: integer minimum: 1 maximum: 1000000000 selectedIndices: minItems: 1 type: array items: type: integer minimum: 0 maximum: 999999999 sourceRecipeDigest: type: string pattern: ^[a-f0-9]{64}$ axesDigest: type: string pattern: ^[a-f0-9]{64}$ required: - schemaVersion - method - seed - candidateCount - selectedIndices - sourceRecipeDigest - axesDigest additionalProperties: false populationPurpose: $ref: '#/components/schemas/PopulationPurposeInput' services: default: [] type: array items: $ref: '#/components/schemas/ServiceBindingInput' configurations: default: - id: default parameters: {} minItems: 1 type: array items: type: object properties: id: type: string minLength: 1 maxLength: 160 parameters: default: {} type: object propertyNames: type: string additionalProperties: $ref: '#/components/schemas/JsonValue' required: - id additionalProperties: false repetitions: default: 1 type: integer minimum: 1 maximum: 9007199254740991 concurrency: default: 1 type: integer minimum: 1 maximum: 9007199254740991 limits: default: timeoutMs: 60000 maxRuns: null maxOutputBytes: 1048576 type: object properties: timeoutMs: default: 60000 type: integer minimum: 100 maximum: 2592000000 maxRuns: default: null anyOf: - type: integer minimum: 1 maximum: 9007199254740991 - type: 'null' maxOutputBytes: default: 1048576 type: integer minimum: 1024 maximum: 8388608 gate: type: object properties: requireCompleted: default: true type: boolean requireExactChecks: default: true type: boolean minimumLevels: default: {} type: object propertyNames: type: string additionalProperties: type: integer minimum: 0 maximum: 4 additionalProperties: false required: - schemaVersion - name - scenarios - target additionalProperties: false JsonValue: description: >- Any JSON value: null, boolean, finite number, string, array or object. The request transport must contain valid JSON; canonical validation rejects nonfinite numbers. Recipe: type: object properties: schemaVersion: type: string const: '2026-10-14' name: type: string scenarios: type: array items: $ref: '#/components/schemas/Scenario' target: $ref: '#/components/schemas/Target' services: type: array items: $ref: '#/components/schemas/ServiceBinding' configurations: type: array items: $ref: '#/components/schemas/Configuration' repetitions: type: number concurrency: type: number limits: type: object properties: timeoutMs: type: number maxRuns: anyOf: - type: 'null' - type: number maxOutputBytes: type: number required: - timeoutMs - maxRuns - maxOutputBytes targetExecution: anyOf: - $ref: '#/components/schemas/TargetExecutionPolicy' population: anyOf: - $ref: '#/components/schemas/PopulationProvenance' populationPurpose: anyOf: - $ref: '#/components/schemas/PopulationPurpose' gate: anyOf: - type: object properties: requireCompleted: type: boolean requireExactChecks: type: boolean minimumLevels: type: object properties: {} required: [] additionalProperties: type: number required: - requireCompleted - requireExactChecks - minimumLevels required: - schemaVersion - name - scenarios - target - services - configurations - repetitions - concurrency - limits PopulationProvenance: type: object properties: schemaVersion: type: string const: 2026-10-15-population.1 method: type: string enum: - matrix - sample seed: type: string candidateCount: type: number selectedIndices: type: array items: type: number sourceRecipeDigest: type: string axesDigest: type: string required: - schemaVersion - method - seed - candidateCount - selectedIndices - sourceRecipeDigest - axesDigest ApiError: type: object properties: error: type: object properties: code: type: string message: type: string repair: type: string requestId: type: string details: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' validation: anyOf: - $ref: '#/components/schemas/ValidationDiagnostics' required: - code - message - repair - requestId required: - error ScenarioInput: type: object properties: id: type: string minLength: 1 maxLength: 160 name: type: string minLength: 1 maxLength: 200 input: $ref: '#/components/schemas/JsonValue' description: type: string maxLength: 4000 checks: default: [] maxItems: 100 type: array items: $ref: '#/components/schemas/ExactCheckInput' rubric: $ref: '#/components/schemas/RubricInput' metrics: minItems: 1 maxItems: 32 type: array items: $ref: '#/components/schemas/TaskMetricDefinitionInput' serviceDatasets: type: object propertyNames: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ additionalProperties: type: string minLength: 1 maxLength: 160 sequence: $ref: '#/components/schemas/SequenceInput' required: - id - name - input additionalProperties: false TargetInput: oneOf: - type: object properties: metadata: type: object properties: schemaVersion: type: string const: 2026-10-15-target-metadata.1 source: type: object properties: revision: type: string minLength: 1 maxLength: 200 contentDigest: type: string pattern: ^sha256:[a-f0-9]{64}$ dirty: default: unknown type: string enum: - clean - dirty - unknown required: - revision additionalProperties: false resetCoverage: type: object properties: applicationDatabase: type: string enum: - customer_managed - not_reset - not_used - unknown cache: type: string enum: - customer_managed - not_reset - not_used - unknown filesystem: type: string enum: - customer_managed - not_reset - not_used - unknown conversationMemory: type: string enum: - customer_managed - not_reset - not_used - unknown outstandingJobs: type: string enum: - customer_managed - not_reset - not_used - unknown browserProfile: type: string enum: - customer_managed - not_reset - not_used - unknown externalState: type: string enum: - customer_managed - not_reset - not_used - unknown additionalProperties: false required: - schemaVersion additionalProperties: false kind: type: string const: command argv: minItems: 1 maxItems: 128 type: array items: type: string maxLength: 8192 cwd: type: string maxLength: 4096 required: - kind - argv additionalProperties: false - type: object properties: metadata: type: object properties: schemaVersion: type: string const: 2026-10-15-target-metadata.1 source: type: object properties: revision: type: string minLength: 1 maxLength: 200 contentDigest: type: string pattern: ^sha256:[a-f0-9]{64}$ dirty: default: unknown type: string enum: - clean - dirty - unknown required: - revision additionalProperties: false resetCoverage: type: object properties: applicationDatabase: type: string enum: - customer_managed - not_reset - not_used - unknown cache: type: string enum: - customer_managed - not_reset - not_used - unknown filesystem: type: string enum: - customer_managed - not_reset - not_used - unknown conversationMemory: type: string enum: - customer_managed - not_reset - not_used - unknown outstandingJobs: type: string enum: - customer_managed - not_reset - not_used - unknown browserProfile: type: string enum: - customer_managed - not_reset - not_used - unknown externalState: type: string enum: - customer_managed - not_reset - not_used - unknown additionalProperties: false required: - schemaVersion additionalProperties: false kind: type: string const: http url: type: string format: uri method: default: POST type: string enum: - POST - PUT required: - kind - url additionalProperties: false - type: object properties: metadata: type: object properties: schemaVersion: type: string const: 2026-10-15-target-metadata.1 source: type: object properties: revision: type: string minLength: 1 maxLength: 200 contentDigest: type: string pattern: ^sha256:[a-f0-9]{64}$ dirty: default: unknown type: string enum: - clean - dirty - unknown required: - revision additionalProperties: false resetCoverage: type: object properties: applicationDatabase: type: string enum: - customer_managed - not_reset - not_used - unknown cache: type: string enum: - customer_managed - not_reset - not_used - unknown filesystem: type: string enum: - customer_managed - not_reset - not_used - unknown conversationMemory: type: string enum: - customer_managed - not_reset - not_used - unknown outstandingJobs: type: string enum: - customer_managed - not_reset - not_used - unknown browserProfile: type: string enum: - customer_managed - not_reset - not_used - unknown externalState: type: string enum: - customer_managed - not_reset - not_used - unknown additionalProperties: false required: - schemaVersion additionalProperties: false kind: type: string const: native name: type: string minLength: 1 maxLength: 200 required: - kind - name additionalProperties: false - type: object properties: metadata: type: object properties: schemaVersion: type: string const: 2026-10-15-target-metadata.1 source: type: object properties: revision: type: string minLength: 1 maxLength: 200 contentDigest: type: string pattern: ^sha256:[a-f0-9]{64}$ dirty: default: unknown type: string enum: - clean - dirty - unknown required: - revision additionalProperties: false resetCoverage: type: object properties: applicationDatabase: type: string enum: - customer_managed - not_reset - not_used - unknown cache: type: string enum: - customer_managed - not_reset - not_used - unknown filesystem: type: string enum: - customer_managed - not_reset - not_used - unknown conversationMemory: type: string enum: - customer_managed - not_reset - not_used - unknown outstandingJobs: type: string enum: - customer_managed - not_reset - not_used - unknown browserProfile: type: string enum: - customer_managed - not_reset - not_used - unknown externalState: type: string enum: - customer_managed - not_reset - not_used - unknown additionalProperties: false required: - schemaVersion additionalProperties: false kind: type: string const: isolated_node entrypoint: type: string pattern: ^[A-Za-z0-9_-][A-Za-z0-9._/-]{0,159}$ image: type: string pattern: ^sha256:[a-f0-9]{64}$ files: minItems: 1 maxItems: 64 type: array items: type: object properties: path: type: string pattern: ^[A-Za-z0-9_-][A-Za-z0-9._/-]{0,159}$ bytes: type: integer minimum: 1 maximum: 2097152 sha256: type: string pattern: ^[a-f0-9]{64}$ required: - path - bytes - sha256 additionalProperties: false approvedServices: default: [] maxItems: 8 type: array items: type: object properties: id: type: string pattern: ^[a-z][a-z0-9-]{0,47}$ url: type: string format: uri routes: minItems: 1 maxItems: 16 type: array items: type: object properties: method: type: string enum: - GET - POST - PUT - PATCH - DELETE path: type: string maxLength: 256 pattern: ^\/[A-Za-z0-9/_-]*$ required: - method - path additionalProperties: false allowPrivateAddress: type: boolean const: true required: - id - url - routes additionalProperties: false required: - kind - entrypoint - image - files additionalProperties: false PopulationPurposeInput: type: object properties: schemaVersion: type: string const: 2026-10-16-population-purpose.1 kind: type: string enum: - exploration - fixed_suite - held_out - failure_selected rationale: type: string minLength: 1 maxLength: 2000 required: - schemaVersion - kind additionalProperties: false ServiceBindingInput: type: object properties: alias: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ buildId: type: string minLength: 1 maxLength: 160 datasetId: type: string minLength: 1 maxLength: 160 seed: type: string maxLength: 80 pattern: ^(0|[1-9][0-9]*)$ operations: minItems: 1 maxItems: 256 type: array items: type: string minLength: 1 maxLength: 160 control: oneOf: - type: object properties: schemaVersion: type: string const: 2026-10-15-service-control.1 operations: minItems: 1 maxItems: 256 type: array items: type: string minLength: 1 maxLength: 160 required: - schemaVersion - operations additionalProperties: false - type: object properties: schemaVersion: type: string const: 2026-10-15-service-control.2 operations: maxItems: 256 type: array items: type: string minLength: 1 maxLength: 160 clock: type: object properties: advance: type: boolean const: true required: - advance additionalProperties: false required: - schemaVersion - operations additionalProperties: false required: - alias - buildId - seed - operations additionalProperties: false Scenario: type: object properties: id: type: string name: type: string input: $ref: '#/components/schemas/JsonValue' checks: type: array items: type: object properties: id: type: string description: type: string path: type: string comparator: type: string enum: - equals - contains - exists - lte - gte required: type: boolean expected: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' source: anyOf: - type: object properties: kind: type: string const: service_state namespace: type: string rowId: type: string schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string required: - kind - namespace - rowId - schemaVersion - service - type: object properties: kind: type: string const: service_activity schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string where: anyOf: - type: object properties: path: type: string equals: $ref: '#/components/schemas/JsonValue' required: - path - equals required: - kind - schemaVersion - service - type: object properties: kind: type: string const: service_pending schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string required: - kind - schemaVersion - service numeric: anyOf: - $ref: '#/components/schemas/NumericCheck' required: - id - description - path - comparator - required description: anyOf: - type: string rubric: anyOf: - type: object properties: id: type: string version: type: string dimensions: type: array items: type: object properties: id: type: string description: type: string anchors: type: array prefixItems: - type: string - type: string - type: string - type: string - type: string minItems: 5 maxItems: 5 evidenceKinds: anyOf: - type: array items: type: string enum: - image - text - audio - video applicability: anyOf: - type: object properties: state: type: string const: applicable required: - state - type: object properties: state: type: string const: not_applicable reason: type: string required: - state - reason missingEvidence: type: string enum: - not_assessable required: - id - description - anchors composite: anyOf: - $ref: '#/components/schemas/CompositePolicy' policyVersion: type: string enum: - 2026-10-15-assessment.1 required: - id - version - dimensions metrics: anyOf: - type: array items: $ref: '#/components/schemas/TaskMetricDefinition' serviceDatasets: anyOf: - type: object properties: {} required: [] additionalProperties: type: string sequence: anyOf: - type: object properties: schemaVersion: type: string const: 2026-10-14-sequence.1 steps: type: array items: $ref: '#/components/schemas/SequenceStep' required: - schemaVersion - steps required: - id - name - input - checks Target: anyOf: - type: object properties: kind: type: string const: command argv: type: array items: type: string cwd: anyOf: - type: string metadata: anyOf: - $ref: '#/components/schemas/TargetMetadata' required: - kind - argv - type: object properties: kind: type: string const: http url: type: string method: type: string enum: - POST - PUT metadata: anyOf: - $ref: '#/components/schemas/TargetMetadata' required: - kind - url - method - type: object properties: kind: type: string const: native name: type: string metadata: anyOf: - $ref: '#/components/schemas/TargetMetadata' required: - kind - name - type: object properties: kind: type: string const: isolated_node entrypoint: type: string image: type: string files: type: array items: type: object properties: path: type: string bytes: type: number sha256: type: string required: - path - bytes - sha256 approvedServices: type: array items: type: object properties: id: type: string url: type: string routes: type: array items: type: object properties: method: type: string enum: - POST - PUT - GET - PATCH - DELETE path: type: string required: - method - path allowPrivateAddress: anyOf: - type: boolean const: true required: - id - url - routes metadata: anyOf: - $ref: '#/components/schemas/TargetMetadata' required: - kind - entrypoint - image - files - approvedServices ServiceBinding: type: object properties: alias: type: string buildId: type: string seed: type: string operations: type: array items: type: string datasetId: anyOf: - type: string control: anyOf: - type: object properties: schemaVersion: type: string const: 2026-10-15-service-control.1 operations: type: array items: type: string required: - schemaVersion - operations - type: object properties: schemaVersion: type: string const: 2026-10-15-service-control.2 operations: type: array items: type: string clock: anyOf: - type: object properties: advance: type: boolean const: true required: - advance required: - schemaVersion - operations required: - alias - buildId - seed - operations Configuration: type: object properties: id: type: string parameters: type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' required: - id - parameters TargetExecutionPolicy: type: object properties: schemaVersion: type: string const: 2026-10-16-target-execution.1 nonHermeticParallel: type: string const: acknowledged required: - schemaVersion - nonHermeticParallel PopulationPurpose: type: object properties: schemaVersion: type: string const: 2026-10-16-population-purpose.1 kind: type: string enum: - exploration - fixed_suite - held_out - failure_selected rationale: anyOf: - type: string required: - schemaVersion - kind ValidationDiagnostics: type: object properties: issues: type: array items: $ref: '#/components/schemas/ValidationIssue' totalIssues: type: number omittedIssues: type: number required: - issues - totalIssues - omittedIssues ExactCheckInput: type: object properties: id: type: string minLength: 1 maxLength: 160 description: type: string minLength: 1 maxLength: 2000 path: type: string maxLength: 1000 comparator: type: string enum: - equals - contains - exists - lte - gte expected: $ref: '#/components/schemas/JsonValue' required: default: true type: boolean source: oneOf: - type: object properties: schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ kind: type: string const: service_state namespace: type: string minLength: 1 maxLength: 160 rowId: type: string minLength: 1 maxLength: 512 required: - schemaVersion - service - kind - namespace - rowId additionalProperties: false - type: object properties: schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ kind: type: string const: service_activity where: type: object properties: path: type: string maxLength: 1000 equals: $ref: '#/components/schemas/JsonValue' required: - path - equals additionalProperties: false required: - schemaVersion - service - kind additionalProperties: false - type: object properties: schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ kind: type: string const: service_pending required: - schemaVersion - service - kind additionalProperties: false numeric: type: object properties: schemaVersion: type: string const: 2026-10-16-numeric-check.1 unit: type: string minLength: 1 maxLength: 64 absoluteTolerance: default: 0 type: number minimum: 0 required: - schemaVersion - unit additionalProperties: false required: - id - description - path - comparator additionalProperties: false RubricInput: type: object properties: composite: $ref: '#/components/schemas/CompositePolicyInput' id: type: string minLength: 1 maxLength: 160 version: type: string minLength: 1 maxLength: 160 policyVersion: type: string const: 2026-10-15-assessment.1 dimensions: minItems: 1 maxItems: 12 type: array items: type: object properties: id: type: string minLength: 1 maxLength: 160 description: type: string minLength: 1 maxLength: 4000 anchors: type: array prefixItems: - type: string minLength: 1 maxLength: 4000 - type: string minLength: 1 maxLength: 4000 - type: string minLength: 1 maxLength: 4000 - type: string minLength: 1 maxLength: 4000 - type: string minLength: 1 maxLength: 4000 evidenceKinds: minItems: 1 maxItems: 4 type: array items: type: string enum: - text - image - audio - video applicability: oneOf: - type: object properties: state: type: string const: applicable required: - state additionalProperties: false - type: object properties: state: type: string const: not_applicable reason: type: string minLength: 1 maxLength: 2000 required: - state - reason additionalProperties: false missingEvidence: type: string const: not_assessable required: - id - description - anchors additionalProperties: false required: - id - version - dimensions additionalProperties: false description: >- Five ordered task-specific anchors represent levels 0–4. Structural JSON Schema cannot enforce unique IDs, applicability policy, comparator rules or all cross-field constraints; use recipe preview. TaskMetricDefinitionInput: type: object properties: schemaVersion: type: string const: 2026-10-16-task-metric.1 id: type: string minLength: 1 maxLength: 160 label: type: string minLength: 1 maxLength: 200 path: type: string maxLength: 1000 unit: type: string minLength: 1 maxLength: 64 direction: type: string enum: - higher_is_better - lower_is_better - neutral source: oneOf: - type: object properties: schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ kind: type: string const: service_state namespace: type: string minLength: 1 maxLength: 160 rowId: type: string minLength: 1 maxLength: 512 required: - schemaVersion - service - kind - namespace - rowId additionalProperties: false - type: object properties: schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ kind: type: string const: service_activity where: type: object properties: path: type: string maxLength: 1000 equals: $ref: '#/components/schemas/JsonValue' required: - path - equals additionalProperties: false required: - schemaVersion - service - kind additionalProperties: false - type: object properties: schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ kind: type: string const: service_pending required: - schemaVersion - service - kind additionalProperties: false required: - schemaVersion - id - label - path - unit additionalProperties: false SequenceInput: type: object properties: schemaVersion: type: string const: 2026-10-14-sequence.1 steps: minItems: 1 maxItems: 10000 type: array items: oneOf: - type: object properties: id: type: string minLength: 1 maxLength: 160 when: type: object properties: path: type: string maxLength: 1000 comparator: type: string enum: - equals - contains - exists - lte - gte expected: $ref: '#/components/schemas/JsonValue' step: type: string minLength: 1 maxLength: 160 required: - path - comparator - step additionalProperties: false kind: type: string const: target input: $ref: '#/components/schemas/JsonValue' required: - id - kind additionalProperties: false - type: object properties: id: type: string minLength: 1 maxLength: 160 when: type: object properties: path: type: string maxLength: 1000 comparator: type: string enum: - equals - contains - exists - lte - gte expected: $ref: '#/components/schemas/JsonValue' step: type: string minLength: 1 maxLength: 160 required: - path - comparator - step additionalProperties: false kind: type: string const: service service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ operationId: type: string minLength: 1 maxLength: 160 arguments: type: object propertyNames: type: string additionalProperties: $ref: '#/components/schemas/JsonValue' required: - id - kind - service - operationId - arguments additionalProperties: false - type: object properties: id: type: string minLength: 1 maxLength: 160 when: type: object properties: path: type: string maxLength: 1000 comparator: type: string enum: - equals - contains - exists - lte - gte expected: $ref: '#/components/schemas/JsonValue' step: type: string minLength: 1 maxLength: 160 required: - path - comparator - step additionalProperties: false kind: type: string const: wait_for service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ operationId: type: string minLength: 1 maxLength: 160 arguments: type: object propertyNames: type: string additionalProperties: $ref: '#/components/schemas/JsonValue' until: type: object properties: path: type: string maxLength: 1000 comparator: type: string enum: - equals - contains - exists - lte - gte expected: $ref: '#/components/schemas/JsonValue' required: - path - comparator additionalProperties: false maxAttempts: type: integer minimum: 1 maximum: 100000 intervalMs: type: integer minimum: 100 maximum: 60000 required: - id - kind - service - operationId - arguments - until - maxAttempts - intervalMs additionalProperties: false - type: object properties: id: type: string minLength: 1 maxLength: 160 when: type: object properties: path: type: string maxLength: 1000 comparator: type: string enum: - equals - contains - exists - lte - gte expected: $ref: '#/components/schemas/JsonValue' step: type: string minLength: 1 maxLength: 160 required: - path - comparator - step additionalProperties: false kind: type: string const: advance_time service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ toUs: type: integer minimum: 0 maximum: 9007199254740991 maxEvents: default: 100 type: integer minimum: 1 maximum: 1000 required: - id - kind - service - toUs additionalProperties: false - type: object properties: id: type: string minLength: 1 maxLength: 160 when: type: object properties: path: type: string maxLength: 1000 comparator: type: string enum: - equals - contains - exists - lte - gte expected: $ref: '#/components/schemas/JsonValue' step: type: string minLength: 1 maxLength: 160 required: - path - comparator - step additionalProperties: false kind: type: string const: snapshot service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ required: - id - kind - service additionalProperties: false - type: object properties: id: type: string minLength: 1 maxLength: 160 when: type: object properties: path: type: string maxLength: 1000 comparator: type: string enum: - equals - contains - exists - lte - gte expected: $ref: '#/components/schemas/JsonValue' step: type: string minLength: 1 maxLength: 160 required: - path - comparator - step additionalProperties: false kind: type: string const: restore service: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ snapshotStepId: type: string minLength: 1 maxLength: 160 boundary: type: string const: service_only required: - id - kind - service - snapshotStepId - boundary additionalProperties: false required: - schemaVersion - steps additionalProperties: false NumericCheck: type: object properties: schemaVersion: type: string const: 2026-10-16-numeric-check.1 unit: type: string absoluteTolerance: type: number required: - schemaVersion - unit - absoluteTolerance CompositePolicy: type: object properties: schemaVersion: type: string const: 2026-10-16-composite.1 method: type: string const: weighted_mean_ordinal weights: type: array items: type: object properties: dimensionId: type: string weight: type: number required: - dimensionId - weight required: - schemaVersion - method - weights TaskMetricDefinition: type: object properties: schemaVersion: type: string const: 2026-10-16-task-metric.1 id: type: string label: type: string path: type: string unit: type: string direction: type: string enum: - higher_is_better - lower_is_better - neutral source: anyOf: - type: object properties: kind: type: string const: service_state namespace: type: string rowId: type: string schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string required: - kind - namespace - rowId - schemaVersion - service - type: object properties: kind: type: string const: service_activity schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string where: anyOf: - type: object properties: path: type: string equals: $ref: '#/components/schemas/JsonValue' required: - path - equals required: - kind - schemaVersion - service - type: object properties: kind: type: string const: service_pending schemaVersion: type: string const: 2026-10-15-effect-check.1 service: type: string required: - kind - schemaVersion - service required: - schemaVersion - id - label - path - unit SequenceStep: anyOf: - type: object properties: kind: type: string const: target id: type: string input: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' when: anyOf: - type: object properties: path: type: string comparator: type: string enum: - equals - contains - exists - lte - gte step: type: string expected: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' required: - path - comparator - step required: - kind - id - type: object properties: kind: type: string const: service service: type: string operationId: type: string arguments: type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' id: type: string when: anyOf: - type: object properties: path: type: string comparator: type: string enum: - equals - contains - exists - lte - gte step: type: string expected: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' required: - path - comparator - step required: - kind - service - operationId - arguments - id - type: object properties: kind: type: string const: wait_for service: type: string operationId: type: string arguments: type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' until: $ref: '#/components/schemas/Predicate' maxAttempts: type: number intervalMs: type: number id: type: string when: anyOf: - type: object properties: path: type: string comparator: type: string enum: - equals - contains - exists - lte - gte step: type: string expected: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' required: - path - comparator - step required: - kind - service - operationId - arguments - until - maxAttempts - intervalMs - id - type: object properties: kind: type: string const: advance_time service: type: string toUs: type: number maxEvents: type: number id: type: string when: anyOf: - type: object properties: path: type: string comparator: type: string enum: - equals - contains - exists - lte - gte step: type: string expected: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' required: - path - comparator - step required: - kind - service - toUs - maxEvents - id - type: object properties: kind: type: string const: snapshot service: type: string id: type: string when: anyOf: - type: object properties: path: type: string comparator: type: string enum: - equals - contains - exists - lte - gte step: type: string expected: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' required: - path - comparator - step required: - kind - service - id - type: object properties: kind: type: string const: restore service: type: string snapshotStepId: type: string boundary: type: string const: service_only id: type: string when: anyOf: - type: object properties: path: type: string comparator: type: string enum: - equals - contains - exists - lte - gte step: type: string expected: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' required: - path - comparator - step required: - kind - service - snapshotStepId - boundary - id TargetMetadata: type: object properties: schemaVersion: type: string const: 2026-10-15-target-metadata.1 source: anyOf: - type: object properties: revision: type: string dirty: type: string enum: - clean - dirty - unknown contentDigest: anyOf: - type: string required: - revision - dirty resetCoverage: anyOf: - type: object properties: applicationDatabase: type: string enum: - unknown - customer_managed - not_reset - not_used cache: type: string enum: - unknown - customer_managed - not_reset - not_used filesystem: type: string enum: - unknown - customer_managed - not_reset - not_used conversationMemory: type: string enum: - unknown - customer_managed - not_reset - not_used outstandingJobs: type: string enum: - unknown - customer_managed - not_reset - not_used browserProfile: type: string enum: - unknown - customer_managed - not_reset - not_used externalState: type: string enum: - unknown - customer_managed - not_reset - not_used required: [] required: - schemaVersion ValidationIssue: type: object properties: path: type: array items: anyOf: - type: string - type: number code: type: string message: type: string pathTruncated: anyOf: - type: boolean const: true required: - path - code - message CompositePolicyInput: type: object properties: schemaVersion: type: string const: 2026-10-16-composite.1 method: type: string const: weighted_mean_ordinal weights: minItems: 1 maxItems: 12 type: array items: type: object properties: dimensionId: type: string minLength: 1 maxLength: 160 weight: type: integer minimum: 1 maximum: 1000 required: - dimensionId - weight additionalProperties: false required: - schemaVersion - method - weights additionalProperties: false Predicate: type: object properties: path: type: string comparator: type: string enum: - equals - contains - exists - lte - gte expected: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object properties: {} required: [] additionalProperties: $ref: '#/components/schemas/JsonValue' required: - path - comparator responses: BadRequest: description: >- Malformed request or missing operation key. Repair the input before retrying. content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: >- Missing, expired or revoked authority. Complete supported sign-in or use an authorized credential. content: application/json: schema: $ref: '#/components/schemas/ApiError' Forbidden: description: >- The current capability, actor, audience or ownership grant does not allow this operation. content: application/json: schema: $ref: '#/components/schemas/ApiError' NotFound: description: The exact resource is unavailable under the current authority and scope. content: application/json: schema: $ref: '#/components/schemas/ApiError' Conflict: description: >- Selected context, epoch, revision, lease or saved operation intent conflicts; inspect retained state. content: application/json: schema: $ref: '#/components/schemas/ApiError' Gone: description: >- Retained content is expired, deleted or unavailable under its retention fence. Metadata is not a replacement payload. content: application/json: schema: $ref: '#/components/schemas/ApiError' PayloadTooLarge: description: >- Request, response or retained-resource size exceeds this operation’s enforced bound. content: application/json: schema: $ref: '#/components/schemas/ApiError' UnsupportedMediaType: description: Send the documented JSON or exact artifact media type. content: application/json: schema: $ref: '#/components/schemas/ApiError' InvalidInput: description: >- Input failed canonical validation. Inspect error.validation and repair the indicated fields. content: application/json: schema: $ref: '#/components/schemas/ApiError' Capacity: description: >- Bounded capacity or resource admission rejected the operation. Inspect retained work before retrying. content: application/json: schema: $ref: '#/components/schemas/ApiError' Internal: description: >- The service could not complete the request. Inspect retained state before exact-key recovery. content: application/json: schema: $ref: '#/components/schemas/ApiError' Unavailable: description: >- A required service, provider or authority check is unavailable. Existing evidence remains separate from this failure. content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: FiredrillCredential: type: http scheme: bearer description: >- Opaque Firedrill interactive or scoped machine credential. The CLI handles human-approved login; CI stores its scoped credential as FIREDRILL_TOKEN. Capabilities and project/environment ownership are rechecked at use. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.