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

> ## Agent Instructions
> Every page in this documentation carries a `plans` list in its frontmatter and a page-details table naming the plans its content applies to: `All plans`, or a subset of `Community`, `Team` and `Enterprise`. A page limited to some plans also opens with a plan marker naming them.
> Use [Capabilities and limits](/product-status) for capability entitlements and documented availability and limits, and [Plans and billing](/plans-and-billing) for plan pricing and billing policy. Those pages are canonical; do not duplicate their policy values here.
> Reading this documentation grants no product access and no permission. No agent can create or approve a Nitsor release.

# Read an async Request



## OpenAPI

````yaml /openapi.json get /api/v1/requests/{id}
openapi: 3.1.1
info:
  title: Nitsor public API
  version: v1
  description: Generated from the Nitsor API contract; never edit by hand.
  x-nitsor-product-version: 0.1.0
servers:
  - url: https://api.nitsor.com
    description: Nitsor API
security:
  - bearerAuth: []
tags:
  - name: auth
    description: 'Authentication: the session a bearer credential reaches.'
  - name: blind-checks
    description: >-
      Blind checks: scans labelled without seeing the model, scored against it
      under a readiness plan fixed before checking starts. Plan writes need a
      person's own token, and these routes do not accept one yet; an Agent token
      is refused, so change plans on the Pipeline tab meanwhile.
  - name: capabilities
    description: 'Capability discovery: versions, limits and formats.'
  - name: datasets
    description: 'Datasets: named selections over a project''s version graph.'
  - name: decisions
    description: Audit decisions behind authorization refusals.
  - name: executions
    description: Pipeline executions and their work items.
  - name: ledger
    description: Account ledger entries.
  - name: model-label-outcomes
    description: >-
      Model label outcomes: what people did with each label a model proposed,
      per Task and per Proposal.
  - name: model-runs
    description: >-
      Model runs a person starts on Tasks: the estimate to confirm, and the
      start that runs one scan at a time.
  - name: openapi
    description: The OpenAPI description this deployment serves.
  - name: project-groups
    description: 'Project groups: the account''s shared folders on the project shelf.'
  - name: projects
    description: 'Projects: creation and listing.'
  - name: requests
    description: 'Async Requests: status, listing, cancel and the per-item report.'
  - name: service-accounts
    description: >-
      Service accounts and their tokens: the machine identities jobs run as,
      managed by a person holding service-accounts:manage on their own token. A
      secret is shown once, on the answer that created it. A service account's
      access to a project is given, changed and removed by that project's
      admins, with a personal token holding admin there.
  - name: sources
    description: Sources and mask-read presigning.
  - name: storage-connections
    description: >-
      Storage connections to customer object storage, and the
      operator-provisioned credential handles they name.
  - name: task-comments
    description: Task comments, replies and attention.
  - name: taxonomy
    description: Taxonomy definitions, display groups and binding.
  - name: version-graph
    description: Version-graph commits, branches, landmarks and merges.
  - name: workflow
    description: Workflow definition and binding.
paths:
  /api/v1/requests/{id}:
    get:
      tags:
        - requests
      summary: Read an async Request
      operationId: asyncRequestsGet
      parameters:
        - in: path
          name: id
          schema:
            type: string
            minLength: 1
            maxLength: 200
            description: The Request's operationId.
          required: true
          description: The Request's operationId.
      responses:
        '200':
          description: Read an async Request
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Nitsor-Token-Expires:
              $ref: '#/components/headers/TokenExpires'
            ETag:
              $ref: '#/components/headers/ETag'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncRequest'
        '304':
          description: >-
            The caller's `If-None-Match` still describes the representation, so
            no body is sent.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Nitsor-Token-Expires:
              $ref: '#/components/headers/TokenExpires'
            ETag:
              $ref: '#/components/headers/ETag'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
        '400':
          $ref: '#/components/responses/NitsorErrorAuthenticated'
        '401':
          $ref: '#/components/responses/NitsorError'
        '403':
          $ref: '#/components/responses/NitsorErrorAuthenticated'
        '404':
          $ref: '#/components/responses/NitsorErrorAuthenticated'
        '405':
          $ref: '#/components/responses/NitsorError'
        '409':
          $ref: '#/components/responses/NitsorErrorAuthenticated'
        '413':
          $ref: '#/components/responses/NitsorErrorAuthenticated'
        '422':
          $ref: '#/components/responses/NitsorErrorAuthenticated'
        '429':
          $ref: '#/components/responses/NitsorErrorAuthenticated'
