> ## Documentation Index
> Fetch the complete documentation index at: https://docs.go.aiinsurance.io/llms.txt
> Use this file to discover all available pages before exploring further.
# List Seed Options
> Lists the seed selection surface: the valid `starterSheet` variants accepted
by the **seed** and **seed/generate** endpoints — each with a human-readable
description and a marker for the one applied when `starterSheet` is omitted —
AND the full starter-**module** catalog (#3428) for the explicit `modules`
selection on **seed**. Each module carries its axis `group`, whether it is in
the default selection, and whether it is always on.
Both lists are sourced from a single in-code registry/catalog, so this
discovery surface can never drift from the names and module ids the seed
endpoints actually accept. Use it to discover the valid values before calling
`seed` or `seed/generate`, instead of probing with a bogus name and reading
the `400`.
**Required permission:** `company.configuration:export`
This endpoint requires an API key created with the **FMV1_CONFIGURATION_MANAGER** role.
See [Authentication](/api-reference/authentication) for how to create API keys with specific roles.
## OpenAPI
````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/configuration/seed/options
openapi: 3.0.3
info:
title: AI Insurance External API
description: External API for AI Insurance platform
version: 1.0.0
contact:
email: support@aiinsurance.io
servers:
- url: https://go.aiinsurance.io
description: Production
security:
- ApiKeyAuth: []
paths:
/api/v1/companies/{companyId}/configuration/seed/options:
get:
tags:
- FMV1 Configuration
summary: List Seed Options
description: >
Lists the seed selection surface: the valid `starterSheet` variants
accepted
by the **seed** and **seed/generate** endpoints — each with a
human-readable
description and a marker for the one applied when `starterSheet` is
omitted —
AND the full starter-**module** catalog (#3428) for the explicit
`modules`
selection on **seed**. Each module carries its axis `group`, whether it
is in
the default selection, and whether it is always on.
Both lists are sourced from a single in-code registry/catalog, so this
discovery surface can never drift from the names and module ids the seed
endpoints actually accept. Use it to discover the valid values before
calling
`seed` or `seed/generate`, instead of probing with a bogus name and
reading
the `400`.
**Required permission:** `company.configuration:export`
This endpoint requires an API key created with the
**FMV1_CONFIGURATION_MANAGER** role.
See [Authentication](/api-reference/authentication) for how to create
API keys with specific roles.
operationId: listFmv1ConfigurationSeedOptions
parameters:
- $ref: '#/components/parameters/companyId'
responses:
'200':
description: The valid starter variants and the default
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationSeedOptionsResponse'
examples:
success:
summary: Seed options
value:
defaultStarterSheet: single-exposure-list
options:
- name: default-rater
description: >-
Alias of single-exposure-list: single exposure-list
modeling with the default rater. Retained for backward
compatibility.
isDefault: false
- name: single-exposure-list
description: >-
Single exposure-list modeling (one embedded exposures
list per record with a calculated primary insured)
paired with the default rater. This is the product
default applied when starterSheet is omitted.
isDefault: true
- name: standalone-primary-insured
description: >-
Standalone primary-insured modeling: a written primary
insured plus additional standalone exposures. A
self-contained no-rating exposure scheme that keeps
its own null default rater.
isDefault: false
modules:
- id: core
label: Core
description: >-
Framework-required, non-configurable rows and the
canonical sheet structure. Required on every
configuration.
defaultSelected: true
group: always-on
alwaysOn: true
- id: default
label: Default
description: >-
Shared configurable rows that are identical regardless
of exposure scheme (fields, layout, option sets,
entity invariants).
defaultSelected: true
group: always-on
alwaysOn: true
- id: default-rater
label: Default Rater
description: >-
The default rating setup (rating axis). Composable
with an exposure scheme; mutually exclusive with
Example Rater and No-Rater Billing.
defaultSelected: true
group: rating
alwaysOn: false
- id: example-rater
label: Example Rater
description: >-
The same default rating setup, shipping both example
rating workflows side by side. Mutually exclusive with
Default Rater and No-Rater Billing.
defaultSelected: false
group: rating
alwaysOn: false
- id: policy-number-manual
label: Policy Number — Manual
description: >-
The policy number entered by the user as a required
text box. Mutually exclusive with the auto
policy-number flavor.
defaultSelected: true
group: policy-number
alwaysOn: false
- id: policy-number-auto
label: Policy Number — Auto
description: >-
The policy number auto-generated by the framework on
save and shown read-only. Mutually exclusive with the
manual policy-number flavor.
defaultSelected: false
group: policy-number
alwaysOn: false
- id: single-exposure
label: Single Exposure
description: >-
Exposure representation: one embedded exposures list
per record with a calculated primary insured. Pair
with a rater. Mutually exclusive with Standalone
Primary Insured.
defaultSelected: true
group: exposure-scheme
alwaysOn: false
- id: standalone-primary-insured
label: Standalone Primary Insured
description: >-
Exposure representation: a written primary insured
plus additional standalone exposures. A self-contained
no-rating scheme; mutually exclusive with Single
Exposure and both raters.
defaultSelected: false
group: exposure-scheme
alwaysOn: false
- id: no-rater-billing
label: No-Rater Billing
description: >-
A hardcoded default billing object for configurations
without a rater. Mutually exclusive with Default Rater
and Example Rater.
defaultSelected: false
group: feature
alwaysOn: false
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- BearerAuth: []
- ApiKeyAuth: []
components:
parameters:
companyId:
name: companyId
in: path
required: true
schema:
type: string
format: uuid
description: Company identifier
schemas:
ConfigurationSeedOptionsResponse:
type: object
description: >-
The valid `starterSheet` variants — each with a description and a
default marker — the default name applied when `starterSheet` is
omitted, AND the full starter-module catalog for the explicit `modules`
selection. All sourced from a single in-code registry/catalog, so they
cannot drift from what the seed endpoints accept.
required:
- defaultStarterSheet
- options
- modules
properties:
defaultStarterSheet:
type: string
description: The variant name applied when `starterSheet` is omitted.
options:
type: array
description: The valid starter variants, in registry order.
items:
$ref: '#/components/schemas/ConfigurationSeedOption'
modules:
type: array
description: >-
The selectable starter modules (checkbox granularity, #3428) a
caller can pass in the `modules` array on `POST
/configuration/seed`, in catalog order.
items:
$ref: '#/components/schemas/ConfigurationSeedModuleOption'
ConfigurationSeedOption:
type: object
description: A single starter variant accepted by the seed endpoints.
required:
- name
- description
- isDefault
properties:
name:
type: string
description: The value to send as `starterSheet` to seed or seed/generate.
description:
type: string
description: >-
A human-readable description of the modeling/rater axis this variant
selects.
isDefault:
type: boolean
description: Whether this variant is applied when `starterSheet` is omitted.
ConfigurationSeedModuleOption:
type: object
description: >-
One selectable starter module (checkbox granularity, #3428) a caller can
pass in the `modules` array on `POST /configuration/seed`. Projected
from the single in-code starter-module catalog, so this discovery
surface can never drift from what the seed endpoint accepts.
required:
- id
- label
- description
- defaultSelected
- group
- alwaysOn
properties:
id:
type: string
description: The wire value to send in the `modules` array.
label:
type: string
description: A human-readable label for the module.
description:
type: string
description: A human-readable description of what this module contributes.
defaultSelected:
type: boolean
description: >-
Whether this module is part of the default (product out-of-box)
selection — the one a `starterSheet` seed produces.
group:
type: string
description: >-
The pick-one axis this module belongs to, or the `always-on` /
`feature` group. Exactly one module may be selected per pick-one
axis (`exposure-scheme`, `rating`, `policy-number`); selecting two
modules from the same axis collides and fails with a `400`
(`InvalidModuleSelection`). `always-on` modules (`core`, `default`)
are always included regardless of selection; `feature` modules are
independently toggleable.
enum:
- always-on
- exposure-scheme
- rating
- policy-number
- feature
alwaysOn:
type: boolean
description: >-
Whether this module is always included regardless of selection
(`true` only for the `always-on` group — `core` and `default`).
ErrorResponse:
type: object
description: Standard error response for all external API endpoints
required:
- error
properties:
error:
type: object
required:
- code
- message
properties:
code:
type: string
description: Machine-readable error code
example: VALIDATION_ERROR
message:
type: string
description: Human-readable error message
example: 'submissionId: Required field is missing'
userMessages:
type: array
description: >-
Clean, verbatim-displayable messages — one entry per failure,
free of error-code tags, field paths, and internal noise.
Suitable for showing to end users as-is.
items:
type: string
example:
- Exposures of type 'company' require an address
details:
type: array
description: Additional details for validation errors (field-level errors)
items:
type: object
properties:
field:
type: string
description: The field that caused the error
example: submissionId
message:
type: string
description: Description of the field error
example: Required field is missing
responses:
Unauthorized:
description: Unauthorized - Invalid or missing API key
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
missingApiKey:
summary: Missing API key
value:
error:
code: AuthenticationError
message: API key authentication required
userMessages:
- API key authentication required
invalidApiKey:
summary: >-
Invalid API key (e.g. unknown key, or a Bearer token used
instead of an API key)
value:
error:
code: AuthenticationError
message: Invalid API key
userMessages:
- Invalid API key
Forbidden:
description: Forbidden - Insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
insufficientPermissions:
summary: Insufficient permissions
value:
error:
code: AuthorizationError
message: User is not authorized to perform the requested action
userMessages:
- User is not authorized to perform the requested action
companyMismatch:
summary: A valid API key naming another company in the URL
value:
error:
code: AuthorizationError
message: API key is not scoped to the requested company
userMessages:
- API key is not scoped to the requested company
InternalServerError:
description: Internal Server Error - Unexpected error occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
internalError:
summary: Unexpected server error
value:
error:
code: UncaughtActionError
message: Uncaught error occurred in
userMessages:
- An unexpected error occurred. Please try again later.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Authorization
description: >-
API key authentication. Send your raw API key as the `Authorization`
header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
header; those are not accepted.
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0
access token (audience = the app API audience) as `Authorization: Bearer
`. 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`.
````