Read an extracted objection letter

curl --request GET \
  --url https://canary.effectiveai.app/api/v2/filing-objections/{objectionId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://canary.effectiveai.app/api/v2/filing-objections/{objectionId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://canary.effectiveai.app/api/v2/filing-objections/{objectionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://canary.effectiveai.app/api/v2/filing-objections/{objectionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://canary.effectiveai.app/api/v2/filing-objections/{objectionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://canary.effectiveai.app/api/v2/filing-objections/{objectionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "filing": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": "<string>",
    "sourceReference": "<string>",
    "state": "<string>",
    "companyName": "<string>",
    "carrierIds": [
      "<string>"
    ],
    "groupId": "<string>",
    "productName": "<string>",
    "typeOfInsurance": "<string>",
    "subTypeOfInsurance": "<string>",
    "toiCode": "<string>",
    "subToiCode": "<string>",
    "filingType": "<string>",
    "sourceStatus": "<string>",
    "submissionDate": "2023-12-25",
    "dispositionDate": "2023-12-25"
  },
  "objectionDate": "2023-12-25",
  "reviewerName": "<string>",
  "textAvailability": "available",
  "text": "<string>",
  "textRevision": "<string>",
  "location": {
    "startOffsetCharacters": 1,
    "endOffsetCharacters": 1,
    "totalCharacters": 1
  },
  "nextCursor": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

Filing objections

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.

GET

filing-objections

{objectionId}

curl --request GET \
  --url https://canary.effectiveai.app/api/v2/filing-objections/{objectionId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://canary.effectiveai.app/api/v2/filing-objections/{objectionId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://canary.effectiveai.app/api/v2/filing-objections/{objectionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://canary.effectiveai.app/api/v2/filing-objections/{objectionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://canary.effectiveai.app/api/v2/filing-objections/{objectionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://canary.effectiveai.app/api/v2/filing-objections/{objectionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "filing": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": "<string>",
    "sourceReference": "<string>",
    "state": "<string>",
    "companyName": "<string>",
    "carrierIds": [
      "<string>"
    ],
    "groupId": "<string>",
    "productName": "<string>",
    "typeOfInsurance": "<string>",
    "subTypeOfInsurance": "<string>",
    "toiCode": "<string>",
    "subToiCode": "<string>",
    "filingType": "<string>",
    "sourceStatus": "<string>",
    "submissionDate": "2023-12-25",
    "dispositionDate": "2023-12-25"
  },
  "objectionDate": "2023-12-25",
  "reviewerName": "<string>",
  "textAvailability": "available",
  "text": "<string>",
  "textRevision": "<string>",
  "location": {
    "startOffsetCharacters": 1,
    "endOffsetCharacters": 1,
    "totalCharacters": 1
  },
  "nextCursor": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

Authorizations

Authorization

string

header

required

Effective API key. Send Authorization: Bearer sk-eai-...

Path Parameters

objectionId

string<uuid>

required

Query Parameters

maxCharacters

integer

default:4000

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 range: 1 <= x <= 20000

cursor

string

Required string length: 1 - 128

Response

Letter context and revision-bound text, or explicitly unavailable text.

string<uuid>

required

Identity of an extracted letter record, not an individual issue. Re-extraction may replace it; rediscover with filingId after a 404.

filing

object

required

Show child attributes

objectionDate

string<date> | null

required

Extracted letter submission date, when known.

reviewerName

string | null

required

textAvailability

enum<string>

required

Available options:

available,

unavailable

text

string | null

required

Bounded existing letter text, including its individual issues as written. Null for missing/blank extraction or a known missing-attachment placeholder.

Maximum string length: 40000

textRevision

string | null

required

Opaque text-content revision. Not an original-file version. Changed text invalidates continuation.

location

object | null

required

Zero-based Unicode code-point offsets, end exclusive. Null when text is unavailable.

Show child attributes

nextCursor

string | null

required

Continue the same letter with unchanged maxCharacters, or null at exhaustion/unavailability. Fixed 24-hour expiry.

Users

Carriers

MGAs

Products

Filings

Files

Managed Filings

Filing objections

Read an extracted objection letter

Authorizations

Path Parameters

Query Parameters

Response