> ## 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.

# Read an extracted objection letter

> Read filing context and a bounded chunk of existing letter text. Individual issues remain within the letter text; no issue identities are assigned. Uses Unicode character offsets and a content revision, not file/page/version provenance. Missing text returns null with textAvailability=unavailable. Re-extraction may replace the record (404); rediscover using filingId. Changed text on the same record invalidates its cursor. Read-only and safe to retry; no source acquisition or extraction is started.



## OpenAPI

````yaml /openapi.json get /filing-objections/{objectionId}
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://canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /filing-objections/{objectionId}:
    get:
      tags:
        - Filing objections
      summary: Read an extracted objection letter
      description: >-
        Read filing context and a bounded chunk of existing letter text.
        Individual issues remain within the letter text; no issue identities are
        assigned. Uses Unicode character offsets and a content revision, not
        file/page/version provenance. Missing text returns null with
        textAvailability=unavailable. Re-extraction may replace the record
        (404); rediscover using filingId. Changed text on the same record
        invalidates its cursor. Read-only and safe to retry; no source
        acquisition or extraction is started.
      operationId: readFilingObjection
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: objectionId
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 20000
            default: 4000
            description: >-
              Maximum Unicode code points of letter text per response: 1–20000,
              default 4000. Repeat unchanged with cursor. Offsets are
              characters, not UTF-8 bytes or UTF-16 units.
          required: false
          description: >-
            Maximum Unicode code points of letter text per response: 1–20000,
            default 4000. Repeat unchanged with cursor. Offsets are characters,
            not UTF-8 bytes or UTF-16 units.
          name: maxCharacters
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 128
          required: false
          name: cursor
          in: query
      responses:
        '200':
          description: >-
            Letter context and revision-bound text, or explicitly unavailable
            text.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2FilingObjectionRead'
        '400':
          description: >-
            invalid_request or invalid_cursor. Restart without cursor after
            expiry, a changed query/scope, or changed letter text.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: SERFF read permission required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            Letter record missing, inaccessible or replaced by re-extraction.
            Rediscover with filingId.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: >-
            Dependency unavailable. Retry the same request after Retry-After
            seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2FilingObjectionRead:
      allOf:
        - $ref: '#/components/schemas/V2FilingObjection'
        - type: object
          properties:
            text:
              type: string
              nullable: true
              maxLength: 40000
              description: >-
                Bounded existing letter text, including its individual issues as
                written. Null for missing/blank extraction or a known
                missing-attachment placeholder.
            textRevision:
              type: string
              nullable: true
              description: >-
                Opaque text-content revision. Not an original-file version.
                Changed text invalidates continuation.
            location:
              type: object
              nullable: true
              properties:
                startOffsetCharacters:
                  type: integer
                  minimum: 0
                endOffsetCharacters:
                  type: integer
                  minimum: 0
                totalCharacters:
                  type: integer
                  minimum: 0
              required:
                - startOffsetCharacters
                - endOffsetCharacters
                - totalCharacters
              description: >-
                Zero-based Unicode code-point offsets, end exclusive. Null when
                text is unavailable.
            nextCursor:
              type: string
              nullable: true
              description: >-
                Continue the same letter with unchanged maxCharacters, or null
                at exhaustion/unavailability. Fixed 24-hour expiry.
          required:
            - text
            - textRevision
            - location
            - nextCursor
    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.
          required:
            - code
    V2FilingObjection:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Identity of an extracted letter record, not an individual issue.
            Re-extraction may replace it; rediscover with filingId after a 404.
        filing:
          $ref: '#/components/schemas/V2FilingSummary'
        objectionDate:
          type: string
          nullable: true
          format: date
          description: Extracted letter submission date, when known.
        reviewerName:
          type: string
          nullable: true
        textAvailability:
          type: string
          enum:
            - available
            - unavailable
      required:
        - id
        - filing
        - objectionDate
        - reviewerName
        - textAvailability
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
    V2FilingSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        source:
          type: string
        sourceReference:
          type: string
        state:
          type: string
        companyName:
          type: string
          nullable: true
        carrierIds:
          type: array
          nullable: true
          items:
            type: string
        groupId:
          type: string
          nullable: true
        productName:
          type: string
          nullable: true
        typeOfInsurance:
          type: string
          nullable: true
        subTypeOfInsurance:
          type: string
          nullable: true
        toiCode:
          type: string
          nullable: true
        subToiCode:
          type: string
          nullable: true
        filingType:
          type: string
          nullable: true
        sourceStatus:
          type: string
          nullable: true
        submissionDate:
          type: string
          nullable: true
          format: date
        dispositionDate:
          type: string
          nullable: true
          format: date
      required:
        - id
        - source
        - sourceReference
        - state
        - companyName
        - carrierIds
        - groupId
        - productName
        - typeOfInsurance
        - subTypeOfInsurance
        - toiCode
        - subToiCode
        - filingType
        - sourceStatus
        - submissionDate
        - dispositionDate
  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.