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

# Resume an accepted filing pre-review

> Recover dispatch of an existing pre-review after an interrupted start, including when the original request key was lost. Obtain runId from pre-review-status. Repeated calls use the same execution and workflow identity; they never capture new inputs or restart a terminal run. A stopped workflow is reconciled as failed, releasing its active reservation. No request body or Idempotency-Key is required because runId identifies the existing operation. Requires filing Editor access, session creation permission and an ordinary member credential. Recovery does not reserve a new execution or require new spending admission; workers retain the original initiating authorization.



## OpenAPI

````yaml /openapi.json post /insurance/managed-filings/{filingId}/pre-reviews/{runId}/resume
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/managed-filings/{filingId}/pre-reviews/{runId}/resume:
    post:
      tags:
        - Managed Filing Checks
      summary: Resume an accepted filing pre-review
      description: >-
        Recover dispatch of an existing pre-review after an interrupted start,
        including when the original request key was lost. Obtain runId from
        pre-review-status. Repeated calls use the same execution and workflow
        identity; they never capture new inputs or restart a terminal run. A
        stopped workflow is reconciled as failed, releasing its active
        reservation. No request body or Idempotency-Key is required because
        runId identifies the existing operation. Requires filing Editor access,
        session creation permission and an ordinary member credential. Recovery
        does not reserve a new execution or require new spending admission;
        workers retain the original initiating authorization.
      operationId: resumeManagedFilingPreReview
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: filingId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: runId
          in: path
      responses:
        '200':
          description: The execution is terminal. It was not restarted.
          headers:
            Location:
              schema:
                type: string
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2FilingPreReview'
        '202':
          description: Dispatch recovered or already active. Poll Location for progress.
          headers:
            Location:
              schema:
                type: string
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2FilingPreReview'
        '400':
          description: Invalid request or input limits exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            Recovery requires filing Editor access, session creation permission
            and an ordinary member credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Filing or pre-review not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: The filing is read-only.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dispatch is unavailable. Retry this resume request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2FilingPreReview:
      type: object
      properties:
        filingId:
          type: string
          format: uuid
        runId:
          type: string
          format: uuid
          description: >-
            Immutable pre-review execution ID, distinct from any chat session
            ID. Poll this execution using runId.
        rootRunId:
          type: string
          nullable: true
          format: uuid
          description: Full-review lineage root for a rerun; null for a full review.
        sourceRunId:
          type: string
          nullable: true
          format: uuid
          description: >-
            Execution containing the selected source check; null for a full
            review.
        captainSessionId:
          type: string
          nullable: true
          format: uuid
          description: >-
            Associated filing chat session, shared across runs. Null on older
            executions.
        sessionUrl:
          type: string
          format: uri
          description: >-
            Open the associated filing chat session; session access permissions
            apply.
        status:
          type: string
          enum:
            - queued
            - running
            - completed
            - failed
        createdAt:
          type: string
          format: date-time
        completedAt:
          type: string
          nullable: true
          format: date-time
        idempotencyExpiresAt:
          type: string
          nullable: true
          format: date-time
          description: >-
            Request-key binding expiry, 24 hours after acceptance; null for
            unkeyed requests.
        checks:
          type: array
          items:
            type: object
            properties:
              checkId:
                type: string
                format: uuid
              versionId:
                type: string
                format: uuid
                description: Published check revision captured for this attempt.
              name:
                type: string
              status:
                type: string
                enum:
                  - queued
                  - assessing
                  - running
                  - passed
                  - findings
                  - not_applicable
                  - failed
                description: >-
                  passed: no issues found; findings: comments published;
                  not_applicable: skipped with a reason; failed: incomplete
                  analysis or publication. Inspect summary and commentIds.
              summary:
                type: string
                nullable: true
              commentIds:
                type: array
                items:
                  type: string
                  format: uuid
                description: >-
                  New or reused finding comments, including any published before
                  failure. Passing a rerun does not resolve earlier discussions.
              agentSessionId:
                type: string
                nullable: true
                format: uuid
                description: Actual check-agent chat session; null before dispatch.
              sessionUrl:
                type: string
                nullable: true
                format: uri
            required:
              - checkId
              - versionId
              - name
              - status
              - summary
              - commentIds
              - agentSessionId
              - sessionUrl
      required:
        - filingId
        - runId
        - rootRunId
        - sourceRunId
        - captainSessionId
        - sessionUrl
        - status
        - createdAt
        - completedAt
        - idempotencyExpiresAt
        - checks
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

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