> ## 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 improvement adopt

> Requires scopes: admin:org



## OpenAPI

````yaml /api-reference/openapi.json post /api/improvement/cycles/{cycleId}/adopt
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/improvement/cycles/{cycleId}/adopt:
    post:
      tags:
        - improvement
      summary: Create improvement adopt
      description: 'Requires scopes: admin:org'
      operationId: post_improvement_cycles_cycleId_adopt
      parameters:
        - name: cycleId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiImprovementCyclesCycleIdAdoptRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiImprovementCyclesCycleIdAdoptResponse200ApplicationJson
        '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:
    PostApiImprovementCyclesCycleIdAdoptRequest:
      type: object
      properties:
        rollout:
          type: object
          properties:
            releaseId:
              type: string
            deploymentIds:
              type: array
              items:
                type: string
            expectedRolloutRevision:
              type: number
            expectedReleaseStateVersion:
              type: number
          additionalProperties: false
          required:
            - releaseId
            - deploymentIds
            - expectedRolloutRevision
            - expectedReleaseStateVersion
        idempotencyKey:
          type: string
        reason:
          type: string
        candidateId:
          type: string
        expectedStateVersion:
          type: number
        learning:
          type: object
          properties:
            entryId:
              type: string
            entryVersionId:
              type: string
            nonInferiorityMargin:
              type: number
          additionalProperties: false
          required:
            - entryId
            - entryVersionId
            - nonInferiorityMargin
      additionalProperties: false
      required:
        - rollout
        - idempotencyKey
        - reason
        - candidateId
        - expectedStateVersion
        - learning
    PostApiImprovementCyclesCycleIdAdoptResponse200ApplicationJson:
      oneOf:
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
        - oneOf:
            - type: object
              additionalProperties:
                $ref: '#/components/schemas/JsonValue'
            - type: object
              properties:
                adopted:
                  type: object
                  properties:
                    candidateId:
                      type: string
                    targetKind:
                      type: string
                  additionalProperties: false
                  required:
                    - candidateId
                    - targetKind
                release:
                  type: object
                  properties:
                    bound:
                      type: boolean
                    bindingReasonCodes:
                      type: array
                      items:
                        type: string
                    healthPolicyHash:
                      type: string
                    shadow:
                      oneOf:
                        - type: 'null'
                        - type: object
                          properties:
                            allowed:
                              type: boolean
                            authorized:
                              type: string
                            reasonCodes:
                              type: array
                              items:
                                type: string
                          additionalProperties: false
                          required:
                            - allowed
                            - authorized
                            - reasonCodes
                    canary:
                      oneOf:
                        - type: 'null'
                        - type: object
                          properties:
                            allowed:
                              type: boolean
                            authorized:
                              type: string
                            reasonCodes:
                              type: array
                              items:
                                type: string
                          additionalProperties: false
                          required:
                            - allowed
                            - authorized
                            - reasonCodes
                    promotionProposal:
                      oneOf:
                        - type: 'null'
                        - type: object
                          properties:
                            authorized:
                              type: string
                            reasonCodes:
                              type: array
                              items:
                                type: string
                          additionalProperties: false
                          required:
                            - authorized
                            - reasonCodes
                  additionalProperties: false
                  required:
                    - bound
                    - bindingReasonCodes
                    - healthPolicyHash
                    - shadow
                    - canary
                    - promotionProposal
                rollout:
                  type: object
                  properties:
                    releaseId:
                      type: string
                    providerEventsObserved:
                      type: boolean
                    replayed:
                      type: boolean
                    releaseStateVersion:
                      type: number
                    rolloutRevision:
                      type: number
                  additionalProperties: false
                  required:
                    - releaseId
                    - providerEventsObserved
                    - replayed
                    - releaseStateVersion
                    - rolloutRevision
                protection:
                  type: object
                  properties:
                    gate:
                      type: string
                    interventionType:
                      oneOf:
                        - type: string
                          enum:
                            - tool_policy
                        - type: string
                          enum:
                            - prompt_overlay
                        - type: string
                          enum:
                            - release_constraint
                        - type: string
                          enum:
                            - routing_rule
                        - type: string
                          enum:
                            - retrieval_rule
                        - type: string
                          enum:
                            - workflow_rule
                        - type: string
                          enum:
                            - skill_reference
                    contentHash:
                      type: string
                    partitionRef:
                      type: string
                    nonInferiorityMargin:
                      type: number
                    established:
                      type: object
                      properties:
                        successes:
                          type: number
                        trials:
                          type: number
                      additionalProperties: false
                      required:
                        - successes
                        - trials
                  additionalProperties: false
                  required:
                    - gate
                    - interventionType
                    - contentHash
                    - partitionRef
                    - nonInferiorityMargin
                    - established
                stateVersion:
                  type: number
              additionalProperties: false
              required:
                - adopted
                - release
                - rollout
                - protection
                - stateVersion
    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

````