> ## Documentation Index > Fetch the complete documentation index at: https://evalgate.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create change assessments import > Requires scopes: eval:write ## OpenAPI ````yaml /api-reference/openapi.json post /api/change-assessments/import openapi: 3.1.2 info: title: EvalGate API version: 18.10.0 description: EvalGate API. See docs/api-contract.md for stability commitments. servers: - url: https://evalgate.com description: Production - url: http://localhost:3000 description: Local security: [] paths: /api/change-assessments/import: post: tags: - change assessments summary: Create change assessments import description: 'Requires scopes: eval:write' operationId: post_change_assessments_import parameters: - name: mode in: query required: false schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiChangeAssessmentsImportRequest' responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/PostApiChangeAssessmentsImportResponse200ApplicationJson '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' '503': $ref: '#/components/responses/ServiceUnavailable' security: - bearerAuth: [] components: schemas: PostApiChangeAssessmentsImportRequest: oneOf: - type: object properties: document: type: string targetAuthority: oneOf: - type: string enum: - investigation - type: string enum: - release_review additionalProperties: false required: - document - type: object properties: document: type: string title: type: string spendLimitUsd: type: number targetAuthority: oneOf: - type: string enum: - investigation - type: string enum: - release_review additionalProperties: false required: - document PostApiChangeAssessmentsImportResponse200ApplicationJson: oneOf: - type: object properties: mode: type: string enum: - preview wouldStore: type: object properties: evidenceItem: type: boolean enum: - true changeAssessment: type: boolean enum: - true evidenceProposalDisposition: type: string enum: - unsuitable trustLevel: type: string enum: - investigation_only additionalProperties: false required: - evidenceItem - changeAssessment - evidenceProposalDisposition - trustLevel summary: type: object properties: format: type: string byteSha256: type: string byteLength: type: number variants: type: number cases: type: number executions: type: number observedResult: type: string importedClaimStatus: type: string importedClaimDetail: type: string reportedWinner: oneOf: - type: 'null' - type: string recomputedWinner: oneOf: - type: 'null' - type: string releaseAuthority: type: string enum: - none candidateUnderReview: oneOf: - type: 'null' - type: string checks: type: array items: type: object properties: id: type: string status: type: string detail: type: string additionalProperties: false required: - id - status - detail cost: type: object properties: reportedExperimentSpendUsd: oneOf: - type: 'null' - type: number reportedExperimentSpendStatus: type: string recomputedExperimentSpendStatus: type: string candidateOperatingCostStatus: type: string verificationCostStatus: type: string additionalProperties: false required: - reportedExperimentSpendUsd - reportedExperimentSpendStatus - recomputedExperimentSpendStatus - candidateOperatingCostStatus - verificationCostStatus trajectory: type: array items: type: object properties: id: type: string role: oneOf: - type: string enum: - base - type: string enum: - candidate ordinal: type: number label: oneOf: - type: 'null' - type: string headlineMean: oneOf: - type: 'null' - type: number casesObserved: type: number okObservations: type: number nonOkObservations: type: object additionalProperties: type: number cumulativeDiffSha256: oneOf: - type: 'null' - type: string pairedDelta: oneOf: - type: 'null' - type: number caseUnits: oneOf: - type: 'null' - type: number attempts: oneOf: - type: 'null' - type: number additionalProperties: false required: - id - role - ordinal - label - headlineMean - casesObserved - okObservations - nonOkObservations - cumulativeDiffSha256 - pairedDelta - caseUnits - attempts caseMovement: oneOf: - type: 'null' - type: object properties: improved: type: number regressed: type: number unchanged: type: number incomplete: type: number additionalProperties: false required: - improved - regressed - unchanged - incomplete nextActions: type: array items: type: object properties: id: type: string title: type: string detail: type: string requiredFor: type: string additionalProperties: false required: - id - title - detail - requiredFor additionalProperties: false required: - format - byteSha256 - byteLength - variants - cases - executions - observedResult - importedClaimStatus - importedClaimDetail - reportedWinner - recomputedWinner - releaseAuthority - candidateUnderReview - checks - cost - trajectory - caseMovement - nextActions plan: type: object properties: currentAuthority: oneOf: - type: string enum: - investigation - type: string enum: - release_review targetAuthority: oneOf: - type: string enum: - investigation - type: string enum: - release_review eligibleForReleaseReview: type: boolean blocking: type: array items: type: object properties: id: oneOf: - type: string enum: - behavior_measurement - type: string enum: - candidate_identity - type: string enum: - confirmation - type: string enum: - cost_verification - type: string enum: - evaluator_qualification - type: string enum: - protected_regression title: type: string status: oneOf: - type: string enum: - conditional - type: string enum: - established - type: string enum: - missing - type: string enum: - not_required - type: string enum: - stale detail: type: string action: oneOf: - type: 'null' - type: string owner: type: string canonicalKind: type: string evidenceRef: oneOf: - type: 'null' - type: string estimatedAdditionalCostUsd: oneOf: - type: 'null' - type: number additionalProperties: false required: - id - title - status - detail - action - owner - canonicalKind - evidenceRef - estimatedAdditionalCostUsd requirements: type: array items: type: object properties: id: oneOf: - type: string enum: - behavior_measurement - type: string enum: - candidate_identity - type: string enum: - confirmation - type: string enum: - cost_verification - type: string enum: - evaluator_qualification - type: string enum: - protected_regression title: type: string status: oneOf: - type: string enum: - conditional - type: string enum: - established - type: string enum: - missing - type: string enum: - not_required - type: string enum: - stale detail: type: string action: oneOf: - type: 'null' - type: string owner: type: string canonicalKind: type: string evidenceRef: oneOf: - type: 'null' - type: string estimatedAdditionalCostUsd: oneOf: - type: 'null' - type: number additionalProperties: false required: - id - title - status - detail - action - owner - canonicalKind - evidenceRef - estimatedAdditionalCostUsd additionalProperties: false required: - currentAuthority - targetAuthority - eligibleForReleaseReview - blocking - requirements additionalProperties: false required: - mode - wouldStore - summary - plan - type: object properties: mode: type: string enum: - persisted assessmentId: type: number stateVersion: type: number title: type: string status: type: string origin: type: string enum: - external_import authority: oneOf: - type: string enum: - investigation - type: string enum: - release_review targetAuthority: oneOf: - type: string enum: - investigation - type: string enum: - release_review eligibleForReleaseReview: type: boolean summary: oneOf: - type: 'null' - type: object properties: format: type: string byteSha256: type: string byteLength: type: number variants: type: number cases: type: number executions: type: number observedResult: type: string importedClaimStatus: type: string importedClaimDetail: type: string reportedWinner: oneOf: - type: 'null' - type: string recomputedWinner: oneOf: - type: 'null' - type: string releaseAuthority: type: string enum: - none candidateUnderReview: oneOf: - type: 'null' - type: string checks: type: array items: type: object properties: id: type: string status: type: string detail: type: string additionalProperties: false required: - id - status - detail cost: type: object properties: reportedExperimentSpendUsd: oneOf: - type: 'null' - type: number reportedExperimentSpendStatus: type: string recomputedExperimentSpendStatus: type: string candidateOperatingCostStatus: type: string verificationCostStatus: type: string additionalProperties: false required: - reportedExperimentSpendUsd - reportedExperimentSpendStatus - recomputedExperimentSpendStatus - candidateOperatingCostStatus - verificationCostStatus trajectory: type: array items: type: object properties: id: type: string role: oneOf: - type: string enum: - base - type: string enum: - candidate ordinal: type: number label: oneOf: - type: 'null' - type: string headlineMean: oneOf: - type: 'null' - type: number casesObserved: type: number okObservations: type: number nonOkObservations: type: object additionalProperties: type: number cumulativeDiffSha256: oneOf: - type: 'null' - type: string pairedDelta: oneOf: - type: 'null' - type: number caseUnits: oneOf: - type: 'null' - type: number attempts: oneOf: - type: 'null' - type: number additionalProperties: false required: - id - role - ordinal - label - headlineMean - casesObserved - okObservations - nonOkObservations - cumulativeDiffSha256 - pairedDelta - caseUnits - attempts caseMovement: oneOf: - type: 'null' - type: object properties: improved: type: number regressed: type: number unchanged: type: number incomplete: type: number additionalProperties: false required: - improved - regressed - unchanged - incomplete nextActions: type: array items: type: object properties: id: type: string title: type: string detail: type: string requiredFor: type: string additionalProperties: false required: - id - title - detail - requiredFor additionalProperties: false required: - format - byteSha256 - byteLength - variants - cases - executions - observedResult - importedClaimStatus - importedClaimDetail - reportedWinner - recomputedWinner - releaseAuthority - candidateUnderReview - checks - cost - trajectory - caseMovement - nextActions plan: type: object properties: currentAuthority: oneOf: - type: string enum: - investigation - type: string enum: - release_review targetAuthority: oneOf: - type: string enum: - investigation - type: string enum: - release_review eligibleForReleaseReview: type: boolean blocking: type: array items: type: object properties: id: oneOf: - type: string enum: - behavior_measurement - type: string enum: - candidate_identity - type: string enum: - confirmation - type: string enum: - cost_verification - type: string enum: - evaluator_qualification - type: string enum: - protected_regression title: type: string status: oneOf: - type: string enum: - conditional - type: string enum: - established - type: string enum: - missing - type: string enum: - not_required - type: string enum: - stale detail: type: string action: oneOf: - type: 'null' - type: string owner: type: string canonicalKind: type: string evidenceRef: oneOf: - type: 'null' - type: string estimatedAdditionalCostUsd: oneOf: - type: 'null' - type: number additionalProperties: false required: - id - title - status - detail - action - owner - canonicalKind - evidenceRef - estimatedAdditionalCostUsd requirements: type: array items: type: object properties: id: oneOf: - type: string enum: - behavior_measurement - type: string enum: - candidate_identity - type: string enum: - confirmation - type: string enum: - cost_verification - type: string enum: - evaluator_qualification - type: string enum: - protected_regression title: type: string status: oneOf: - type: string enum: - conditional - type: string enum: - established - type: string enum: - missing - type: string enum: - not_required - type: string enum: - stale detail: type: string action: oneOf: - type: 'null' - type: string owner: type: string canonicalKind: type: string evidenceRef: oneOf: - type: 'null' - type: string estimatedAdditionalCostUsd: oneOf: - type: 'null' - type: number additionalProperties: false required: - id - title - status - detail - action - owner - canonicalKind - evidenceRef - estimatedAdditionalCostUsd additionalProperties: false required: - currentAuthority - targetAuthority - eligibleForReleaseReview - blocking - requirements binding: type: object properties: verified: oneOf: - type: 'null' - type: object properties: githubRepositoryId: type: number fullName: type: string commitSha: type: string treeSha: oneOf: - type: 'null' - type: string verifiedAt: type: string current: type: boolean staleReason: oneOf: - type: 'null' - type: string additionalProperties: false required: - githubRepositoryId - fullName - commitSha - treeSha - verifiedAt - current - staleReason bindableRepositories: type: array items: type: object properties: id: type: number fullName: type: string defaultBranch: oneOf: - type: 'null' - type: string lastSeenDefaultSha: oneOf: - type: 'null' - type: string additionalProperties: false required: - id - fullName - defaultBranch - lastSeenDefaultSha governedCandidates: type: array items: type: object properties: candidateId: type: string cycleId: type: string targetKind: type: string repositoryCommitSha: type: string status: type: string evaluatedAt: oneOf: - type: 'null' - type: string label: type: string governed: type: object properties: candidateId: type: string candidateStatus: oneOf: - type: 'null' - type: string verdict: oneOf: - type: string enum: - accepted - type: string enum: - inconclusive - type: string enum: - pending - type: string enum: - rejected summary: type: string partitions: type: array items: type: object properties: role: oneOf: - type: string enum: - regression - type: string enum: - remediation - type: string enum: - sealed_holdout partitionId: oneOf: - type: 'null' - type: string decision: oneOf: - type: string enum: - base_better - type: string enum: - candidate_better - type: string enum: - equivalent_within_policy - type: string enum: - inconclusive - type: string enum: - invalid decidedAt: oneOf: - type: 'null' - type: string reasonCodes: type: array items: type: string primaryMetric: oneOf: - type: 'null' - type: object properties: name: type: string baseEstimate: type: number candidateEstimate: type: number delta: type: number interval: type: object properties: lower: type: number upper: type: number additionalProperties: false required: - lower - upper meaningfulDelta: type: number additionalProperties: false required: - name baseTrials: oneOf: - type: 'null' - type: number candidateTrials: oneOf: - type: 'null' - type: number baseCaseUnits: oneOf: - type: 'null' - type: number candidateCaseUnits: oneOf: - type: 'null' - type: number multipleComparisonPolicy: oneOf: - type: 'null' - type: string executionPurpose: oneOf: - type: 'null' - type: string enum: - confirmation_only - type: string enum: - selection optimizerFeedbackProhibited: oneOf: - type: 'null' - type: boolean enum: - false - type: boolean enum: - true additionalProperties: false required: - role - partitionId - decision - decidedAt - reasonCodes - primaryMetric - baseTrials - candidateTrials - baseCaseUnits - candidateCaseUnits - multipleComparisonPolicy - executionPurpose - optimizerFeedbackProhibited reasonCodes: type: array items: type: string additionalProperties: false required: - candidateId - candidateStatus - verdict - summary - partitions - reasonCodes canonical: type: object properties: candidateId: type: string cycleId: type: string repositoryCommitSha: type: string targetKind: type: string candidateStatus: type: string candidateContentHash: oneOf: - type: 'null' - type: string evaluatedAt: oneOf: - type: 'null' - type: string partitions: type: object properties: remediation: oneOf: - type: 'null' - type: object properties: decision: type: string reasonCodes: type: array items: type: string multipleComparisonPolicy: oneOf: - type: 'null' - type: string additionalProperties: false required: - decision - reasonCodes - multipleComparisonPolicy regression: oneOf: - type: 'null' - type: object properties: decision: type: string reasonCodes: type: array items: type: string additionalProperties: false required: - decision - reasonCodes sealedHoldout: oneOf: - type: 'null' - type: object properties: decision: type: string reasonCodes: type: array items: type: string partitionId: oneOf: - type: 'null' - type: string decidedAt: oneOf: - type: 'null' - type: string executionPurpose: oneOf: - type: 'null' - type: string enum: - confirmation_only - type: string enum: - selection optimizerFeedbackProhibited: type: boolean additionalProperties: false required: - decision - reasonCodes - partitionId - decidedAt - executionPurpose - optimizerFeedbackProhibited additionalProperties: false required: - remediation - regression - sealedHoldout confirmationExposure: oneOf: - type: 'null' - type: object properties: partitionId: type: string lifecycleRole: oneOf: - type: string enum: - confirmation - type: string enum: - development - type: string enum: - production - type: string enum: - selection confirmationAuthorityStatus: oneOf: - type: string enum: - active_confirmation - type: string enum: - not_applicable - type: string enum: - reserve - type: string enum: - retired_for_confirmation confirmationLineageKey: oneOf: - type: 'null' - type: string rawCaseExposures: type: number scoreDisclosures: type: number candidateDecisions: type: number optimizationCampaigns: type: number lastUsedAt: oneOf: - type: 'null' - type: string confirmationEligible: type: boolean confirmationIneligibleReason: oneOf: - type: 'null' - type: string retiredFromConfirmationAt: oneOf: - type: 'null' - type: string confirmationRetirementReason: oneOf: - type: 'null' - type: string supersededByPartitionId: oneOf: - type: 'null' - type: string frozenCandidateId: oneOf: - type: 'null' - type: string frozenAt: oneOf: - type: 'null' - type: string frozenContentHash: oneOf: - type: 'null' - type: string memberCount: type: number additionalProperties: false required: - partitionId - lifecycleRole - confirmationAuthorityStatus - confirmationLineageKey - rawCaseExposures - scoreDisclosures - candidateDecisions - optimizationCampaigns - lastUsedAt - confirmationEligible - confirmationIneligibleReason - retiredFromConfirmationAt - confirmationRetirementReason - supersededByPartitionId - frozenCandidateId - frozenAt - frozenContentHash - memberCount additionalProperties: false required: - candidateId - cycleId - repositoryCommitSha - targetKind - candidateStatus - candidateContentHash - evaluatedAt - partitions - confirmationExposure additionalProperties: false required: - candidateId - cycleId - targetKind - repositoryCommitSha - status - evaluatedAt - label - governed - canonical autoSelectedCandidateId: oneOf: - type: 'null' - type: string additionalProperties: false required: - verified - bindableRepositories - governedCandidates - autoSelectedCandidateId governedOutcome: oneOf: - type: 'null' - type: object properties: candidateId: type: string candidateStatus: oneOf: - type: 'null' - type: string verdict: oneOf: - type: string enum: - accepted - type: string enum: - inconclusive - type: string enum: - pending - type: string enum: - rejected summary: type: string partitions: type: array items: type: object properties: role: oneOf: - type: string enum: - regression - type: string enum: - remediation - type: string enum: - sealed_holdout partitionId: oneOf: - type: 'null' - type: string decision: oneOf: - type: string enum: - base_better - type: string enum: - candidate_better - type: string enum: - equivalent_within_policy - type: string enum: - inconclusive - type: string enum: - invalid decidedAt: oneOf: - type: 'null' - type: string reasonCodes: type: array items: type: string primaryMetric: oneOf: - type: 'null' - type: object properties: name: type: string baseEstimate: type: number candidateEstimate: type: number delta: type: number interval: type: object properties: lower: type: number upper: type: number additionalProperties: false required: - lower - upper meaningfulDelta: type: number additionalProperties: false required: - name baseTrials: oneOf: - type: 'null' - type: number candidateTrials: oneOf: - type: 'null' - type: number baseCaseUnits: oneOf: - type: 'null' - type: number candidateCaseUnits: oneOf: - type: 'null' - type: number multipleComparisonPolicy: oneOf: - type: 'null' - type: string executionPurpose: oneOf: - type: 'null' - type: string enum: - confirmation_only - type: string enum: - selection optimizerFeedbackProhibited: oneOf: - type: 'null' - type: boolean enum: - false - type: boolean enum: - true additionalProperties: false required: - role - partitionId - decision - decidedAt - reasonCodes - primaryMetric - baseTrials - candidateTrials - baseCaseUnits - candidateCaseUnits - multipleComparisonPolicy - executionPurpose - optimizerFeedbackProhibited reasonCodes: type: array items: type: string additionalProperties: false required: - candidateId - candidateStatus - verdict - summary - partitions - reasonCodes canonicalEvidence: oneOf: - type: 'null' - type: object properties: candidateId: type: string cycleId: type: string repositoryCommitSha: type: string targetKind: type: string candidateStatus: type: string candidateContentHash: oneOf: - type: 'null' - type: string evaluatedAt: oneOf: - type: 'null' - type: string partitions: type: object properties: remediation: oneOf: - type: 'null' - type: object properties: decision: type: string reasonCodes: type: array items: type: string multipleComparisonPolicy: oneOf: - type: 'null' - type: string additionalProperties: false required: - decision - reasonCodes - multipleComparisonPolicy regression: oneOf: - type: 'null' - type: object properties: decision: type: string reasonCodes: type: array items: type: string additionalProperties: false required: - decision - reasonCodes sealedHoldout: oneOf: - type: 'null' - type: object properties: decision: type: string reasonCodes: type: array items: type: string partitionId: oneOf: - type: 'null' - type: string decidedAt: oneOf: - type: 'null' - type: string executionPurpose: oneOf: - type: 'null' - type: string enum: - confirmation_only - type: string enum: - selection optimizerFeedbackProhibited: type: boolean additionalProperties: false required: - decision - reasonCodes - partitionId - decidedAt - executionPurpose - optimizerFeedbackProhibited additionalProperties: false required: - remediation - regression - sealedHoldout confirmationExposure: oneOf: - type: 'null' - type: object properties: partitionId: type: string lifecycleRole: oneOf: - type: string enum: - confirmation - type: string enum: - development - type: string enum: - production - type: string enum: - selection confirmationAuthorityStatus: oneOf: - type: string enum: - active_confirmation - type: string enum: - not_applicable - type: string enum: - reserve - type: string enum: - retired_for_confirmation confirmationLineageKey: oneOf: - type: 'null' - type: string rawCaseExposures: type: number scoreDisclosures: type: number candidateDecisions: type: number optimizationCampaigns: type: number lastUsedAt: oneOf: - type: 'null' - type: string confirmationEligible: type: boolean confirmationIneligibleReason: oneOf: - type: 'null' - type: string retiredFromConfirmationAt: oneOf: - type: 'null' - type: string confirmationRetirementReason: oneOf: - type: 'null' - type: string supersededByPartitionId: oneOf: - type: 'null' - type: string frozenCandidateId: oneOf: - type: 'null' - type: string frozenAt: oneOf: - type: 'null' - type: string frozenContentHash: oneOf: - type: 'null' - type: string memberCount: type: number additionalProperties: false required: - partitionId - lifecycleRole - confirmationAuthorityStatus - confirmationLineageKey - rawCaseExposures - scoreDisclosures - candidateDecisions - optimizationCampaigns - lastUsedAt - confirmationEligible - confirmationIneligibleReason - retiredFromConfirmationAt - confirmationRetirementReason - supersededByPartitionId - frozenCandidateId - frozenAt - frozenContentHash - memberCount additionalProperties: false required: - candidateId - cycleId - repositoryCommitSha - targetKind - candidateStatus - candidateContentHash - evaluatedAt - partitions - confirmationExposure confirmationRecovery: oneOf: - type: 'null' - type: object properties: status: oneOf: - type: string enum: - eligible - type: string enum: - established - type: string enum: - missing - type: string enum: - not_eligible headline: type: string reason: oneOf: - type: 'null' - type: string rawCaseExposures: type: number scoreDisclosures: type: number candidateDecisions: type: number optimizationCampaigns: type: number whatToDoNext: oneOf: - type: 'null' - type: string lineage: type: array items: type: object properties: partitionId: type: string partitionRef: type: string authorityStatus: type: string label: type: string memberCount: type: number confirmationEligible: type: boolean scoreDisclosures: type: number candidateDecisions: type: number rawCaseExposures: type: number retirementReason: oneOf: - type: 'null' - type: string retiredAt: oneOf: - type: 'null' - type: string supersededByPartitionId: oneOf: - type: 'null' - type: string usableFor: type: array items: type: string additionalProperties: false required: - partitionId - partitionRef - authorityStatus - label - memberCount - confirmationEligible - scoreDisclosures - candidateDecisions - rawCaseExposures - retirementReason - retiredAt - supersededByPartitionId - usableFor activePartitionId: oneOf: - type: 'null' - type: string estimatedVerificationCostUsd: oneOf: - type: 'null' - type: object properties: low: type: number high: type: number additionalProperties: false required: - low - high additionalProperties: false required: - status - headline - reason - rawCaseExposures - scoreDisclosures - candidateDecisions - optimizationCampaigns - whatToDoNext - lineage - activePartitionId - estimatedVerificationCostUsd confirmationPlan: oneOf: - type: 'null' - type: object properties: candidateId: type: string candidateLabel: type: string frozen: type: boolean enum: - true frozenContentHash: type: string partitionId: type: string caseUnits: type: number previousOptimizerExposure: type: string enum: - none candidateSelection: type: string enum: - complete estimatedVerificationCostUsd: type: 'null' resultsReturnedToOptimizer: type: boolean enum: - false detail: type: string additionalProperties: false required: - candidateId - candidateLabel - frozen - frozenContentHash - partitionId - caseUnits - previousOptimizerExposure - candidateSelection - estimatedVerificationCostUsd - resultsReturnedToOptimizer - detail campaign: oneOf: - type: 'null' - type: object properties: baseCommit: type: string candidateCommit: type: string candidateBranch: type: string promptPath: type: string baseContentSha256: type: string candidateContentSha256: type: string contract: oneOf: - type: 'null' - type: object properties: body: type: object properties: contractHash: type: string schemaVersion: type: number enum: - 1 compiler: type: string enum: - evalgate-intent-v1 intent: type: object properties: text: oneOf: - type: 'null' - type: string clauses: type: array items: type: object properties: text: type: string status: oneOf: - type: string enum: - recognized - type: string enum: - unrecognized interpretedAs: type: array items: type: string additionalProperties: false required: - text - status - interpretedAs additionalProperties: false required: - text - clauses objective: type: object properties: kind: oneOf: - type: string enum: - improve_quality - type: string enum: - reduce_failure_mode - type: string enum: - reduce_operating_cost failureMode: oneOf: - type: 'null' - type: string primaryMetric: oneOf: - type: 'null' - type: string additionalProperties: false required: - kind - failureMode - primaryMetric quality: type: object properties: protectedMetrics: type: array items: type: string nonInferiorityMargins: type: object additionalProperties: type: number criticalSlices: type: array items: type: string safetyRequirements: type: array items: type: string guardrails: type: object additionalProperties: type: number additionalProperties: false required: - protectedMetrics - nonInferiorityMargins - criticalSlices - safetyRequirements surfaces: type: object properties: editable: type: array items: oneOf: - type: object properties: kind: type: string enum: - prompt paths: type: array items: type: string additionalProperties: false required: - kind - paths - type: object properties: kind: type: string enum: - target_model allowed: type: array items: type: string additionalProperties: false required: - kind - allowed - type: object properties: kind: type: string enum: - target_effort allowed: type: array items: oneOf: - type: string enum: - high - type: string enum: - low - type: string enum: - medium - type: string enum: - minimal additionalProperties: false required: - kind - allowed immutablePaths: type: array items: type: string additionalProperties: false required: - editable - immutablePaths identities: type: object properties: grader: oneOf: - type: 'null' - type: string cases: oneOf: - type: 'null' - type: string baseline: oneOf: - type: 'null' - type: string policy: oneOf: - type: 'null' - type: string additionalProperties: false required: - grader - cases - baseline - policy populations: type: object properties: development: oneOf: - type: 'null' - type: string selection: oneOf: - type: 'null' - type: string confirmation: oneOf: - type: 'null' - type: string additionalProperties: false required: - development - selection - confirmation budget: type: object properties: searchUsd: oneOf: - type: 'null' - type: number executionUsd: oneOf: - type: 'null' - type: number confirmationUsd: oneOf: - type: 'null' - type: number maxTrials: oneOf: - type: 'null' - type: number additionalProperties: false required: - searchUsd - executionUsd - confirmationUsd - maxTrials stopConditions: type: object additionalProperties: type: number isolation: type: object properties: required: oneOf: - type: string enum: - oci - type: string enum: - process - type: string enum: - worktree additionalProperties: false required: - required authority: type: object properties: optimizer: type: array minItems: 2 maxItems: 2 prefixItems: - type: string enum: - propose - type: string enum: - test evalgate: type: array minItems: 1 maxItems: 1 prefixItems: - type: string enum: - qualify human: type: array minItems: 2 maxItems: 2 prefixItems: - type: string enum: - adopt - type: string enum: - merge additionalProperties: false required: - optimizer - evalgate - human assumptions: type: array items: type: string additionalProperties: false required: - contractHash - schemaVersion - compiler - intent - objective - quality - surfaces - identities - populations - budget - stopConditions - isolation - authority - assumptions hash: type: string objective: type: string nonInferiorityMargins: type: object additionalProperties: type: number criticalSlices: type: array items: type: string safetyRequirements: type: array items: type: string guardrails: type: object additionalProperties: type: number additionalProperties: false required: - hash - objective - nonInferiorityMargins - criticalSlices - safetyRequirements - guardrails populations: type: object properties: development: type: array items: type: string selection: type: array items: type: string families: type: object properties: development: type: array items: type: string selection: type: array items: type: string additionalProperties: false required: - development - selection additionalProperties: false required: - development - selection - families confirmation: type: object properties: count: type: number digest: oneOf: - type: 'null' - type: string additionalProperties: false required: - count - digest additionalProperties: false required: - baseCommit - candidateCommit - candidateBranch - promptPath - baseContentSha256 - candidateContentSha256 - contract - populations - confirmation campaignConfirmations: type: array items: type: object properties: id: type: string status: oneOf: - type: string enum: - confirmed - type: string enum: - inconclusive - type: string enum: - invalid - type: string enum: - refuted - type: string enum: - revoked - type: string enum: - running - type: string enum: - starting evaluationId: type: number testCaseCount: type: number candidateContentSha256: type: string baseCommit: type: string candidateCommit: type: string baseRunId: oneOf: - type: 'null' - type: number candidateRunId: oneOf: - type: 'null' - type: number contractHash: oneOf: - type: 'null' - type: string revokedReason: oneOf: - type: 'null' - type: string decision: oneOf: - type: 'null' - type: object properties: claim: oneOf: - type: string enum: - cost_reduction_supported - type: string enum: - no_claim - type: string enum: - refused - type: string enum: - selection_evidence_only reasonCodes: type: array items: type: string evidence: type: object properties: cases: type: number plannedCases: type: number attempts: type: object properties: baseline: type: number candidate: type: number additionalProperties: false required: - baseline - candidate complete: type: boolean additionalProperties: false required: - cases - plannedCases - attempts - complete quality: type: array items: type: object properties: metric: type: string margin: type: number baselineMean: type: number candidateMean: type: number delta: type: number interval: oneOf: - type: 'null' - type: object properties: lower: type: number upper: type: number confidenceLevel: type: number method: oneOf: - type: string enum: - newcombe-hybrid-score - type: string enum: - percentile-bootstrap - type: string enum: - welch-t - type: string enum: - wilson resamples: type: number seed: type: number additionalProperties: false required: - lower - upper - confidenceLevel - method decision: oneOf: - type: string enum: - inconclusive - type: string enum: - inferior - type: string enum: - non_inferior cases: type: number additionalProperties: false required: - metric - margin - baselineMean - candidateMean - delta - interval - decision - cases safety: type: object properties: baselineHardFailures: type: number candidateHardFailures: type: number additionalProperties: false required: - baselineHardFailures - candidateHardFailures criticalSlices: type: array items: type: object properties: slice: type: string cases: type: number baselineMean: type: number candidateMean: type: number regressed: type: boolean additionalProperties: false required: - slice - cases - baselineMean - candidateMean - regressed operatingCost: type: object properties: status: oneOf: - type: string enum: - measured - type: string enum: - unknown reason: oneOf: - type: 'null' - type: string baselinePerRequestUsd: oneOf: - type: 'null' - type: number candidatePerRequestUsd: oneOf: - type: 'null' - type: number savingsPerRequestUsd: oneOf: - type: 'null' - type: number savingsInterval: oneOf: - type: 'null' - type: object properties: lower: type: number upper: type: number confidenceLevel: type: number method: oneOf: - type: string enum: - newcombe-hybrid-score - type: string enum: - percentile-bootstrap - type: string enum: - welch-t - type: string enum: - wilson resamples: type: number seed: type: number additionalProperties: false required: - lower - upper - confidenceLevel - method savingsPercent: oneOf: - type: 'null' - type: number decision: oneOf: - type: string enum: - cheaper - type: string enum: - inconclusive - type: string enum: - not_cheaper - type: string enum: - unknown baseline: type: object properties: servedModel: oneOf: - type: 'null' - type: string priceProvenance: oneOf: - type: string enum: - estimated - type: string enum: - unknown - type: string enum: - verified priceTableVersion: oneOf: - type: 'null' - type: string cacheCondition: oneOf: - type: string enum: - cold - type: string enum: - mixed - type: string enum: - unknown - type: string enum: - warm additionalProperties: false required: - servedModel - priceProvenance - priceTableVersion - cacheCondition candidate: type: object properties: servedModel: oneOf: - type: 'null' - type: string priceProvenance: oneOf: - type: string enum: - estimated - type: string enum: - unknown - type: string enum: - verified priceTableVersion: oneOf: - type: 'null' - type: string cacheCondition: oneOf: - type: string enum: - cold - type: string enum: - mixed - type: string enum: - unknown - type: string enum: - warm additionalProperties: false required: - servedModel - priceProvenance - priceTableVersion - cacheCondition additionalProperties: false required: - status - reason - baselinePerRequestUsd - candidatePerRequestUsd - savingsPerRequestUsd - savingsInterval - savingsPercent - decision - baseline - candidate latency: type: object properties: boundary: oneOf: - type: string enum: - model_response - type: string enum: - workflow baselineMs: oneOf: - type: 'null' - type: number candidateMs: oneOf: - type: 'null' - type: number deltaMs: oneOf: - type: 'null' - type: number additionalProperties: false required: - boundary - baselineMs - candidateMs - deltaMs spend: allOf: - type: object properties: searchUsd: oneOf: - type: 'null' - type: number evaluationUsd: oneOf: - type: 'null' - type: number confirmationUsd: oneOf: - type: 'null' - type: number additionalProperties: false required: - searchUsd - evaluationUsd - confirmationUsd - type: object properties: totalOptimizationUsd: oneOf: - type: 'null' - type: number additionalProperties: false required: - totalOptimizationUsd breakEvenRequests: oneOf: - type: 'null' - type: number additionalProperties: false required: - claim - reasonCodes - evidence - quality - safety - criticalSlices - operatingCost - latency - spend - breakEvenRequests executionIdentity: oneOf: - type: 'null' - type: object properties: verified: type: boolean violations: type: array items: type: object properties: caseId: type: number arm: oneOf: - type: string enum: - base - type: string enum: - candidate reason: oneOf: - type: string enum: - EXECUTION_NOT_LIVE - type: string enum: - NO_RUNNER_COMPLETION - type: string enum: - TARGET_VERSION_UNREPORTED - type: string enum: - WRONG_COMMIT - type: string enum: - WRONG_TARGET_VERSION detail: oneOf: - type: 'null' - type: string additionalProperties: false required: - caseId - arm - reason - detail additionalProperties: false required: - verified - violations blockers: type: array items: type: string costClaimSupported: type: boolean createdAt: type: string additionalProperties: false required: - id - status - evaluationId - testCaseCount - candidateContentSha256 - baseCommit - candidateCommit - baseRunId - candidateRunId - contractHash - revokedReason - decision - executionIdentity - blockers - costClaimSupported - createdAt permissions: type: object properties: canMutate: type: boolean reason: oneOf: - type: 'null' - type: string additionalProperties: false required: - canMutate - reason waitingOn: type: object properties: actor: oneOf: - type: string enum: - nobody - type: string enum: - operator - type: string enum: - system detail: type: string additionalProperties: false required: - actor - detail additionalProperties: false required: - mode - assessmentId - stateVersion - title - status - origin - authority - targetAuthority - eligibleForReleaseReview - summary - plan - binding - governedOutcome - canonicalEvidence - confirmationRecovery - confirmationPlan - permissions - waitingOn ApiError: type: object properties: error: type: object properties: code: type: string enum: - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - INVALID_REFERENCE - VALIDATION_ERROR - RATE_LIMITED - CONFLICT - INTERNAL_ERROR - SERVICE_UNAVAILABLE - QUOTA_EXCEEDED - FEATURE_LIMIT_REACHED - NO_ORG_MEMBERSHIP - SHARE_REVOKED - SHARE_EXPIRED - SHARE_UNAVAILABLE - PROVIDER_KEY_MISSING - PROVIDER_KEY_EXPIRED - PROVIDER_RATE_LIMITED - PROVIDER_UNAUTHORIZED - PROVIDER_UNAVAILABLE - AGENT_HANDOFF_INVALID - AGENT_HANDOFF_EXPIRED - AGENT_HANDOFF_DENIED - AGENT_HANDOFF_CONSUMED - PAYLOAD_TOO_LARGE - METHOD_NOT_ALLOWED message: type: string details: {} requestId: type: string format: uuid redaction: type: object properties: applied: type: boolean enum: - true fieldCount: type: integer minimum: 0 secretCount: type: integer minimum: 0 required: - applied - fieldCount - secretCount required: - code - message required: - error responses: ValidationError: description: Validation error content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string WWW-Authenticate: description: >- Bearer challenge. Agent-facing routes include the RFC 9728 resource_metadata URL. schema: type: string Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string Conflict: description: Conflict content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string RateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string Retry-After: description: Delay in seconds before retrying when present. schema: type: integer minimum: 1 InternalError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string ServiceUnavailable: description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: EvalGate API key description: >- Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes. x-evalgate-scopes-supported: - eval:read - eval:write - objectives:read - objectives:write - runs:read - runs:write - traces:read - traces:write - exports:download - reports:write - prompt:publish - scorer:publish - red_team:read - red_team:run - red_team:approve - docs:read - agent:read - agent:execute - resources:read - resources:write - contexts:read - contexts:write - observations:write - checks:read - checks:run - standards:read - standards:write - standards:approve - grants:read - grants:write - admin:keys - admin:workspace - admin:org x-evalgate-protected-resource-metadata: https://www.evalgate.com/.well-known/oauth-protected-resource ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.