> ## Documentation Index
> Fetch the complete documentation index at: https://platform.atlan.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> To act on Atlan objects, use the Atlan MCP server at https://api.atlan.com/mcp or the SDK. To install or publish skills from a terminal, use the `aireg` CLI; `aireg --map json` prints its command map. The `atlanai` CLI is deprecated. Run a read-only identity check before any write.
> The docs MCP server at /mcp searches these docs only. It cannot read or change Atlan objects.
> SDK packages: Python `atlanai` (PyPI) and TypeScript `@atlanai/sdk` (npm). Show Python first, then TypeScript.
> These docs cover Atlan Trident, Atlan's hosted product. AI Registry and Agent Registry are its earlier names. Registry OSS is Atlan's open-source agent registry: the registry specification and its aireg CLI, with their own public repository, docs and release notes; /open-source on this site links them. Registry OSS is open source; Atlan Trident is not. Answer generic aireg or specification questions from the project's docs, and use these docs for Atlan-specific setup such as the Atlan adapter, sign-in and workspaces.
> Atlan offers a second product, the Agentic Data Catalog: Atlan's enterprise context layer, covering the data catalog, connectors, lineage, data governance and glossary. It is documented at https://docs.atlan.com; answer questions about it from those docs, not these.

# Record the pull request that delivers a fix



## OpenAPI

````yaml /public-openapi.json post /eval/v1/improvements/{improvement_id}/pull-request
openapi: 3.1.0
info:
  title: Atlan public API
  version: current
  description: >-
    Public HTTP API reference for Registry, Skills, Agents, outputs, files, MCP
    servers and tools, Model Gateway, and OTLP telemetry ingestion.
servers:
  - url: https://api.atlan.com
    description: Atlan API base URL
security:
  - bearer: []
tags:
  - name: Core
  - name: Skill
  - name: Agent
  - name: Files
  - name: Knowledge
  - name: MCP
  - name: Observability
  - name: Credentials
  - name: Store
  - name: Apps
  - name: Evals
  - name: Ontologies
  - name: Ontology bindings
  - name: Slack
  - name: GitHub
  - name: Repositories
  - name: Models
paths:
  /eval/v1/improvements/{improvement_id}/pull-request:
    post:
      tags:
        - Evals
      summary: Record the pull request that delivers a fix
      operationId: eval.recordImprovementPullRequest
      parameters:
        - in: path
          name: improvement_id
          required: true
          schema:
            type: string
        - name: Content-Encoding
          in: header
          required: false
          schema:
            type: string
            enum:
              - gzip
              - base64
              - gzip, base64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eval-eval-ImprovementPullRequestRecord'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eval-eval-Improvement'
          description: HTTP 200 response.
        '400':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ValidationProblem'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - invalid_base64
                          - invalid_gzip
                          - invalid_json
          description: HTTP 400 response.
        '401':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - alg_mismatch
                          - alg_not_allowed
                          - audience_mismatch
                          - invalid_api_key
                          - missing_identity
                          - missing_org
                          - missing_user
                          - signature_invalid
                          - token_expired
                          - token_malformed
                          - token_missing
                          - token_not_yet_valid
                          - token_rejected
                          - token_service_account_unbound
                          - unauthorized
                          - unknown_account
                          - unknown_key
                          - untrusted_issuer
          description: HTTP 401 response.
        '403':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - access_denied
                          - account_suspended
                          - forbidden
                          - platform_principal_refused
          description: HTTP 403 response.
        '404':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - not_found
          description: HTTP 404 response.
        '409':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ProblemDetails'
                  - properties:
                      code:
                        enum:
                          - improvement_not_actionable
                        type: string
                    required:
                      - code
                    type: object
          description: HTTP 409 response.
        '413':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - compressed_payload_too_large
                          - decompressed_payload_too_large
                          - payload_too_large
          description: HTTP 413 response.
        '415':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - unsupported_content_encoding
                          - unsupported_content_type
          description: HTTP 415 response.
        '422':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ValidationProblem'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - invalid_field
                          - validation_failed
          description: HTTP 422 response.
        '429':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - rate_limited
          description: HTTP 429 response.
        '500':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - internal_error
          description: HTTP 500 response.
        '503':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ProblemDetails'
                  - properties:
                      code:
                        enum:
                          - auth_unavailable
                          - service_overloaded
                          - workspace_authorization_unavailable
                        type: string
                    required:
                      - code
                    type: object
          description: HTTP 503 response.
        '504':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/eval-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - request_timeout
          description: HTTP 504 response.
      security:
        - bearer: []
