> ## 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. # Discover capabilities > Read supported recipes, authoring schema IDs, operations, current capability checks and resource bounds. Discovery is advisory: it does not grant authority, reserve capacity or execute a target. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/discovery 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/discovery: get: tags: - discovery summary: Discover capabilities description: >- Read supported recipes, authoring schema IDs, operations, current capability checks and resource bounds. Discovery is advisory: it does not grant authority, reserve capacity or execute a target. operationId: discovery_get parameters: [] responses: '200': description: The retained resource or operation response. content: application/json: schema: $ref: '#/components/schemas/ProductDiscovery' '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: ProductDiscovery: type: object properties: schemaVersion: type: string const: 2026-10-15-discovery.1 contractVersion: type: string acceptedRecipeVersions: type: array items: type: string authority: type: object properties: permissions: type: array items: type: string scopePath: type: string const: /v1/context advisoryOnly: type: boolean const: true required: - permissions - scopePath - advisoryOnly readScope: anyOf: - type: object properties: schemaVersion: type: string const: 2026-10-16-read-scope.1 headers: type: object properties: version: type: string const: x-fd-read-scope-version project: type: string const: x-fd-read-project-id environment: type: string const: x-fd-read-environment-id required: - version - project - environment appliesTo: type: string const: GET_runs_and_batches_by_id credentialAuthorityUnchanged: type: boolean const: true unselectedDirectLinks: type: string const: credential_authorized required: - schemaVersion - headers - appliesTo - credentialAuthorityUnchanged - unselectedDirectLinks execution: type: object properties: owner: type: string const: customer_runner batchCreationExecutesTarget: type: boolean const: false toolsRequired: type: boolean const: false assessmentRequired: type: boolean const: false nativeProcessIsSandbox: type: boolean const: false required: - owner - batchCreationExecutesTarget - toolsRequired - assessmentRequired - nativeProcessIsSandbox assessment: type: object properties: configured: type: boolean rubricScale: type: array prefixItems: - type: number const: 0 - type: number const: 1 - type: number const: 2 - type: number const: 3 - type: number const: 4 minItems: 5 maxItems: 5 supportedEvidenceKinds: type: array prefixItems: - type: string const: text minItems: 1 maxItems: 1 scoreIsProbability: type: boolean const: false evaluatorFailureIsTargetFailure: type: boolean const: false required: - configured - rubricScale - supportedEvidenceKinds - scoreIsProbability - evaluatorFailureIsTargetFailure capacity: type: object properties: maxActiveRuns: type: number resourceBounds: type: object properties: {} required: [] additionalProperties: anyOf: - type: 'null' - type: number reservation: type: boolean const: false required: - maxActiveRuns - resourceBounds - reservation capabilities: type: array items: $ref: '#/components/schemas/ProductCapability' schemas: type: array items: $ref: '#/components/schemas/AuthoringSchemaEntry' authoring: type: object properties: format: type: string const: json-schema-2020-12 semantics: type: string const: structural_input_only previewPath: type: string const: /v1/recipes/preview limitations: type: array items: type: string required: - format - semantics - previewPath - limitations recovery: type: array items: type: object properties: situation: type: string action: type: string required: - situation - action resultProjections: anyOf: - type: object properties: lifecycle: type: object properties: schemaVersion: type: string const: 2026-10-17-result-lifecycle.1 path: type: string const: /v1/batches/{id}/result?compact=1 metadataPath: type: string enum: - /v1/batches/{id}/lifecycle coverage: type: string const: whole_batch evidenceScope: type: string const: declared_artifacts_and_run_owned_tools customerCleanup: type: string const: runner_reported_not_platform_attested required: - schemaVersion - path - coverage - evidenceScope - customerCleanup batchOverview: type: object properties: schemaVersion: type: string const: 2026-10-17-batch-overview.1 path: type: string const: /v1/batches scoring: type: string const: one_named_dimension_only_when_contracts_match required: - schemaVersion - path - scoring required: - lifecycle - batchOverview required: - schemaVersion - contractVersion - acceptedRecipeVersions - authority - execution - assessment - capacity - capabilities - schemas - authoring - recovery ProductCapability: type: object properties: id: type: string description: type: string operations: type: array items: type: object properties: method: type: string enum: - POST - GET path: type: string effect: type: string enum: - read - prepare - mutate - evaluate requires: type: array items: type: string authorized: type: boolean required: - method - path - effect - requires - authorized limitations: type: array items: type: string required: - id - description - operations - limitations AuthoringSchemaEntry: type: object properties: id: $ref: '#/components/schemas/AuthoringSchemaId' description: type: string path: type: string required: - id - description - path 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 AuthoringSchemaId: type: string enum: - target - scenario - rubric - sequence - population - recipe - target-invocation - exact-check - service-binding - recipe-preview - scenario-save - reassessment - run-intervention - artifact - machine-credential - service-publication - service-dataset - service-instance - service-connection - dataset-policy - dataset-metadata - ci-context - activity-filters - composite-policy - population-purpose - task-metric - scenario-recommendation 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. ValidationDiagnostics: type: object properties: issues: type: array items: $ref: '#/components/schemas/ValidationIssue' totalIssues: type: number omittedIssues: type: number required: - issues - totalIssues - omittedIssues 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 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.