Describe Configuration (run-down)

curl --request POST \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe"

payload = {}
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({})
};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe', 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://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe",
  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([
    
  ]),
  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://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe"

	payload := strings.NewReader("{}")

	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://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe")

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 = "{}"

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

{
  "revision": "3f8a1c0d9b7e5a24c6f1e8d20b3a49c7d5e6f80a1b2c3d4e5f60718293a4b5e2",
  "entities": [
    {
      "key": "Exposure",
      "description": "The insurable thing a policy covers; the shared hub.",
      "fieldCount": 13
    },
    {
      "key": "Quote",
      "description": "A priced offer that belongs to a submission.",
      "fieldCount": 31
    }
  ],
  "customObjects": [
    {
      "key": "Coverage",
      "name": "Coverage",
      "fieldCount": 11
    }
  ],
  "optionSets": [
    {
      "name": "Exposure Types",
      "optionCount": 2
    }
  ]
}

Inspect

Describe Configuration (run-down)

Returns the configuration run-down — a small orientation summary of the company’s FMV1 configuration: every top-level entity (with a one-line description and field count), every custom object (with its name and sub-field count), and every option set (with its option count), plus a revision string identifying the stored configuration.

This is the first read for an automated config editor: call describe to learn what exists, then the per-entity describe endpoint (describe/{entityOrObjectKey}) to see one entity’s or custom object’s fields. It does not list individual fields.

The run-down reads the whole configuration from the database (resolved from the API key’s tenant), so the request needs no body — POST an empty object.

Required permission: company.configuration:export

This endpoint requires an API key created with the FMV1_CONFIGURATION_MANAGER or CARRIER_ADMIN role. See Authentication for how to create API keys with specific roles.

POST

api

companies

{companyId}

configuration

describe

Describe Configuration (run-down)

curl --request POST \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe"

payload = {}
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({})
};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe', 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://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe",
  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([
    
  ]),
  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://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe"

	payload := strings.NewReader("{}")

	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://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/describe")

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 = "{}"

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

{
  "revision": "3f8a1c0d9b7e5a24c6f1e8d20b3a49c7d5e6f80a1b2c3d4e5f60718293a4b5e2",
  "entities": [
    {
      "key": "Exposure",
      "description": "The insurable thing a policy covers; the shared hub.",
      "fieldCount": 13
    },
    {
      "key": "Quote",
      "description": "A priced offer that belongs to a submission.",
      "fieldCount": 31
    }
  ],
  "customObjects": [
    {
      "key": "Coverage",
      "name": "Coverage",
      "fieldCount": 11
    }
  ],
  "optionSets": [
    {
      "name": "Exposure Types",
      "optionCount": 2
    }
  ]
}

Authorizations

Authorization

string

header

required

User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as Authorization: Bearer <jwt>. The request resolves to the user's identity and is authorized by their Role on the {companyId} in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both BearerAuth and ApiKeyAuth.

Path Parameters

companyId

string<uuid>

required

Company identifier

Body

application/json

No input is required — an empty object (or no body) is accepted.

Response

The configuration run-down.

The configuration run-down — a small orientation summary of the company's FMV1 configuration. Lists every top-level entity, custom object, and option set with a count; it does not list individual fields (use the per-entity describe endpoint for those).

revision

string

required

Identifies the exact stored configuration this run-down was built from (a hash over the full config body; the same token the patch optimistic-concurrency check uses as baseRevision).

entities

object[]

required

The fixed top-level entities, each with its field count.

Show child attributes

customObjects

object[]

required

The company's custom objects, each with its sub-field count.

Show child attributes

optionSets

object[]

required

The company's option sets, each with its option count and lock state.

Show child attributes

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

Describe Configuration (run-down)

Authorizations

Path Parameters

Body

Response