> ## 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 red team campaigns > Requires scopes: red_team:run ## OpenAPI ````yaml /api-reference/openapi.json post /api/red-team/campaigns openapi: 3.1.2 info: title: EvalGate API version: 18.13.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/red-team/campaigns: post: tags: - red team summary: Create red team campaigns description: 'Requires scopes: red_team:run' operationId: post_red_team_campaigns requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiRedTeamCampaignsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/PostApiRedTeamCampaignsResponse200ApplicationJson '201': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/PostApiRedTeamCampaignsResponse201ApplicationJson '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: PostApiRedTeamCampaignsRequest: type: object properties: name: type: string budget: type: object properties: maxCostUsd: type: number maxModelCalls: type: number concurrency: type: number maxTurnsPerCase: type: number additionalProperties: false required: - maxCostUsd - maxModelCalls - concurrency idempotencyKey: type: string target: type: object properties: type: oneOf: - type: string enum: - prompt - type: string enum: - scorer - type: string enum: - workflow - type: string enum: - tool - type: string enum: - deployment artifactId: type: number versionId: type: number contentHash: type: string environment: type: string sourceEvidence: oneOf: - type: object properties: repositoryId: type: number commitSha: type: string state: type: string enum: - linked graphVersionId: type: string repositorySnapshotId: type: string locations: type: array items: type: object properties: relationship: oneOf: - type: string enum: - test_target - type: string enum: - observed_execution - type: string enum: - suspected_contributor sourceLocatorId: type: string nodeIdentityId: type: string nodeRevisionId: type: string additionalProperties: false required: - relationship - sourceLocatorId additionalProperties: false required: - repositoryId - commitSha - state - graphVersionId - repositorySnapshotId - locations - type: object properties: reasonCode: type: string state: oneOf: - type: string enum: - not_applicable - type: string enum: - unlinked - type: string enum: - unavailable additionalProperties: false required: - reasonCode - state additionalProperties: false required: - type - artifactId - versionId - contentHash seed: type: number variants: type: array items: type: object properties: provider: type: string model: type: string key: type: string routingProfileId: type: string parameters: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' additionalProperties: false required: - provider - model - key scorers: type: array items: type: object properties: artifactId: type: number versionId: type: number contentHash: type: string required: oneOf: - type: boolean enum: - false - type: boolean enum: - true additionalProperties: false required: - artifactId - versionId - contentHash riskPackVersionIds: type: array items: type: string description: type: string ownerId: type: string datasetVersionId: type: string strategies: type: array items: oneOf: - type: string enum: - reverse - type: string enum: - none - type: string enum: - prompt_injection - type: string enum: - base64 - type: string enum: - rot13 - type: string enum: - leetspeak - type: string enum: - roleplay_wrapper - type: string enum: - crescendo - type: string enum: - hex - type: string enum: - homoglyph - type: string enum: - unicode_tag - type: string enum: - json_wrap createdFromRunId: type: string additionalProperties: false required: - name - budget - idempotencyKey - target - seed - variants - scorers - riskPackVersionIds PostApiRedTeamCampaignsResponse200ApplicationJson: type: object properties: campaign: type: object properties: id: type: string organizationId: $ref: '#/components/schemas/OrganizationId' name: type: string description: oneOf: - type: 'null' - type: string ownerId: type: string status: type: string createIdempotencyKey: type: string createdBy: type: string createdAt: type: string format: date-time additionalProperties: false required: - id - organizationId - name - description - ownerId - status - createIdempotencyKey - createdBy - createdAt version: type: object properties: id: type: string organizationId: $ref: '#/components/schemas/OrganizationId' campaignId: type: string version: type: number status: type: string targetType: type: string targetArtifactId: type: number targetArtifactVersionId: type: number targetContentHash: type: string snapshotHash: type: string snapshot: oneOf: - type: object properties: schemaVersion: type: number enum: - 1 budget: type: object properties: maxCostUsd: type: number maxModelCalls: type: number concurrency: type: number maxTurnsPerCase: type: number additionalProperties: false required: - maxCostUsd - maxModelCalls - concurrency - maxTurnsPerCase target: type: object properties: type: oneOf: - type: string enum: - prompt - type: string enum: - scorer - type: string enum: - workflow - type: string enum: - tool - type: string enum: - deployment artifactId: type: number versionId: type: number contentHash: type: string environment: type: string sourceEvidence: oneOf: - type: object properties: repositoryId: type: number commitSha: type: string state: type: string enum: - linked graphVersionId: type: string repositorySnapshotId: type: string locations: type: array items: type: object properties: relationship: oneOf: - type: string enum: - test_target - type: string enum: - observed_execution - type: string enum: - suspected_contributor sourceLocatorId: type: string nodeIdentityId: type: string nodeRevisionId: type: string additionalProperties: false required: - relationship - sourceLocatorId additionalProperties: false required: - repositoryId - commitSha - state - graphVersionId - repositorySnapshotId - locations - type: object properties: reasonCode: type: string state: oneOf: - type: string enum: - not_applicable - type: string enum: - unlinked - type: string enum: - unavailable additionalProperties: false required: - reasonCode - state additionalProperties: false required: - type - artifactId - versionId - contentHash seed: type: number variants: type: array items: type: object properties: provider: type: string model: type: string parameters: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' key: type: string routingProfileId: type: string additionalProperties: false required: - provider - model - parameters - key riskPackVersions: type: array items: type: object properties: artifactId: type: number versionId: type: number contentHash: type: string taxonomy: type: string taxonomyVersion: type: string additionalProperties: false required: - artifactId - versionId - contentHash - taxonomy - taxonomyVersion attackCases: type: array items: type: object properties: id: type: string severity: oneOf: - type: string enum: - medium - type: string enum: - high - type: string enum: - critical - type: string enum: - low source: oneOf: - type: string enum: - generated - type: string enum: - imported - type: string enum: - built_in - type: string enum: - human_authored - type: string enum: - file_imported - type: string enum: - model_generated - type: string enum: - framework_derived - type: string enum: - production_failure_derived contentHash: type: string input: type: string category: oneOf: - type: string enum: - prompt_injection - type: string enum: - data_exfiltration_privacy - type: string enum: - harmful_content - type: string enum: - misinformation_hallucination - type: string enum: - authorization_bypass - type: string enum: - tool_misuse - type: string enum: - excessive_agency - type: string enum: - insecure_output_handling - type: string enum: - sensitive_data_disclosure - type: string enum: - policy_evasion - type: string enum: - denial_of_wallet - type: string enum: - jailbreak_robustness - type: string enum: - system_prompt_leakage - type: string enum: - supply_chain_poisoning - type: string enum: - vector_embedding_weakness - type: string enum: - bias_fairness_discrimination - type: string enum: - hate_speech_harassment - type: string enum: - self_harm_content - type: string enum: - violent_extremism_weapons - type: string enum: - child_safety_content - type: string enum: - sexual_content_exploitation - type: string enum: - illegal_activity_facilitation - type: string enum: - copyright_ip_infringement - type: string enum: - indirect_prompt_injection - type: string enum: - ascii_unicode_smuggling - type: string enum: - training_data_extraction - type: string enum: - ssrf_network_pivot - type: string enum: - code_command_injection_via_tools - type: string enum: - broken_object_function_auth - type: string enum: - impersonation_brand_abuse - type: string enum: - unverifiable_high_stakes_claims reviewStatus: oneOf: - type: string enum: - approved - type: string enum: - proposed caseKey: type: string technique: type: string expectedSafeBehavior: type: string successIndicators: type: array items: type: string riskPackVersionId: type: number additionalProperties: false required: - id - severity - source - contentHash - input - category - reviewStatus - caseKey - technique - expectedSafeBehavior - successIndicators - riskPackVersionId scorers: type: array items: type: object properties: artifactId: type: number versionId: type: number contentHash: type: string required: type: boolean additionalProperties: false required: - artifactId - versionId - contentHash - required strategies: type: array items: oneOf: - type: string enum: - reverse - type: string enum: - none - type: string enum: - prompt_injection - type: string enum: - base64 - type: string enum: - rot13 - type: string enum: - leetspeak - type: string enum: - roleplay_wrapper - type: string enum: - crescendo - type: string enum: - hex - type: string enum: - homoglyph - type: string enum: - unicode_tag - type: string enum: - json_wrap datasetVersionId: type: string createdFromRunId: type: string additionalProperties: false required: - schemaVersion - budget - target - seed - variants - riskPackVersions - attackCases - scorers - strategies - type: object properties: schemaVersion: type: number enum: - 2 budget: type: object properties: maxCostUsd: type: number maxModelCalls: type: number concurrency: type: number maxTurnsPerCase: type: number additionalProperties: false required: - maxCostUsd - maxModelCalls - concurrency - maxTurnsPerCase target: type: object properties: type: oneOf: - type: string enum: - prompt - type: string enum: - scorer - type: string enum: - workflow - type: string enum: - tool - type: string enum: - deployment artifactId: type: number versionId: type: number contentHash: type: string environment: type: string sourceEvidence: oneOf: - type: object properties: repositoryId: type: number commitSha: type: string state: type: string enum: - linked graphVersionId: type: string repositorySnapshotId: type: string locations: type: array items: type: object properties: relationship: oneOf: - type: string enum: - test_target - type: string enum: - observed_execution - type: string enum: - suspected_contributor sourceLocatorId: type: string nodeIdentityId: type: string nodeRevisionId: type: string additionalProperties: false required: - relationship - sourceLocatorId additionalProperties: false required: - repositoryId - commitSha - state - graphVersionId - repositorySnapshotId - locations - type: object properties: reasonCode: type: string state: oneOf: - type: string enum: - not_applicable - type: string enum: - unlinked - type: string enum: - unavailable additionalProperties: false required: - reasonCode - state additionalProperties: false required: - type - artifactId - versionId - contentHash seed: type: number variants: type: array items: type: object properties: provider: type: string model: type: string parameters: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' key: type: string routingProfileId: type: string additionalProperties: false required: - provider - model - parameters - key benignCases: type: array items: type: object properties: id: type: string source: type: string enum: - framework_derived contentHash: type: string input: type: string expectedBehavior: type: string caseKey: type: string controlReference: type: object properties: schemaVersion: type: string frameworkKey: type: string enum: - aidefend sourceUrl: type: string parentId: oneOf: - type: 'null' - type: string license: type: string frameworkVersion: type: string snapshotGeneratedAt: type: string sourceCommit: oneOf: - type: 'null' - type: string sourceDigest: type: string requiredAttribution: type: string changesMadeNotice: type: string controlId: type: string controlTitle: type: string controlLevel: oneOf: - type: string enum: - parent_family - type: string enum: - standalone_technique - type: string enum: - leaf_subtechnique actionable: type: boolean tactic: oneOf: - type: string enum: - model - type: string enum: - harden - type: string enum: - detect - type: string enum: - isolate - type: string enum: - deceive - type: string enum: - evict - type: string enum: - restore pillars: type: array items: oneOf: - type: string enum: - data - type: string enum: - model - type: string enum: - app - type: string enum: - infra lifecyclePhases: type: array items: oneOf: - type: string enum: - validation - type: string enum: - operation - type: string enum: - response - type: string enum: - building - type: string enum: - improvement - type: string enum: - scoping relationship: oneOf: - type: string enum: - evidence_obligation - type: string enum: - verification_target mappingSource: oneOf: - type: string enum: - evalgate_reviewed_registry - type: string enum: - aidefend_catalog_only mappingRationale: type: string reviewState: oneOf: - type: string enum: - reviewed - type: string enum: - verification_design_required additionalProperties: false required: - schemaVersion - frameworkKey - sourceUrl - parentId - license - frameworkVersion - snapshotGeneratedAt - sourceCommit - sourceDigest - requiredAttribution - changesMadeNotice - controlId - controlTitle - controlLevel - actionable - tactic - pillars - lifecyclePhases - relationship - mappingSource - mappingRationale - reviewState expectedResult: type: string riskPackVersionId: type: number additionalProperties: false required: - id - source - contentHash - input - expectedBehavior - caseKey - controlReference - expectedResult - riskPackVersionId riskPackVersions: type: array items: type: object properties: artifactId: type: number versionId: type: number contentHash: type: string taxonomy: type: string taxonomyVersion: type: string additionalProperties: false required: - artifactId - versionId - contentHash - taxonomy - taxonomyVersion attackCases: type: array items: type: object properties: id: type: string severity: oneOf: - type: string enum: - medium - type: string enum: - high - type: string enum: - critical - type: string enum: - low source: oneOf: - type: string enum: - generated - type: string enum: - imported - type: string enum: - built_in - type: string enum: - human_authored - type: string enum: - file_imported - type: string enum: - model_generated - type: string enum: - framework_derived - type: string enum: - production_failure_derived contentHash: type: string input: type: string category: oneOf: - type: string enum: - prompt_injection - type: string enum: - data_exfiltration_privacy - type: string enum: - harmful_content - type: string enum: - misinformation_hallucination - type: string enum: - authorization_bypass - type: string enum: - tool_misuse - type: string enum: - excessive_agency - type: string enum: - insecure_output_handling - type: string enum: - sensitive_data_disclosure - type: string enum: - policy_evasion - type: string enum: - denial_of_wallet - type: string enum: - jailbreak_robustness - type: string enum: - system_prompt_leakage - type: string enum: - supply_chain_poisoning - type: string enum: - vector_embedding_weakness - type: string enum: - bias_fairness_discrimination - type: string enum: - hate_speech_harassment - type: string enum: - self_harm_content - type: string enum: - violent_extremism_weapons - type: string enum: - child_safety_content - type: string enum: - sexual_content_exploitation - type: string enum: - illegal_activity_facilitation - type: string enum: - copyright_ip_infringement - type: string enum: - indirect_prompt_injection - type: string enum: - ascii_unicode_smuggling - type: string enum: - training_data_extraction - type: string enum: - ssrf_network_pivot - type: string enum: - code_command_injection_via_tools - type: string enum: - broken_object_function_auth - type: string enum: - impersonation_brand_abuse - type: string enum: - unverifiable_high_stakes_claims reviewStatus: oneOf: - type: string enum: - approved - type: string enum: - proposed caseKey: type: string technique: type: string expectedSafeBehavior: type: string successIndicators: type: array items: type: string riskPackVersionId: type: number additionalProperties: false required: - id - severity - source - contentHash - input - category - reviewStatus - caseKey - technique - expectedSafeBehavior - successIndicators - riskPackVersionId scorers: type: array items: type: object properties: artifactId: type: number versionId: type: number contentHash: type: string required: type: boolean additionalProperties: false required: - artifactId - versionId - contentHash - required strategies: type: array items: oneOf: - type: string enum: - reverse - type: string enum: - none - type: string enum: - prompt_injection - type: string enum: - base64 - type: string enum: - rot13 - type: string enum: - leetspeak - type: string enum: - roleplay_wrapper - type: string enum: - crescendo - type: string enum: - hex - type: string enum: - homoglyph - type: string enum: - unicode_tag - type: string enum: - json_wrap controlEvidenceObligations: type: array items: type: object properties: method: oneOf: - type: string enum: - deterministic_assertion - type: string enum: - adversarial_probe - type: string enum: - trace_telemetry_requirement rationale: type: string target: type: object properties: type: oneOf: - type: string enum: - prompt - type: string enum: - scorer - type: string enum: - workflow - type: string enum: - tool - type: string enum: - deployment artifactId: type: number versionId: type: number contentHash: type: string environment: type: string sourceEvidence: oneOf: - type: object properties: repositoryId: type: number commitSha: type: string state: type: string enum: - linked graphVersionId: type: string repositorySnapshotId: type: string locations: type: array items: type: object properties: relationship: oneOf: - type: string enum: - test_target - type: string enum: - observed_execution - type: string enum: - suspected_contributor sourceLocatorId: type: string nodeIdentityId: type: string nodeRevisionId: type: string additionalProperties: false required: - relationship - sourceLocatorId additionalProperties: false required: - repositoryId - commitSha - state - graphVersionId - repositorySnapshotId - locations - type: object properties: reasonCode: type: string state: oneOf: - type: string enum: - not_applicable - type: string enum: - unlinked - type: string enum: - unavailable additionalProperties: false required: - reasonCode - state additionalProperties: false required: - type - artifactId - versionId - contentHash evaluator: type: object properties: version: type: string key: type: string additionalProperties: false required: - version - key assertion: oneOf: - type: string enum: - attack_resistance - type: string enum: - implementation_present - type: string enum: - telemetry_present - type: string enum: - benign_utility controlReference: type: object properties: schemaVersion: type: string frameworkKey: type: string enum: - aidefend sourceUrl: type: string parentId: oneOf: - type: 'null' - type: string license: type: string frameworkVersion: type: string snapshotGeneratedAt: type: string sourceCommit: oneOf: - type: 'null' - type: string sourceDigest: type: string requiredAttribution: type: string changesMadeNotice: type: string controlId: type: string controlTitle: type: string controlLevel: oneOf: - type: string enum: - parent_family - type: string enum: - standalone_technique - type: string enum: - leaf_subtechnique actionable: type: boolean tactic: oneOf: - type: string enum: - model - type: string enum: - harden - type: string enum: - detect - type: string enum: - isolate - type: string enum: - deceive - type: string enum: - evict - type: string enum: - restore pillars: type: array items: oneOf: - type: string enum: - data - type: string enum: - model - type: string enum: - app - type: string enum: - infra lifecyclePhases: type: array items: oneOf: - type: string enum: - validation - type: string enum: - operation - type: string enum: - response - type: string enum: - building - type: string enum: - improvement - type: string enum: - scoping relationship: oneOf: - type: string enum: - evidence_obligation - type: string enum: - verification_target mappingSource: oneOf: - type: string enum: - evalgate_reviewed_registry - type: string enum: - aidefend_catalog_only mappingRationale: type: string reviewState: oneOf: - type: string enum: - reviewed - type: string enum: - verification_design_required additionalProperties: false required: - schemaVersion - frameworkKey - sourceUrl - parentId - license - frameworkVersion - snapshotGeneratedAt - sourceCommit - sourceDigest - requiredAttribution - changesMadeNotice - controlId - controlTitle - controlLevel - actionable - tactic - pillars - lifecyclePhases - relationship - mappingSource - mappingRationale - reviewState templateId: type: string templateHash: type: string expectedEvidence: type: array items: type: object properties: description: type: string kind: oneOf: - type: string enum: - review - type: string enum: - assertion - type: string enum: - artifact - type: string enum: - trace - type: string enum: - model_call required: type: boolean key: type: string additionalProperties: false required: - description - kind - required - key caseBindings: type: array items: type: object properties: caseKey: type: string caseContentHash: type: string polarity: oneOf: - type: string enum: - adversarial - type: string enum: - benign additionalProperties: false required: - caseKey - caseContentHash - polarity obligationId: type: string obligationHash: type: string additionalProperties: false required: - method - rationale - target - evaluator - assertion - controlReference - templateId - templateHash - expectedEvidence - caseBindings - obligationId - obligationHash datasetVersionId: type: string createdFromRunId: type: string additionalProperties: false required: - schemaVersion - budget - target - seed - variants - benignCases - riskPackVersions - attackCases - scorers - strategies - controlEvidenceObligations createdFromRunId: oneOf: - type: 'null' - type: string createdBy: type: string createdAt: type: string format: date-time approvedBy: oneOf: - type: 'null' - type: string approvalRationale: oneOf: - type: 'null' - type: string approvedAt: oneOf: - type: 'null' - type: string format: date-time additionalProperties: false required: - id - organizationId - campaignId - version - status - targetType - targetArtifactId - targetArtifactVersionId - targetContentHash - snapshotHash - snapshot - createdFromRunId - createdBy - createdAt - approvedBy - approvalRationale - approvedAt idempotent: type: boolean additionalProperties: false required: - campaign - version - idempotent PostApiRedTeamCampaignsResponse201ApplicationJson: type: object properties: campaign: type: object properties: id: type: string organizationId: $ref: '#/components/schemas/OrganizationId' name: type: string description: oneOf: - type: 'null' - type: string ownerId: type: string status: type: string createIdempotencyKey: type: string createdBy: type: string createdAt: type: string format: date-time additionalProperties: false required: - id - organizationId - name - description - ownerId - status - createIdempotencyKey - createdBy - createdAt version: type: object properties: id: type: string organizationId: $ref: '#/components/schemas/OrganizationId' campaignId: type: string version: type: number status: type: string targetType: type: string targetArtifactId: type: number targetArtifactVersionId: type: number targetContentHash: type: string snapshotHash: type: string snapshot: oneOf: - type: object properties: schemaVersion: type: number enum: - 1 budget: type: object properties: maxCostUsd: type: number maxModelCalls: type: number concurrency: type: number maxTurnsPerCase: type: number additionalProperties: false required: - maxCostUsd - maxModelCalls - concurrency - maxTurnsPerCase target: type: object properties: type: oneOf: - type: string enum: - prompt - type: string enum: - scorer - type: string enum: - workflow - type: string enum: - tool - type: string enum: - deployment artifactId: type: number versionId: type: number contentHash: type: string environment: type: string sourceEvidence: oneOf: - type: object properties: repositoryId: type: number commitSha: type: string state: type: string enum: - linked graphVersionId: type: string repositorySnapshotId: type: string locations: type: array items: type: object properties: relationship: oneOf: - type: string enum: - test_target - type: string enum: - observed_execution - type: string enum: - suspected_contributor sourceLocatorId: type: string nodeIdentityId: type: string nodeRevisionId: type: string additionalProperties: false required: - relationship - sourceLocatorId additionalProperties: false required: - repositoryId - commitSha - state - graphVersionId - repositorySnapshotId - locations - type: object properties: reasonCode: type: string state: oneOf: - type: string enum: - not_applicable - type: string enum: - unlinked - type: string enum: - unavailable additionalProperties: false required: - reasonCode - state additionalProperties: false required: - type - artifactId - versionId - contentHash seed: type: number variants: type: array items: type: object properties: provider: type: string model: type: string parameters: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' key: type: string routingProfileId: type: string additionalProperties: false required: - provider - model - parameters - key riskPackVersions: type: array items: type: object properties: artifactId: type: number versionId: type: number contentHash: type: string taxonomy: type: string taxonomyVersion: type: string additionalProperties: false required: - artifactId - versionId - contentHash - taxonomy - taxonomyVersion attackCases: type: array items: type: object properties: id: type: string severity: oneOf: - type: string enum: - medium - type: string enum: - high - type: string enum: - critical - type: string enum: - low source: oneOf: - type: string enum: - generated - type: string enum: - imported - type: string enum: - built_in - type: string enum: - human_authored - type: string enum: - file_imported - type: string enum: - model_generated - type: string enum: - framework_derived - type: string enum: - production_failure_derived contentHash: type: string input: type: string category: oneOf: - type: string enum: - prompt_injection - type: string enum: - data_exfiltration_privacy - type: string enum: - harmful_content - type: string enum: - misinformation_hallucination - type: string enum: - authorization_bypass - type: string enum: - tool_misuse - type: string enum: - excessive_agency - type: string enum: - insecure_output_handling - type: string enum: - sensitive_data_disclosure - type: string enum: - policy_evasion - type: string enum: - denial_of_wallet - type: string enum: - jailbreak_robustness - type: string enum: - system_prompt_leakage - type: string enum: - supply_chain_poisoning - type: string enum: - vector_embedding_weakness - type: string enum: - bias_fairness_discrimination - type: string enum: - hate_speech_harassment - type: string enum: - self_harm_content - type: string enum: - violent_extremism_weapons - type: string enum: - child_safety_content - type: string enum: - sexual_content_exploitation - type: string enum: - illegal_activity_facilitation - type: string enum: - copyright_ip_infringement - type: string enum: - indirect_prompt_injection - type: string enum: - ascii_unicode_smuggling - type: string enum: - training_data_extraction - type: string enum: - ssrf_network_pivot - type: string enum: - code_command_injection_via_tools - type: string enum: - broken_object_function_auth - type: string enum: - impersonation_brand_abuse - type: string enum: - unverifiable_high_stakes_claims reviewStatus: oneOf: - type: string enum: - approved - type: string enum: - proposed caseKey: type: string technique: type: string expectedSafeBehavior: type: string successIndicators: type: array items: type: string riskPackVersionId: type: number additionalProperties: false required: - id - severity - source - contentHash - input - category - reviewStatus - caseKey - technique - expectedSafeBehavior - successIndicators - riskPackVersionId scorers: type: array items: type: object properties: artifactId: type: number versionId: type: number contentHash: type: string required: type: boolean additionalProperties: false required: - artifactId - versionId - contentHash - required strategies: type: array items: oneOf: - type: string enum: - reverse - type: string enum: - none - type: string enum: - prompt_injection - type: string enum: - base64 - type: string enum: - rot13 - type: string enum: - leetspeak - type: string enum: - roleplay_wrapper - type: string enum: - crescendo - type: string enum: - hex - type: string enum: - homoglyph - type: string enum: - unicode_tag - type: string enum: - json_wrap datasetVersionId: type: string createdFromRunId: type: string additionalProperties: false required: - schemaVersion - budget - target - seed - variants - riskPackVersions - attackCases - scorers - strategies - type: object properties: schemaVersion: type: number enum: - 2 budget: type: object properties: maxCostUsd: type: number maxModelCalls: type: number concurrency: type: number maxTurnsPerCase: type: number additionalProperties: false required: - maxCostUsd - maxModelCalls - concurrency - maxTurnsPerCase target: type: object properties: type: oneOf: - type: string enum: - prompt - type: string enum: - scorer - type: string enum: - workflow - type: string enum: - tool - type: string enum: - deployment artifactId: type: number versionId: type: number contentHash: type: string environment: type: string sourceEvidence: oneOf: - type: object properties: repositoryId: type: number commitSha: type: string state: type: string enum: - linked graphVersionId: type: string repositorySnapshotId: type: string locations: type: array items: type: object properties: relationship: oneOf: - type: string enum: - test_target - type: string enum: - observed_execution - type: string enum: - suspected_contributor sourceLocatorId: type: string nodeIdentityId: type: string nodeRevisionId: type: string additionalProperties: false required: - relationship - sourceLocatorId additionalProperties: false required: - repositoryId - commitSha - state - graphVersionId - repositorySnapshotId - locations - type: object properties: reasonCode: type: string state: oneOf: - type: string enum: - not_applicable - type: string enum: - unlinked - type: string enum: - unavailable additionalProperties: false required: - reasonCode - state additionalProperties: false required: - type - artifactId - versionId - contentHash seed: type: number variants: type: array items: type: object properties: provider: type: string model: type: string parameters: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' key: type: string routingProfileId: type: string additionalProperties: false required: - provider - model - parameters - key benignCases: type: array items: type: object properties: id: type: string source: type: string enum: - framework_derived contentHash: type: string input: type: string expectedBehavior: type: string caseKey: type: string controlReference: type: object properties: schemaVersion: type: string frameworkKey: type: string enum: - aidefend sourceUrl: type: string parentId: oneOf: - type: 'null' - type: string license: type: string frameworkVersion: type: string snapshotGeneratedAt: type: string sourceCommit: oneOf: - type: 'null' - type: string sourceDigest: type: string requiredAttribution: type: string changesMadeNotice: type: string controlId: type: string controlTitle: type: string controlLevel: oneOf: - type: string enum: - parent_family - type: string enum: - standalone_technique - type: string enum: - leaf_subtechnique actionable: type: boolean tactic: oneOf: - type: string enum: - model - type: string enum: - harden - type: string enum: - detect - type: string enum: - isolate - type: string enum: - deceive - type: string enum: - evict - type: string enum: - restore pillars: type: array items: oneOf: - type: string enum: - data - type: string enum: - model - type: string enum: - app - type: string enum: - infra lifecyclePhases: type: array items: oneOf: - type: string enum: - validation - type: string enum: - operation - type: string enum: - response - type: string enum: - building - type: string enum: - improvement - type: string enum: - scoping relationship: oneOf: - type: string enum: - evidence_obligation - type: string enum: - verification_target mappingSource: oneOf: - type: string enum: - evalgate_reviewed_registry - type: string enum: - aidefend_catalog_only mappingRationale: type: string reviewState: oneOf: - type: string enum: - reviewed - type: string enum: - verification_design_required additionalProperties: false required: - schemaVersion - frameworkKey - sourceUrl - parentId - license - frameworkVersion - snapshotGeneratedAt - sourceCommit - sourceDigest - requiredAttribution - changesMadeNotice - controlId - controlTitle - controlLevel - actionable - tactic - pillars - lifecyclePhases - relationship - mappingSource - mappingRationale - reviewState expectedResult: type: string riskPackVersionId: type: number additionalProperties: false required: - id - source - contentHash - input - expectedBehavior - caseKey - controlReference - expectedResult - riskPackVersionId riskPackVersions: type: array items: type: object properties: artifactId: type: number versionId: type: number contentHash: type: string taxonomy: type: string taxonomyVersion: type: string additionalProperties: false required: - artifactId - versionId - contentHash - taxonomy - taxonomyVersion attackCases: type: array items: type: object properties: id: type: string severity: oneOf: - type: string enum: - medium - type: string enum: - high - type: string enum: - critical - type: string enum: - low source: oneOf: - type: string enum: - generated - type: string enum: - imported - type: string enum: - built_in - type: string enum: - human_authored - type: string enum: - file_imported - type: string enum: - model_generated - type: string enum: - framework_derived - type: string enum: - production_failure_derived contentHash: type: string input: type: string category: oneOf: - type: string enum: - prompt_injection - type: string enum: - data_exfiltration_privacy - type: string enum: - harmful_content - type: string enum: - misinformation_hallucination - type: string enum: - authorization_bypass - type: string enum: - tool_misuse - type: string enum: - excessive_agency - type: string enum: - insecure_output_handling - type: string enum: - sensitive_data_disclosure - type: string enum: - policy_evasion - type: string enum: - denial_of_wallet - type: string enum: - jailbreak_robustness - type: string enum: - system_prompt_leakage - type: string enum: - supply_chain_poisoning - type: string enum: - vector_embedding_weakness - type: string enum: - bias_fairness_discrimination - type: string enum: - hate_speech_harassment - type: string enum: - self_harm_content - type: string enum: - violent_extremism_weapons - type: string enum: - child_safety_content - type: string enum: - sexual_content_exploitation - type: string enum: - illegal_activity_facilitation - type: string enum: - copyright_ip_infringement - type: string enum: - indirect_prompt_injection - type: string enum: - ascii_unicode_smuggling - type: string enum: - training_data_extraction - type: string enum: - ssrf_network_pivot - type: string enum: - code_command_injection_via_tools - type: string enum: - broken_object_function_auth - type: string enum: - impersonation_brand_abuse - type: string enum: - unverifiable_high_stakes_claims reviewStatus: oneOf: - type: string enum: - approved - type: string enum: - proposed caseKey: type: string technique: type: string expectedSafeBehavior: type: string successIndicators: type: array items: type: string riskPackVersionId: type: number additionalProperties: false required: - id - severity - source - contentHash - input - category - reviewStatus - caseKey - technique - expectedSafeBehavior - successIndicators - riskPackVersionId scorers: type: array items: type: object properties: artifactId: type: number versionId: type: number contentHash: type: string required: type: boolean additionalProperties: false required: - artifactId - versionId - contentHash - required strategies: type: array items: oneOf: - type: string enum: - reverse - type: string enum: - none - type: string enum: - prompt_injection - type: string enum: - base64 - type: string enum: - rot13 - type: string enum: - leetspeak - type: string enum: - roleplay_wrapper - type: string enum: - crescendo - type: string enum: - hex - type: string enum: - homoglyph - type: string enum: - unicode_tag - type: string enum: - json_wrap controlEvidenceObligations: type: array items: type: object properties: method: oneOf: - type: string enum: - deterministic_assertion - type: string enum: - adversarial_probe - type: string enum: - trace_telemetry_requirement rationale: type: string target: type: object properties: type: oneOf: - type: string enum: - prompt - type: string enum: - scorer - type: string enum: - workflow - type: string enum: - tool - type: string enum: - deployment artifactId: type: number versionId: type: number contentHash: type: string environment: type: string sourceEvidence: oneOf: - type: object properties: repositoryId: type: number commitSha: type: string state: type: string enum: - linked graphVersionId: type: string repositorySnapshotId: type: string locations: type: array items: type: object properties: relationship: oneOf: - type: string enum: - test_target - type: string enum: - observed_execution - type: string enum: - suspected_contributor sourceLocatorId: type: string nodeIdentityId: type: string nodeRevisionId: type: string additionalProperties: false required: - relationship - sourceLocatorId additionalProperties: false required: - repositoryId - commitSha - state - graphVersionId - repositorySnapshotId - locations - type: object properties: reasonCode: type: string state: oneOf: - type: string enum: - not_applicable - type: string enum: - unlinked - type: string enum: - unavailable additionalProperties: false required: - reasonCode - state additionalProperties: false required: - type - artifactId - versionId - contentHash evaluator: type: object properties: version: type: string key: type: string additionalProperties: false required: - version - key assertion: oneOf: - type: string enum: - attack_resistance - type: string enum: - implementation_present - type: string enum: - telemetry_present - type: string enum: - benign_utility controlReference: type: object properties: schemaVersion: type: string frameworkKey: type: string enum: - aidefend sourceUrl: type: string parentId: oneOf: - type: 'null' - type: string license: type: string frameworkVersion: type: string snapshotGeneratedAt: type: string sourceCommit: oneOf: - type: 'null' - type: string sourceDigest: type: string requiredAttribution: type: string changesMadeNotice: type: string controlId: type: string controlTitle: type: string controlLevel: oneOf: - type: string enum: - parent_family - type: string enum: - standalone_technique - type: string enum: - leaf_subtechnique actionable: type: boolean tactic: oneOf: - type: string enum: - model - type: string enum: - harden - type: string enum: - detect - type: string enum: - isolate - type: string enum: - deceive - type: string enum: - evict - type: string enum: - restore pillars: type: array items: oneOf: - type: string enum: - data - type: string enum: - model - type: string enum: - app - type: string enum: - infra lifecyclePhases: type: array items: oneOf: - type: string enum: - validation - type: string enum: - operation - type: string enum: - response - type: string enum: - building - type: string enum: - improvement - type: string enum: - scoping relationship: oneOf: - type: string enum: - evidence_obligation - type: string enum: - verification_target mappingSource: oneOf: - type: string enum: - evalgate_reviewed_registry - type: string enum: - aidefend_catalog_only mappingRationale: type: string reviewState: oneOf: - type: string enum: - reviewed - type: string enum: - verification_design_required additionalProperties: false required: - schemaVersion - frameworkKey - sourceUrl - parentId - license - frameworkVersion - snapshotGeneratedAt - sourceCommit - sourceDigest - requiredAttribution - changesMadeNotice - controlId - controlTitle - controlLevel - actionable - tactic - pillars - lifecyclePhases - relationship - mappingSource - mappingRationale - reviewState templateId: type: string templateHash: type: string expectedEvidence: type: array items: type: object properties: description: type: string kind: oneOf: - type: string enum: - review - type: string enum: - assertion - type: string enum: - artifact - type: string enum: - trace - type: string enum: - model_call required: type: boolean key: type: string additionalProperties: false required: - description - kind - required - key caseBindings: type: array items: type: object properties: caseKey: type: string caseContentHash: type: string polarity: oneOf: - type: string enum: - adversarial - type: string enum: - benign additionalProperties: false required: - caseKey - caseContentHash - polarity obligationId: type: string obligationHash: type: string additionalProperties: false required: - method - rationale - target - evaluator - assertion - controlReference - templateId - templateHash - expectedEvidence - caseBindings - obligationId - obligationHash datasetVersionId: type: string createdFromRunId: type: string additionalProperties: false required: - schemaVersion - budget - target - seed - variants - benignCases - riskPackVersions - attackCases - scorers - strategies - controlEvidenceObligations createdFromRunId: oneOf: - type: 'null' - type: string createdBy: type: string createdAt: type: string format: date-time approvedBy: oneOf: - type: 'null' - type: string approvalRationale: oneOf: - type: 'null' - type: string approvedAt: oneOf: - type: 'null' - type: string format: date-time additionalProperties: false required: - id - organizationId - campaignId - version - status - targetType - targetArtifactId - targetArtifactVersionId - targetContentHash - snapshotHash - snapshot - createdFromRunId - createdBy - createdAt - approvedBy - approvalRationale - approvedAt idempotent: type: boolean additionalProperties: false required: - campaign - version - idempotent JsonValue: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' OrganizationId: type: string format: uuid 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.