> ## 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 ai releases rollout > Requires scopes: admin:org ## OpenAPI ````yaml /api-reference/openapi.json post /api/ai-releases/{releaseId}/rollout openapi: 3.1.2 info: title: EvalGate API version: 5.1.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/ai-releases/{releaseId}/rollout: post: tags: - ai releases summary: Create ai releases rollout description: 'Requires scopes: admin:org' operationId: post_ai_releases_releaseId_rollout parameters: - name: releaseId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiAiReleasesReleaseIdRolloutRequest' responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/PostApiAiReleasesReleaseIdRolloutResponse200ApplicationJson '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: PostApiAiReleasesReleaseIdRolloutRequest: type: object properties: idempotencyKey: type: string action: oneOf: - type: string enum: - shadow - type: string enum: - canary - type: string enum: - rollback - type: string enum: - promote expectedStateVersion: type: number expectedRolloutRevision: type: number authorizationId: type: string additionalProperties: false required: - idempotencyKey - action - expectedStateVersion - expectedRolloutRevision PostApiAiReleasesReleaseIdRolloutResponse200ApplicationJson: oneOf: - type: object properties: release: type: object properties: status: type: string id: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time organizationId: $ref: '#/components/schemas/OrganizationId' description: oneOf: - type: 'null' - type: string createdBy: type: string releaseKey: type: string riskTier: type: string aiSystemId: oneOf: - type: 'null' - type: number environment: type: string stateVersion: type: number releasePolicyId: type: string latestManifestId: oneOf: - type: 'null' - type: string baseReleaseId: oneOf: - type: 'null' - type: string additionalProperties: false required: - status - id - name - createdAt - updatedAt - organizationId - description - createdBy - releaseKey - riskTier - aiSystemId - environment - stateVersion - releasePolicyId - latestManifestId - baseReleaseId binding: type: object properties: id: type: string organizationId: $ref: '#/components/schemas/OrganizationId' releaseId: type: string manifestId: type: string manifestHash: type: string environment: type: string deploymentIds: type: array items: type: string activeVersions: type: array items: type: object properties: organizationId: $ref: '#/components/schemas/OrganizationId' schemaVersion: type: number enum: - 1 kind: oneOf: - type: string enum: - prompt - type: string enum: - judge_config - type: string enum: - scorer - type: string enum: - policy_pack - type: string enum: - ruleset - type: string enum: - model_routing_profile - type: string enum: - model_binding - type: string enum: - retrieval_corpus - type: string enum: - retrieval_index - type: string enum: - retrieval_config - type: string enum: - tool_contract - type: string enum: - tool_inventory - type: string enum: - workflow - type: string enum: - agent_topology - type: string enum: - memory_entry_set - type: string enum: - skill - type: string enum: - runtime_config - type: string enum: - dataset - type: string enum: - evaluation - type: string enum: - repository_commit - type: string enum: - agent_task - type: string enum: - task_environment - type: string enum: - task_verifier - type: string enum: - harness_profile - type: string enum: - context_policy - type: string enum: - execution_state_schema - type: string enum: - orchestration_program - type: string enum: - subagent_profile - type: string enum: - eval_catalog - type: string enum: - experiment_plan - type: string enum: - tool_policy - type: string enum: - mcp_config - type: string enum: - memory_policy - type: string enum: - prompt_overlay - type: string enum: - release_constraint artifactId: type: string versionId: type: string contentHash: type: string environment: oneOf: - type: string enum: - local - type: string enum: - ci - type: string enum: - dev - type: string enum: - staging - type: string enum: - prod sourceControl: type: object properties: repositoryId: type: string provider: oneOf: - type: string enum: - github - type: string enum: - gitlab - type: string enum: - bitbucket - type: string enum: - azure_devops - type: string enum: - other commitSha: type: string path: type: string additionalProperties: false required: - repositoryId - provider - commitSha dependencySnapshotHash: type: string additionalProperties: false required: - organizationId - schemaVersion - kind - artifactId - versionId - contentHash shadowVersions: type: array items: type: object properties: organizationId: $ref: '#/components/schemas/OrganizationId' schemaVersion: type: number enum: - 1 kind: oneOf: - type: string enum: - prompt - type: string enum: - judge_config - type: string enum: - scorer - type: string enum: - policy_pack - type: string enum: - ruleset - type: string enum: - model_routing_profile - type: string enum: - model_binding - type: string enum: - retrieval_corpus - type: string enum: - retrieval_index - type: string enum: - retrieval_config - type: string enum: - tool_contract - type: string enum: - tool_inventory - type: string enum: - workflow - type: string enum: - agent_topology - type: string enum: - memory_entry_set - type: string enum: - skill - type: string enum: - runtime_config - type: string enum: - dataset - type: string enum: - evaluation - type: string enum: - repository_commit - type: string enum: - agent_task - type: string enum: - task_environment - type: string enum: - task_verifier - type: string enum: - harness_profile - type: string enum: - context_policy - type: string enum: - execution_state_schema - type: string enum: - orchestration_program - type: string enum: - subagent_profile - type: string enum: - eval_catalog - type: string enum: - experiment_plan - type: string enum: - tool_policy - type: string enum: - mcp_config - type: string enum: - memory_policy - type: string enum: - prompt_overlay - type: string enum: - release_constraint artifactId: type: string versionId: type: string contentHash: type: string environment: oneOf: - type: string enum: - local - type: string enum: - ci - type: string enum: - dev - type: string enum: - staging - type: string enum: - prod sourceControl: type: object properties: repositoryId: type: string provider: oneOf: - type: string enum: - github - type: string enum: - gitlab - type: string enum: - bitbucket - type: string enum: - azure_devops - type: string enum: - other commitSha: type: string path: type: string additionalProperties: false required: - repositoryId - provider - commitSha dependencySnapshotHash: type: string additionalProperties: false required: - organizationId - schemaVersion - kind - artifactId - versionId - contentHash canaryVersions: type: array items: type: object properties: organizationId: $ref: '#/components/schemas/OrganizationId' schemaVersion: type: number enum: - 1 kind: oneOf: - type: string enum: - prompt - type: string enum: - judge_config - type: string enum: - scorer - type: string enum: - policy_pack - type: string enum: - ruleset - type: string enum: - model_routing_profile - type: string enum: - model_binding - type: string enum: - retrieval_corpus - type: string enum: - retrieval_index - type: string enum: - retrieval_config - type: string enum: - tool_contract - type: string enum: - tool_inventory - type: string enum: - workflow - type: string enum: - agent_topology - type: string enum: - memory_entry_set - type: string enum: - skill - type: string enum: - runtime_config - type: string enum: - dataset - type: string enum: - evaluation - type: string enum: - repository_commit - type: string enum: - agent_task - type: string enum: - task_environment - type: string enum: - task_verifier - type: string enum: - harness_profile - type: string enum: - context_policy - type: string enum: - execution_state_schema - type: string enum: - orchestration_program - type: string enum: - subagent_profile - type: string enum: - eval_catalog - type: string enum: - experiment_plan - type: string enum: - tool_policy - type: string enum: - mcp_config - type: string enum: - memory_policy - type: string enum: - prompt_overlay - type: string enum: - release_constraint artifactId: type: string versionId: type: string contentHash: type: string environment: oneOf: - type: string enum: - local - type: string enum: - ci - type: string enum: - dev - type: string enum: - staging - type: string enum: - prod sourceControl: type: object properties: repositoryId: type: string provider: oneOf: - type: string enum: - github - type: string enum: - gitlab - type: string enum: - bitbucket - type: string enum: - azure_devops - type: string enum: - other commitSha: type: string path: type: string additionalProperties: false required: - repositoryId - provider - commitSha dependencySnapshotHash: type: string additionalProperties: false required: - organizationId - schemaVersion - kind - artifactId - versionId - contentHash cohortAssignmentPolicy: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' healthPolicyHash: type: string automaticRollbackPolicy: type: object properties: enabled: type: boolean conditions: type: array items: type: object properties: metric: type: string comparator: type: string threshold: type: number reasonCode: type: string additionalProperties: false required: - metric - comparator - threshold - reasonCode minimumObservations: type: number additionalProperties: false required: - enabled - conditions - minimumObservations rolloutRevision: type: number status: type: string createdBy: oneOf: - type: 'null' - type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time additionalProperties: false required: - id - organizationId - releaseId - manifestId - manifestHash - environment - deploymentIds - activeVersions - shadowVersions - canaryVersions - cohortAssignmentPolicy - healthPolicyHash - automaticRollbackPolicy - rolloutRevision - status - createdBy - createdAt - updatedAt providerEventsObserved: type: boolean replayed: type: boolean additionalProperties: false required: - release - binding - providerEventsObserved - replayed - type: object properties: error: type: object properties: code: oneOf: - type: string enum: - RELEASE_NOT_FOUND - type: string enum: - RELEASE_KEY_CONFLICT - type: string enum: - RELEASE_MANIFEST_NOT_FOUND - type: string enum: - RELEASE_MANIFEST_STALE - type: string enum: - RELEASE_MANIFEST_CONTENT_CONFLICT - type: string enum: - RELEASE_INVALID_TRANSITION - type: string enum: - RELEASE_CROSS_ORG_REFERENCE - type: string enum: - RELEASE_PLAN_NOT_FOUND - type: string enum: - RELEASE_PLAN_EXPIRED - type: string enum: - RELEASE_DECISION_NOT_FOUND - type: string enum: - RELEASE_VERIFICATION_BLOCKED - type: string enum: - RELEASE_UNKNOWN_DEPENDENCIES - type: string enum: - RELEASE_MANIFEST_MISMATCH - type: string enum: - RELEASE_OBJECTIVE_FAILURE - type: string enum: - RELEASE_POLICY_VIOLATION - type: string enum: - RELEASE_HARD_CONSTRAINT_FAILURE - type: string enum: - RELEASE_ROLLBACK_NOT_AVAILABLE - type: string enum: - RELEASE_ROLLBACK_PARTIAL - type: string enum: - RELEASE_ROLLOUT_BINDING_NOT_FOUND - type: string enum: - RELEASE_ROLLOUT_UNAUTHORIZED - type: string enum: - RELEASE_ROLLOUT_STALE - type: string enum: - RELEASE_ROLLOUT_GATE_BLOCKED - type: string enum: - RELEASE_ROLLOUT_ARTIFACT_MISMATCH - type: string enum: - RELEASE_ROLLOUT_PROVIDER_UNCONFIRMED message: type: string additionalProperties: false required: - code - message additionalProperties: false required: - error OrganizationId: type: string format: uuid JsonValue: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' 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' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: 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' NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError' Conflict: description: Conflict content: application/json: schema: $ref: '#/components/schemas/ApiError' RateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: Retry-After: description: Delay in seconds before retrying when present. schema: type: integer minimum: 1 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 InternalError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError' ServiceUnavailable: description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/ApiError' 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 - admin:keys - admin:org x-evalgate-protected-resource-metadata: https://www.evalgate.com/.well-known/oauth-protected-resource ````