components:
  headers:
    RequestId:
      description: The request id every answer carries; echo it when reporting a problem.
      schema:
        type: string
    TokenExpires:
      description: >-
        The instant the credential that made the request stops working, RFC 3339
        in UTC. Sent on every authenticated answer, a refusal after
        authentication included, once the credential has 14 days or fewer left.
        Never sent on a 401 or a 405, or by a route that needs no credential.
      schema:
        type: string
        format: date-time
    ETag:
      description: >-
        The representation's validator, weak by construction. Send it back as
        `If-None-Match` to be told `304` instead of the whole body.
      schema:
        type: string
    CacheControl:
      description: How long the answer may be reused, and by whom.
      schema:
        type: string
    RetryAfter:
      description: >-
        Whole seconds to wait before polling an accepted Request or retrying a
        429 refusal.
      schema:
        type: integer
        minimum: 0
  schemas:
    AsyncRequest:
      oneOf:
        - $ref: '#/components/schemas/AsyncRequestQueued'
        - $ref: '#/components/schemas/AsyncRequestRunning'
        - $ref: '#/components/schemas/AsyncRequestSucceededOutput'
        - $ref: '#/components/schemas/AsyncRequestFailedOutput'
        - $ref: '#/components/schemas/AsyncRequestCancelledOutput'
      type: object
      discriminator:
        propertyName: state
        mapping:
          queued: '#/components/schemas/AsyncRequestQueued'
          running: '#/components/schemas/AsyncRequestRunning'
          succeeded: '#/components/schemas/AsyncRequestSucceededOutput'
          failed: '#/components/schemas/AsyncRequestFailedOutput'
          cancelled: '#/components/schemas/AsyncRequestCancelledOutput'
    AsyncRequestQueued:
      type: object
      properties:
        operationId:
          type: string
          minLength: 1
          maxLength: 200
        operation:
          $ref: '#/components/schemas/AsyncRequestOperation'
        progress:
          type: number
          minimum: 0
          maximum: 1
        createdAt:
          $ref: '#/components/schemas/UtcTimestamp'
        startedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        principalId:
          type: string
          minLength: 1
          maxLength: 200
        target:
          $ref: '#/components/schemas/AsyncRequestResultRefOutput'
        actualCost:
          type: object
          properties:
            amount:
              type: number
              minimum: 0
            currency:
              type: string
              minLength: 1
          required:
            - amount
            - currency
        retry:
          type: object
          properties:
            attempt:
              type: integer
              minimum: 0
            maxAttempts:
              type: integer
              minimum: 1
          required:
            - attempt
          description: '`attempt` never exceeds `maxAttempts` when a bound is declared.'
        cancellable:
          type: boolean
        counts:
          $ref: '#/components/schemas/AsyncRequestCountsOutput'
        reportRef:
          $ref: '#/components/schemas/AsyncRequestReportRefOutput'
        revision:
          type: integer
          minimum: 1
        cancelRequestedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        state:
          type: string
          const: queued
        resultRefs:
          maxItems: 0
          type: array
          items:
            $ref: '#/components/schemas/AsyncRequestResultRefOutput'
      required:
        - operationId
        - operation
        - createdAt
        - principalId
        - cancellable
        - counts
        - reportRef
        - revision
        - state
    AsyncRequestRunning:
      type: object
      properties:
        operationId:
          type: string
          minLength: 1
          maxLength: 200
        operation:
          $ref: '#/components/schemas/AsyncRequestOperation'
        progress:
          type: number
          minimum: 0
          maximum: 1
        createdAt:
          $ref: '#/components/schemas/UtcTimestamp'
        startedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        principalId:
          type: string
          minLength: 1
          maxLength: 200
        target:
          $ref: '#/components/schemas/AsyncRequestResultRefOutput'
        actualCost:
          type: object
          properties:
            amount:
              type: number
              minimum: 0
            currency:
              type: string
              minLength: 1
          required:
            - amount
            - currency
        retry:
          type: object
          properties:
            attempt:
              type: integer
              minimum: 0
            maxAttempts:
              type: integer
              minimum: 1
          required:
            - attempt
          description: '`attempt` never exceeds `maxAttempts` when a bound is declared.'
        cancellable:
          type: boolean
        counts:
          $ref: '#/components/schemas/AsyncRequestCountsOutput'
        reportRef:
          $ref: '#/components/schemas/AsyncRequestReportRefOutput'
        revision:
          type: integer
          minimum: 1
        cancelRequestedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        state:
          type: string
          const: running
        resultRefs:
          maxItems: 0
          type: array
          items:
            $ref: '#/components/schemas/AsyncRequestResultRefOutput'
      required:
        - operationId
        - operation
        - createdAt
        - principalId
        - cancellable
        - counts
        - reportRef
        - revision
        - state
    AsyncRequestSucceededOutput:
      type: object
      properties:
        operationId:
          type: string
          minLength: 1
          maxLength: 200
        operation:
          $ref: '#/components/schemas/AsyncRequestOperation'
        progress:
          type: number
          minimum: 0
          maximum: 1
        createdAt:
          $ref: '#/components/schemas/UtcTimestamp'
        startedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        principalId:
          type: string
          minLength: 1
          maxLength: 200
        target:
          $ref: '#/components/schemas/AsyncRequestResultRefOutput'
        actualCost:
          type: object
          properties:
            amount:
              type: number
              minimum: 0
            currency:
              type: string
              minLength: 1
          required:
            - amount
            - currency
        retry:
          type: object
          properties:
            attempt:
              type: integer
              minimum: 0
            maxAttempts:
              type: integer
              minimum: 1
          required:
            - attempt
          description: '`attempt` never exceeds `maxAttempts` when a bound is declared.'
        cancellable:
          type: boolean
        counts:
          $ref: '#/components/schemas/AsyncRequestCountsOutput'
        reportRef:
          $ref: '#/components/schemas/AsyncRequestReportRefOutput'
        revision:
          type: integer
          minimum: 1
        cancelRequestedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        finishedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        reportExpiresAt:
          $ref: '#/components/schemas/UtcTimestamp'
        state:
          type: string
          const: succeeded
        outcome:
          type: string
          enum:
            - succeeded
            - partial_failure
        resultRefs:
          maxItems: 64
          type: array
          items:
            $ref: '#/components/schemas/AsyncRequestResultRefOutput'
      required:
        - operationId
        - operation
        - createdAt
        - principalId
        - cancellable
        - counts
        - reportRef
        - revision
        - finishedAt
        - state
        - outcome
        - resultRefs
    AsyncRequestFailedOutput:
      type: object
      properties:
        operationId:
          type: string
          minLength: 1
          maxLength: 200
        operation:
          $ref: '#/components/schemas/AsyncRequestOperation'
        progress:
          type: number
          minimum: 0
          maximum: 1
        createdAt:
          $ref: '#/components/schemas/UtcTimestamp'
        startedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        principalId:
          type: string
          minLength: 1
          maxLength: 200
        target:
          $ref: '#/components/schemas/AsyncRequestResultRefOutput'
        actualCost:
          type: object
          properties:
            amount:
              type: number
              minimum: 0
            currency:
              type: string
              minLength: 1
          required:
            - amount
            - currency
        retry:
          type: object
          properties:
            attempt:
              type: integer
              minimum: 0
            maxAttempts:
              type: integer
              minimum: 1
          required:
            - attempt
          description: '`attempt` never exceeds `maxAttempts` when a bound is declared.'
        cancellable:
          type: boolean
        counts:
          $ref: '#/components/schemas/AsyncRequestCountsOutput'
        reportRef:
          $ref: '#/components/schemas/AsyncRequestReportRefOutput'
        revision:
          type: integer
          minimum: 1
        cancelRequestedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        finishedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        reportExpiresAt:
          $ref: '#/components/schemas/UtcTimestamp'
        state:
          type: string
          const: failed
        outcome:
          type: string
          const: failed
        resultRefs:
          maxItems: 0
          type: array
          items:
            $ref: '#/components/schemas/AsyncRequestResultRefOutput'
        error:
          $ref: '#/components/schemas/AsyncRequestErrorOutput'
      required:
        - operationId
        - operation
        - createdAt
        - principalId
        - cancellable
        - counts
        - reportRef
        - revision
        - finishedAt
        - state
        - outcome
        - error
    AsyncRequestCancelledOutput:
      type: object
      properties:
        operationId:
          type: string
          minLength: 1
          maxLength: 200
        operation:
          $ref: '#/components/schemas/AsyncRequestOperation'
        progress:
          type: number
          minimum: 0
          maximum: 1
        createdAt:
          $ref: '#/components/schemas/UtcTimestamp'
        startedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        principalId:
          type: string
          minLength: 1
          maxLength: 200
        target:
          $ref: '#/components/schemas/AsyncRequestResultRefOutput'
        actualCost:
          type: object
          properties:
            amount:
              type: number
              minimum: 0
            currency:
              type: string
              minLength: 1
          required:
            - amount
            - currency
        retry:
          type: object
          properties:
            attempt:
              type: integer
              minimum: 0
            maxAttempts:
              type: integer
              minimum: 1
          required:
            - attempt
          description: '`attempt` never exceeds `maxAttempts` when a bound is declared.'
        cancellable:
          type: boolean
        counts:
          $ref: '#/components/schemas/AsyncRequestCountsOutput'
        reportRef:
          $ref: '#/components/schemas/AsyncRequestReportRefOutput'
        revision:
          type: integer
          minimum: 1
        cancelRequestedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        finishedAt:
          $ref: '#/components/schemas/UtcTimestamp'
        reportExpiresAt:
          $ref: '#/components/schemas/UtcTimestamp'
        state:
          type: string
          const: cancelled
        outcome:
          type: string
          const: cancelled
        resultRefs:
          maxItems: 0
          type: array
          items:
            $ref: '#/components/schemas/AsyncRequestResultRefOutput'
      required:
        - operationId
        - operation
        - createdAt
        - principalId
        - cancellable
        - counts
        - reportRef
        - revision
        - finishedAt
        - state
        - outcome
    NitsorError:
      anyOf:
        - $ref: '#/components/schemas/ErrorAuthorizationDenied'
        - $ref: '#/components/schemas/ErrorValidation'
        - $ref: '#/components/schemas/ErrorNotFound'
        - $ref: '#/components/schemas/ErrorAuth'
        - $ref: '#/components/schemas/ErrorMethodNotAllowed'
        - $ref: '#/components/schemas/ErrorCheckpointRequired'
        - $ref: '#/components/schemas/ErrorManifest'
        - $ref: '#/components/schemas/ErrorDomain'
    AsyncRequestOperation:
      type: string
      enum:
        - import
        - export
        - model-run
        - report
        - prediction-import
        - dataset-version
        - source-representation
    UtcTimestamp:
      type: string
      format: date-time
      pattern: >-
        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|[+-]00:00))$
      description: >-
        RFC 3339 timestamp in UTC: the offset is `Z` or `+00:00`; any other
        offset is refused.
    AsyncRequestResultRefOutput:
      type: object
      properties:
        kind:
          type: string
          minLength: 1
          maxLength: 64
        id:
          type: string
          minLength: 1
          maxLength: 200
      required:
        - kind
        - id
    AsyncRequestCountsOutput:
      type: object
      properties:
        submitted:
          type: integer
          minimum: 0
        pending:
          type: integer
          minimum: 0
        succeeded:
          type: integer
          minimum: 0
        failed:
          type: integer
          minimum: 0
        rejected:
          type: integer
          minimum: 0
        cancelled:
          type: integer
          minimum: 0
      required:
        - submitted
        - pending
        - succeeded
        - failed
        - rejected
        - cancelled
      description: >-
        `submitted` equals the sum of `pending`, `succeeded`, `failed`,
        `rejected` and `cancelled`.
    AsyncRequestReportRefOutput:
      oneOf:
        - $ref: '#/components/schemas/AsyncRequestReportRefRetainedOutput'
        - $ref: '#/components/schemas/AsyncRequestReportRefExpiredOutput'
      type: object
      discriminator:
        propertyName: kind
        mapping:
          retained: '#/components/schemas/AsyncRequestReportRefRetainedOutput'
          expired: '#/components/schemas/AsyncRequestReportRefExpiredOutput'
    AsyncRequestErrorOutput:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/IssueCode'
        message:
          type: string
          minLength: 1
          maxLength: 250
        remediation:
          type: string
          minLength: 1
          maxLength: 100
      required:
        - code
        - message
    ErrorAuthorizationDenied:
      type: object
      properties:
        requestId:
          $ref: '#/components/schemas/RequestId'
        retryable:
          type: boolean
        reason:
          type: string
          minLength: 1
        code:
          type: string
          const: AUTHORIZATION_DENIED
        decisionId:
          type: string
          minLength: 1
        message:
          type: string
          minLength: 1
        missingScope:
          type: string
          minLength: 1
      required:
        - requestId
        - retryable
        - code
        - message
        - missingScope
    ErrorValidation:
      type: object
      properties:
        requestId:
          $ref: '#/components/schemas/RequestId'
        retryable:
          type: boolean
        reason:
          type: string
          minLength: 1
        code:
          type: string
          const: INVALID_ARGUMENT
        fieldPath:
          type: string
          minLength: 1
        message:
          type: string
          minLength: 1
        remediation:
          type: string
          minLength: 1
      required:
        - requestId
        - retryable
        - code
        - message
    ErrorNotFound:
      type: object
      properties:
        requestId:
          $ref: '#/components/schemas/RequestId'
        retryable:
          type: boolean
        reason:
          type: string
          minLength: 1
        code:
          type: string
          const: ACCOUNT_NOT_FOUND
        message:
          type: string
          minLength: 1
      required:
        - requestId
        - retryable
        - code
        - message
    ErrorAuth:
      type: object
      properties:
        requestId:
          $ref: '#/components/schemas/RequestId'
        retryable:
          type: boolean
        reason:
          type: string
          minLength: 1
        code:
          type: string
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID_TOKEN
        expiredAt:
          $ref: '#/components/schemas/UtcTimestamp'
        message:
          type: string
          minLength: 1
        remediation:
          type: string
          minLength: 1
      required:
        - requestId
        - retryable
        - code
        - message
        - remediation
    ErrorMethodNotAllowed:
      type: object
      properties:
        requestId:
          $ref: '#/components/schemas/RequestId'
        retryable:
          type: boolean
        reason:
          type: string
          minLength: 1
        code:
          type: string
          const: METHOD_NOT_ALLOWED
        message:
          type: string
          minLength: 1
        remediation:
          type: string
          minLength: 1
      required:
        - requestId
        - retryable
        - code
        - message
        - remediation
    ErrorCheckpointRequired:
      type: object
      properties:
        branchId:
          type: string
          minLength: 1
          maxLength: 200
          x-nitsor-trim: true
        headEventSeq:
          type: integer
          exclusiveMinimum: 0
        lastEventSeq:
          type: integer
          exclusiveMinimum: 0
        maxUncommittedEvents:
          type: number
          const: 256
        requestId:
          $ref: '#/components/schemas/RequestId'
        retryable:
          type: boolean
        reason:
          type: string
          minLength: 1
        code:
          type: string
          const: CHECKPOINT_REQUIRED
        message:
          type: string
          minLength: 1
        remediation:
          type: string
          minLength: 1
      required:
        - branchId
        - headEventSeq
        - lastEventSeq
        - maxUncommittedEvents
        - requestId
        - retryable
        - code
        - message
        - remediation
    ErrorManifest:
      type: object
      properties:
        requestId:
          $ref: '#/components/schemas/RequestId'
        retryable:
          type: boolean
        reason:
          type: string
          minLength: 1
        code:
          type: string
          const: NO_VALID_DICOM_SLICES
        manifest:
          type: array
          items:
            $ref: '#/components/schemas/SourceManifestEntry'
        message:
          type: string
          minLength: 1
        remediation:
          type: string
          minLength: 1
      required:
        - requestId
        - retryable
        - code
        - manifest
        - message
        - remediation
    ErrorDomain:
      type: object
      properties:
        requestId:
          $ref: '#/components/schemas/RequestId'
        retryable:
          type: boolean
        reason:
          type: string
          minLength: 1
        code:
          type: string
          enum:
            - API_ERROR
            - API_UNREACHABLE
            - CORRUPT_DICOM
            - CORRUPT_TIFF_STACK
            - CORRUPT_VGI
            - DATASET_NAME_CONFLICT
            - DATASET_NOT_FOUND
            - DATASET_REVISION_CONFLICT
            - DATASET_VERSION_NOT_FOUND
            - DATASET_VERSION_RESOLVING
            - DATASET_VERSION_NAME_CONFLICT
            - DATASET_HEAD_UNCOMMITTED
            - DATASET_NO_QUALIFYING_COMMIT
            - DATASET_MEMBERSHIP_UNDECLARED
            - DATASET_HARD_MEMBER_MISSING
            - DATASET_HARD_MEMBER_EXCLUDED
            - DATASET_SELECTION_EMPTY
            - DATASET_OBJECT_MISSING
            - DATASET_OBJECT_CHANGED
            - DATASET_MEMBER_TOO_LARGE
            - DATASET_LAYOUT_UNSATISFIABLE
            - DATASET_BUILD_UNAVAILABLE
            - DATASET_BUILD_INVALID
            - DATASET_FREEZE_TIMEOUT
            - DATASET_MANIFEST_HASH_MISMATCH
            - DATASET_READ_SESSION_NOT_FOUND
            - DATASET_READ_SESSION_CLOSED
            - DATASET_VERSION_REVOKED
            - DATASET_VERSION_TOMBSTONED
            - DATASET_VERSION_CANCELLED
            - DUPLICATE_SOP_INSTANCE_UID
            - GEOMETRY_INCONSISTENT
            - GEOMETRY_OUT_OF_RANGE
            - IDEMPOTENCY_CONFLICT
            - INVALID_JSON
            - MISSING_SLICE
            - MIXED_FORMAT_FAMILIES
            - MODEL_RUN_ESTIMATE_CHANGED
            - MODEL_RUN_MULTI_ITEM_UNSUPPORTED
            - MODEL_RUN_SCAN_TOO_LARGE
            - MODEL_RUN_NOT_OFFERED
            - PROJECT_CREATE_FAILED
            - RATE_LIMITED
            - REQUEST_NOT_CANCELLABLE
            - REQUEST_NOT_FOUND
            - REQUEST_REPORT_EXPIRED
            - SERIES_IDENTITY_MISMATCH
            - SLICE_ORDER_INCONSISTENT
            - SOURCE_LIST_FAILED
            - SOURCE_REGISTER_FAILED
            - SOURCE_VERSION_AMBIGUOUS
            - STORAGE_CONNECTION_REGISTER_FAILED
            - STORAGE_CREDENTIAL_ENVIRONMENT_FORBIDDEN
            - STORAGE_CREDENTIAL_HANDLE_CONFLICT
            - STORAGE_CREDENTIAL_HANDLE_INVALID
            - STORAGE_CREDENTIAL_HANDLE_NOT_FOUND
            - STORAGE_CREDENTIAL_HANDLE_REQUIRED
            - STORAGE_CREDENTIAL_PRESIGN_UNSUPPORTED
            - STORAGE_CREDENTIAL_ROLE_MISMATCH
            - STORAGE_CREDENTIAL_TARGET_MISMATCH
            - STORAGE_CREDENTIAL_UNAVAILABLE
            - STORAGE_CUSTOM_HOSTS_NOT_READY
            - STORAGE_OBJECT_CHANGED_DURING_READ
            - STORAGE_OBJECT_NOT_FOUND
            - STORAGE_OBJECT_TOO_LARGE
            - STORAGE_READ_FAILED
            - UNEXPECTED_ERROR
            - UNKNOWN_COMMAND
            - UNSUPPORTED_PIXEL_FORMAT
            - UNSUPPORTED_TRANSFER_SYNTAX
            - UNSUPPORTED_VGI_SCENE
            - UNRECOGNIZED_FORMAT
            - VERSION_GRAPH_OPERATION_FAILED
            - VGI_VOL_MISMATCH
            - TAXONOMY_OPERATION_FAILED
            - WORKFLOW_OPERATION_FAILED
        message:
          type: string
          minLength: 1
        remediation:
          type: string
          minLength: 1
      required:
        - requestId
        - retryable
        - code
        - message
        - remediation
    AsyncRequestReportRefRetainedOutput:
      type: object
      properties:
        kind:
          type: string
          const: retained
      required:
        - kind
    AsyncRequestReportRefExpiredOutput:
      type: object
      properties:
        kind:
          type: string
          const: expired
        expiredAt:
          $ref: '#/components/schemas/UtcTimestamp'
      required:
        - kind
        - expiredAt
    IssueCode:
      type: string
      enum:
        - ACCOUNT_NOT_FOUND
        - API_ERROR
        - API_UNREACHABLE
        - AUTHORIZATION_DENIED
        - AUTH_INVALID_TOKEN
        - AUTH_REQUIRED
        - CHECKPOINT_REQUIRED
        - CORRUPT_VGI
        - CORRUPT_DICOM
        - CORRUPT_TIFF_STACK
        - DATASET_NAME_CONFLICT
        - DATASET_NOT_FOUND
        - DATASET_REVISION_CONFLICT
        - DATASET_VERSION_NOT_FOUND
        - DATASET_VERSION_RESOLVING
        - DATASET_VERSION_NAME_CONFLICT
        - DATASET_HEAD_UNCOMMITTED
        - DATASET_NO_QUALIFYING_COMMIT
        - DATASET_MEMBERSHIP_UNDECLARED
        - DATASET_HARD_MEMBER_MISSING
        - DATASET_HARD_MEMBER_EXCLUDED
        - DATASET_SELECTION_EMPTY
        - DATASET_OBJECT_MISSING
        - DATASET_OBJECT_CHANGED
        - DATASET_MEMBER_TOO_LARGE
        - DATASET_LAYOUT_UNSATISFIABLE
        - DATASET_BUILD_UNAVAILABLE
        - DATASET_BUILD_INVALID
        - DATASET_FREEZE_TIMEOUT
        - DATASET_VERSION_CANCELLED
        - DATASET_MANIFEST_HASH_MISMATCH
        - DATASET_READ_SESSION_NOT_FOUND
        - DATASET_READ_SESSION_CLOSED
        - DATASET_VERSION_REVOKED
        - DATASET_VERSION_TOMBSTONED
        - DUPLICATE_SOP_INSTANCE_UID
        - GEOMETRY_INCONSISTENT
        - GEOMETRY_OUT_OF_RANGE
        - IDEMPOTENCY_CONFLICT
        - INVALID_ARGUMENT
        - INVALID_JSON
        - METHOD_NOT_ALLOWED
        - MISSING_SLICE
        - MIXED_FORMAT_FAMILIES
        - MODEL_RUN_BUDGET_EXHAUSTED
        - MODEL_RUN_ESTIMATE_CHANGED
        - MODEL_RUN_ITEM_LANDS_FROM_JOB
        - MODEL_RUN_ITEM_SETTLED
        - MODEL_RUN_LANDED_LATE
        - MODEL_RUN_MODEL_FAILED
        - MODEL_RUN_MULTI_ITEM_UNSUPPORTED
        - MODEL_RUN_NOT_OFFERED
        - MODEL_RUN_PIN_CHANGED
        - MODEL_RUN_REPLACEMENT_CHANGED
        - MODEL_RUN_REPORT_EXPIRED
        - MODEL_RUN_REQUEST_STOPPING
        - MODEL_RUN_SCAN_TOO_LARGE
        - MODEL_RUN_SOURCE_CHANGED
        - MODEL_RUN_SUPERSEDED
        - MODEL_RUN_TASK_BINDING_LOST
        - MODEL_RUN_TASK_NOT_ELIGIBLE
        - MODEL_RUN_TIME_LIMIT
        - NO_VALID_DICOM_SLICES
        - PROJECT_CREATE_FAILED
        - RATE_LIMITED
        - REQUEST_LANDING_TOO_LARGE
        - REQUEST_NOT_CANCELLABLE
        - REQUEST_NOT_FOUND
        - REQUEST_REPORT_EXPIRED
        - REQUEST_WORKER_EXHAUSTED
        - SERIES_IDENTITY_MISMATCH
        - SERVER_VERSION_INCOMPATIBLE
        - SLICE_ORDER_INCONSISTENT
        - SOURCE_LIST_FAILED
        - SOURCE_REGISTER_FAILED
        - SOURCE_VERSION_AMBIGUOUS
        - STORAGE_CONNECTION_REGISTER_FAILED
        - STORAGE_CREDENTIAL_ENVIRONMENT_FORBIDDEN
        - STORAGE_CREDENTIAL_HANDLE_CONFLICT
        - STORAGE_CREDENTIAL_HANDLE_INVALID
        - STORAGE_CREDENTIAL_HANDLE_NOT_FOUND
        - STORAGE_CREDENTIAL_HANDLE_REQUIRED
        - STORAGE_CREDENTIAL_PRESIGN_UNSUPPORTED
        - STORAGE_CREDENTIAL_ROLE_MISMATCH
        - STORAGE_CREDENTIAL_TARGET_MISMATCH
        - STORAGE_CREDENTIAL_UNAVAILABLE
        - STORAGE_CUSTOM_HOSTS_NOT_READY
        - STORAGE_OBJECT_CHANGED_DURING_READ
        - STORAGE_OBJECT_NOT_FOUND
        - STORAGE_OBJECT_TOO_LARGE
        - STORAGE_READ_FAILED
        - UNEXPECTED_ERROR
        - UNKNOWN_COMMAND
        - UNSUPPORTED_VGI_SCENE
        - UNSUPPORTED_PIXEL_FORMAT
        - UNSUPPORTED_TRANSFER_SYNTAX
        - UNRECOGNIZED_FORMAT
        - VERSION_GRAPH_OPERATION_FAILED
        - VGI_VOL_MISMATCH
        - TAXONOMY_OPERATION_FAILED
        - WORKFLOW_OPERATION_FAILED
    RequestId:
      type: string
      minLength: 1
      maxLength: 128
      pattern: ^[\x21-\x7e]+$
    SourceManifestEntry:
      type: object
      properties:
        byteSize:
          type: integer
          minimum: 0
        checksum:
          $ref: '#/components/schemas/Sha256Digest'
        contentFingerprint:
          $ref: '#/components/schemas/Sha256Digest'
        errors:
          maxItems: 1
          type: array
          items:
            $ref: '#/components/schemas/IngestIssue'
        etag:
          type: string
          minLength: 1
        etagWeak:
          type: boolean
        instanceNumber:
          type: integer
        objectKey:
          type: string
          minLength: 1
        pixelDataByteOffset:
          type: integer
          minimum: 0
        positionMm:
          type: number
        role:
          type: string
          enum:
            - descriptor
            - voxel-data
        sopInstanceUid:
          type: string
          minLength: 1
        status:
          type: string
          enum:
            - registered
            - rejected
      required:
        - errors
        - objectKey
        - status
    Sha256Digest:
      type: string
      pattern: ^sha256:([0-9a-f]{64})$
    IngestIssue:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/IssueCode'
        fieldPath:
          type: string
        message:
          type: string
          minLength: 1
          maxLength: 250
        remediation:
          type: string
          minLength: 1
          maxLength: 100
      required:
        - code
        - message
        - remediation
  responses:
    NitsorErrorAuthenticated:
      description: >-
        The request was refused. `code` names the refusal; `requestId`
        correlates it.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        Nitsor-Token-Expires:
          $ref: '#/components/headers/TokenExpires'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NitsorError'
    NitsorError:
      description: >-
        The request was refused. `code` names the refusal; `requestId`
        correlates it.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NitsorError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An Agent credential (`nits_…`), or a person token (`nitp_…`) on a
        deployment that enables them. `GET /api/v1/session` names the principal
        a credential proves.

````

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