components:
  schemas:
    eval-eval-ImprovementPullRequestRecord:
      additionalProperties: false
      properties:
        base:
          maxLength: 255
          type: string
        binding_id:
          maxLength: 64
          type:
            - string
            - 'null'
        change_ids:
          items:
            type: string
          minItems: 1
          type: array
        commit_sha:
          maxLength: 40
          minLength: 40
          type:
            - string
            - 'null'
        edits:
          type: object
          additionalProperties:
            type: string
          propertyNames:
            type: string
        head:
          maxLength: 255
          type: string
        held_while:
          $ref: '#/components/schemas/eval-eval-ImprovementPullRequestHold'
        number:
          format: int32
          maximum: 2147483648
          minimum: 1
          type: integer
        repository:
          type: string
          maxLength: 140
        url:
          maxLength: 300
          type: string
      required:
        - repository
        - number
        - url
        - head
        - base
        - change_ids
        - held_while
      type: object
    eval-eval-Improvement:
      properties:
        accept_mode:
          oneOf:
            - $ref: '#/components/schemas/eval-eval-ImprovementAcceptMode'
            - type: 'null'
        base_content_hash:
          type: string
        base_version_ordinal:
          type: integer
          format: int64
        can_apply:
          type: boolean
        changes:
          items:
            $ref: '#/components/schemas/eval-eval-ImprovementChange'
          type:
            - array
            - 'null'
        created_at:
          type: string
        decision:
          type:
            - object
            - 'null'
        improvement_id:
          type: string
        issue_id:
          type:
            - string
            - 'null'
        params:
          $ref: '#/components/schemas/eval-eval-ImprovementParams'
        profile:
          oneOf:
            - $ref: '#/components/schemas/eval-eval-ImprovementProfile'
            - type: 'null'
        progress:
          oneOf:
            - $ref: '#/components/schemas/eval-eval-ImprovementProgress'
            - type: 'null'
        pull_request:
          oneOf:
            - $ref: '#/components/schemas/eval-eval-ImprovementPullRequest'
            - type: 'null'
        readiness:
          type:
            - object
            - 'null'
        requested_by:
          type: string
        run_id:
          type:
            - string
            - 'null'
        scorer_id:
          type:
            - string
            - 'null'
        scorer_version:
          type:
            - integer
            - 'null'
          format: int64
        status:
          $ref: '#/components/schemas/eval-eval-ImprovementStatus'
        status_reason:
          type:
            - string
            - 'null'
        subject_id:
          type: string
        subject_kind:
          $ref: '#/components/schemas/eval-eval-ImprovementSubjectKind'
        summary:
          oneOf:
            - $ref: '#/components/schemas/eval-eval-ImprovementSummary'
            - type: 'null'
        updated_at:
          type: string
      required:
        - improvement_id
        - subject_kind
        - subject_id
        - base_version_ordinal
        - base_content_hash
        - status
        - params
        - can_apply
        - requested_by
        - created_at
        - updated_at
      type: object
    eval-ValidationProblem:
      allOf:
        - $ref: '#/components/schemas/eval-ProblemDetails'
        - type: object
          properties:
            allowed_values:
              type: array
              items:
                type: string
            field:
              type: string
    eval-ProblemDetails:
      type: object
      required:
        - title
        - status
        - detail
        - code
      properties:
        code:
          type: string
        detail:
          type: string
        status:
          type: integer
          format: int32
          minimum: 0
        title:
          type: string
        trace_id:
          type:
            - string
            - 'null'
    eval-eval-ImprovementPullRequestHold:
      enum:
        - to_do
        - regression
      type: string
    eval-eval-ImprovementAcceptMode:
      enum:
        - registry
        - pull_request
      type: string
    eval-eval-ImprovementChange:
      properties:
        base_sha256:
          type: string
        base_text:
          type:
            - string
            - 'null'
        block_id:
          type: string
        diff:
          type: string
        evidence:
          $ref: '#/components/schemas/eval-eval-ImprovementChangeEvidence'
        id:
          type: string
        kind:
          $ref: '#/components/schemas/eval-eval-ImprovementChangeKind'
        op:
          $ref: '#/components/schemas/eval-eval-ImprovementBlockOp'
        rationale:
          type: string
      required:
        - id
        - op
        - block_id
        - base_sha256
        - kind
        - rationale
        - evidence
        - diff
      type: object
    eval-eval-ImprovementParams:
      properties:
        max_evidence:
          type: integer
          format: int32
          minimum: 0
        window_days:
          type: integer
          format: int32
          minimum: 0
      required:
        - window_days
        - max_evidence
      type: object
    eval-eval-ImprovementProfile:
      additionalProperties: false
      properties:
        intended_use:
          type: string
        kind_type:
          type: string
        out_of_scope:
          type: array
          items:
            type: string
        output_type:
          $ref: '#/components/schemas/eval-eval-ImprovementProfileOutputType'
        success_criteria:
          type: array
          items:
            type: string
      required:
        - kind_type
        - output_type
        - intended_use
        - success_criteria
        - out_of_scope
      type: object
    eval-eval-ImprovementProgress:
      properties:
        deadline_hit:
          type: boolean
        done:
          type: integer
          format: int32
          minimum: 0
        total:
          type: integer
          format: int32
          minimum: 0
      required:
        - done
        - total
        - deadline_hit
      type: object
    eval-eval-ImprovementPullRequest:
      properties:
        base:
          type: string
        binding_id:
          type:
            - string
            - 'null'
        change_ids:
          type: array
          items:
            type: string
        commit_sha:
          type:
            - string
            - 'null'
        edits:
          type: object
          additionalProperties:
            type: string
          propertyNames:
            type: string
        head:
          type: string
        held_while:
          $ref: '#/components/schemas/eval-eval-ImprovementPullRequestHold'
        number:
          type: integer
          format: int32
          minimum: 0
        opened_at_unix_seconds:
          type: integer
          format: int64
        opened_by:
          type: string
        repository:
          type: string
        url:
          type: string
      required:
        - repository
        - number
        - url
        - head
        - base
        - change_ids
        - held_while
        - opened_by
        - opened_at_unix_seconds
      type: object
    eval-eval-ImprovementStatus:
      enum:
        - queued
        - profiling
        - judging
        - proposing
        - ready
        - not_enough_evidence
        - failed
        - accepting
        - accepted
        - dismissed
      type: string
    eval-eval-ImprovementSubjectKind:
      enum:
        - skill
        - agent
        - harness
        - mcp
      type: string
    eval-eval-ImprovementSummary:
      properties:
        axes:
          $ref: '#/components/schemas/eval-eval-ImprovementAxes'
          default:
            code_quality:
              run_count: 0
              score: 0
            compliance:
              run_count: 0
              score: 0
            efficiency:
              run_count: 0
              score: 0
            verbosity:
              run_count: 0
              score: 0
        blocks:
          default: []
          items:
            $ref: '#/components/schemas/eval-eval-ImprovementBlockSummary'
          type: array
        by_family:
          additionalProperties:
            $ref: '#/components/schemas/eval-eval-ImprovementFamilySummary'
          default: {}
          propertyNames:
            type: string
          type: object
        criteria:
          default: []
          items:
            $ref: '#/components/schemas/eval-eval-ImprovementCriterionSummary'
          type: array
        excluded:
          $ref: '#/components/schemas/eval-eval-ImprovementSummaryExcluded'
          default:
            fetch_failed_count: 0
            misattributed_count: 0
            structure_only_count: 0
            subject_not_found_count: 0
        judge:
          $ref: '#/components/schemas/eval-eval-ImprovementJudgeSummary'
          default:
            input_tokens: 0
            request_count: 0
        judged_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
        listed_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
        outcomes:
          $ref: '#/components/schemas/eval-eval-ImprovementOutcomes'
          default:
            follow_up_run_count: 0
        top_findings:
          default: []
          items:
            type: string
          type: array
        window_days:
          default: 0
          format: int32
          minimum: 0
          type: integer
        workspace_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
      required:
        - window_days
        - listed_count
        - judged_count
        - excluded
        - by_family
        - workspace_count
        - axes
        - outcomes
        - criteria
        - blocks
        - judge
        - top_findings
      type: object
    eval-eval-ImprovementChangeEvidence:
      properties:
        by_family:
          additionalProperties:
            $ref: '#/components/schemas/eval-eval-ImprovementFamilyEvidence'
          propertyNames:
            type: string
          type: object
        confidence_p50:
          type:
            - number
            - 'null'
          format: double
        other_run_count:
          type:
            - integer
            - 'null'
          format: int32
          minimum: 0
        run_count:
          type: integer
          format: int32
          minimum: 0
        verdicts:
          additionalProperties:
            type: integer
            format: int32
            minimum: 0
          propertyNames:
            type: string
          type: object
        viewer_trace_ids:
          type:
            - array
            - 'null'
          items:
            type: string
        workspace_count:
          type: integer
          format: int32
          minimum: 0
      type: object
    eval-eval-ImprovementChangeKind:
      enum:
        - hurt
        - misrouted
        - criterion_failed
        - skipped
      type: string
    eval-eval-ImprovementBlockOp:
      oneOf:
        - properties:
            id:
              type: string
            op:
              enum:
                - replace_block
              type: string
            text:
              type: string
          required:
            - id
            - text
            - op
          type: object
        - properties:
            heading:
              type: string
            id:
              type: string
            op:
              enum:
                - insert_after
              type: string
            text:
              type: string
          required:
            - id
            - heading
            - text
            - op
          type: object
        - properties:
            id:
              type: string
            op:
              enum:
                - delete_block
              type: string
          required:
            - id
            - op
          type: object
        - properties:
            op:
              enum:
                - replace_description
              type: string
            text:
              type: string
          required:
            - text
            - op
          type: object
    eval-eval-ImprovementProfileOutputType:
      enum:
        - code_change
        - document
        - structured_data
        - answer
        - external_action
        - none
      type: string
    eval-eval-ImprovementAxes:
      properties:
        code_quality:
          $ref: '#/components/schemas/eval-eval-ImprovementAxis'
          default:
            run_count: 0
            score: 0
        compliance:
          $ref: '#/components/schemas/eval-eval-ImprovementAxis'
          default:
            run_count: 0
            score: 0
        efficiency:
          $ref: '#/components/schemas/eval-eval-ImprovementAxis'
          default:
            run_count: 0
            score: 0
        verbosity:
          $ref: '#/components/schemas/eval-eval-ImprovementAxis'
          default:
            run_count: 0
            score: 0
      required:
        - efficiency
        - compliance
        - verbosity
        - code_quality
      type: object
    eval-eval-ImprovementBlockSummary:
      allOf:
        - $ref: '#/components/schemas/eval-eval-ImprovementBlockCounts'
        - properties:
            block_id:
              type: string
            by_family:
              additionalProperties:
                $ref: '#/components/schemas/eval-eval-ImprovementBlockCounts'
              propertyNames:
                type: string
              type: object
            heading:
              type: string
          required:
            - block_id
            - heading
            - by_family
          type: object
    eval-eval-ImprovementFamilySummary:
      properties:
        axes:
          $ref: '#/components/schemas/eval-eval-ImprovementAxes'
          default:
            code_quality:
              run_count: 0
              score: 0
            compliance:
              run_count: 0
              score: 0
            efficiency:
              run_count: 0
              score: 0
            verbosity:
              run_count: 0
              score: 0
        judged_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
        outcomes:
          $ref: '#/components/schemas/eval-eval-ImprovementOutcomes'
          default:
            follow_up_run_count: 0
      required:
        - judged_count
        - axes
        - outcomes
      type: object
    eval-eval-ImprovementCriterionSummary:
      properties:
        pass_rate:
          type:
            - number
            - 'null'
          format: double
        run_count:
          type: integer
          format: int32
          minimum: 0
        text:
          type: string
      required:
        - text
        - run_count
      type: object
    eval-eval-ImprovementSummaryExcluded:
      properties:
        fetch_failed_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
        misattributed_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
        structure_only_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
        subject_not_found_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
      required:
        - misattributed_count
        - subject_not_found_count
        - structure_only_count
        - fetch_failed_count
      type: object
    eval-eval-ImprovementJudgeSummary:
      properties:
        input_tokens:
          default: 0
          format: int64
          minimum: 0
          type: integer
        p50_ms:
          default: null
          format: int64
          minimum: 0
          type:
            - integer
            - 'null'
        request_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
      required:
        - request_count
        - input_tokens
      type: object
    eval-eval-ImprovementOutcomes:
      properties:
        correct_invocation_rate:
          default: null
          format: double
          type:
            - number
            - 'null'
        follow_up_run_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
        goal_rate:
          default: null
          format: double
          type:
            - number
            - 'null'
        user_corrected_rate:
          default: null
          format: double
          type:
            - number
            - 'null'
      required:
        - follow_up_run_count
      type: object
    eval-eval-ImprovementFamilyEvidence:
      properties:
        hit_count:
          type: integer
          format: int32
          minimum: 0
        run_count:
          type: integer
          format: int32
          minimum: 0
      required:
        - run_count
        - hit_count
      type: object
    eval-eval-ImprovementAxis:
      properties:
        raw:
          default: null
          format: double
          type:
            - number
            - 'null'
        run_count:
          default: 0
          format: int32
          minimum: 0
          type: integer
        score:
          default: 0
          format: double
          type: number
      required:
        - score
        - run_count
      type: object
    eval-eval-ImprovementBlockCounts:
      properties:
        followed:
          default: 0
          format: int32
          minimum: 0
          type: integer
        hurt:
          default: 0
          format: int32
          minimum: 0
          type: integer
        not_applicable:
          default: 0
          format: int32
          minimum: 0
          type: integer
        skipped:
          default: 0
          format: int32
          minimum: 0
          type: integer
        uncertain:
          default: 0
          format: int32
          minimum: 0
          type: integer
      required:
        - followed
        - hurt
        - skipped
        - not_applicable
        - uncertain
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.