Search the answers of a planning question
curl --request POST \
--url https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"programs": [
{
"programId": "<string>",
"version": 1,
"title": "<string>"
}
],
"path": "<string>",
"query": "",
"limit": 50,
"answers": {},
"context": {},
"asOf": "2023-12-25"
}
'import requests
url = "https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search"
payload = {
"programs": [
{
"programId": "<string>",
"version": 1,
"title": "<string>"
}
],
"path": "<string>",
"query": "",
"limit": 50,
"answers": {},
"context": {},
"asOf": "2023-12-25"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
programs: [{programId: '<string>', version: 1, title: '<string>'}],
path: '<string>',
query: '',
limit: 50,
answers: {},
context: {},
asOf: '2023-12-25'
})
};
fetch('https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search', 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://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'programs' => [
[
'programId' => '<string>',
'version' => 1,
'title' => '<string>'
]
],
'path' => '<string>',
'query' => '',
'limit' => 50,
'answers' => [
],
'context' => [
],
'asOf' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search"
payload := strings.NewReader("{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"query\": \"\",\n \"limit\": 50,\n \"answers\": {},\n \"context\": {},\n \"asOf\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"query\": \"\",\n \"limit\": 50,\n \"answers\": {},\n \"context\": {},\n \"asOf\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"query\": \"\",\n \"limit\": 50,\n \"answers\": {},\n \"context\": {},\n \"asOf\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"choices": [
null
],
"noMatch": true,
"notAsked": [
{
"programId": "<string>",
"version": 1,
"reason": {
"code": "<string>",
"message": "<string>"
}
}
]
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"code": "business_rejection",
"error": "The program doesn't cover rideshare use.",
"businessCode": "RIDESHARE",
"violations": [
{
"code": "RIDESHARE",
"message": "The program doesn't cover rideshare use.",
"path": "Policy.vehicles[0].rideshare",
"value": true,
"constraint": "rideshare: where not self",
"cite": "manual:anchor \"eligibility\""
}
],
"violationsTruncated": false,
"requestId": "1793385750835-0"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}Market raters
Search the answers of a planning question
Find the answers of any planning question of kind search that match what the person typed, by the card’s path, across the same market rater versions as the plan. Search is the one lenient reading of what was typed; saving takes a listed value or label exactly.
Ranking: an exact label, an exact other name, a label that starts with the query, a label each typed word starts a word of, the same two for the other names, then a small misspelling (one edit for a word of four to seven letters, two from eight), nearer first. Ties keep the list’s own order. Case, spacing and punctuation are folded. When query holds a word and nothing matches, noMatch is true and choices holds the answers the query says in full and adds to, then the list’s catch-all answers.
Send answers when the question’s answers depend on earlier ones. Searching changes nothing, so the request is safe to repeat.
POST
/
insurance
/
rating-programs
/
search
Search the answers of a planning question
curl --request POST \
--url https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"programs": [
{
"programId": "<string>",
"version": 1,
"title": "<string>"
}
],
"path": "<string>",
"query": "",
"limit": 50,
"answers": {},
"context": {},
"asOf": "2023-12-25"
}
'import requests
url = "https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search"
payload = {
"programs": [
{
"programId": "<string>",
"version": 1,
"title": "<string>"
}
],
"path": "<string>",
"query": "",
"limit": 50,
"answers": {},
"context": {},
"asOf": "2023-12-25"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
programs: [{programId: '<string>', version: 1, title: '<string>'}],
path: '<string>',
query: '',
limit: 50,
answers: {},
context: {},
asOf: '2023-12-25'
})
};
fetch('https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search', 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://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'programs' => [
[
'programId' => '<string>',
'version' => 1,
'title' => '<string>'
]
],
'path' => '<string>',
'query' => '',
'limit' => 50,
'answers' => [
],
'context' => [
],
'asOf' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search"
payload := strings.NewReader("{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"query\": \"\",\n \"limit\": 50,\n \"answers\": {},\n \"context\": {},\n \"asOf\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"query\": \"\",\n \"limit\": 50,\n \"answers\": {},\n \"context\": {},\n \"asOf\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"query\": \"\",\n \"limit\": 50,\n \"answers\": {},\n \"context\": {},\n \"asOf\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"choices": [
null
],
"noMatch": true,
"notAsked": [
{
"programId": "<string>",
"version": 1,
"reason": {
"code": "<string>",
"message": "<string>"
}
}
]
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"code": "business_rejection",
"error": "The program doesn't cover rideshare use.",
"businessCode": "RIDESHARE",
"violations": [
{
"code": "RIDESHARE",
"message": "The program doesn't cover rideshare use.",
"path": "Policy.vehicles[0].rideshare",
"value": true,
"constraint": "rideshare: where not self",
"cite": "manual:anchor \"eligibility\""
}
],
"violationsTruncated": false,
"requestId": "1793385750835-0"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}Authorizations
Effective API key. Send Authorization: Bearer sk-eai-...
Body
application/json
The programs, each at the version this server rates with or at a pinned version. Each reads only the paths its own contract declares.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
The card’s path, such as Policy.drivers[0].occupation.
Maximum string length:
500Pattern:
^[A-Za-z_][A-Za-z0-9_]*(\[\d+\])*(\.[A-Za-z_][A-Za-z0-9_]*(\[\d+\])*)*$What the person typed.
Maximum string length:
200Required range:
1 <= x <= 100Every answer so far, when the card’s answers depend on earlier ones (a car’s model on its make). An answer stored at path is left out when the programs are rated.
Show child attributes
Show child attributes
The plan request’s context. Send what the plan was sent, so the card is searched in the answers the plan narrowed it to.
Show child attributes
Show child attributes
The plan request’s asOf.
Response
Up to limit answers, best first.
Each {value, label}, with catchAll where it stands for any answer the list does not name.
The programs that could not be asked: one that could not be read is asked nothing, and one that could not rate answers gave none of the choices they narrow. The match is the other programs’ alone, so an answer only these programs take reads as none. Absent when every program was asked.
Show child attributes
Show child attributes