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

# Create a shared type definition

> Super Admin only. Create a complete definition, its keyed fields and options atomically. Supply a stable caller-chosen id; repeating a successful request returns 409 rather than replacing it. Inspect that id with getTypeDefinition after an ambiguous response. No product profile changes or external effects.



## OpenAPI

````yaml /openapi.json post /insurance/types
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://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/types:
    post:
      tags:
        - Product types
      summary: Create a shared type definition
      description: >-
        Super Admin only. Create a complete definition, its keyed fields and
        options atomically. Supply a stable caller-chosen id; repeating a
        successful request returns 409 rather than replacing it. Inspect that id
        with getTypeDefinition after an ambiguous response. No product profile
        changes or external effects.
      operationId: createTypeDefinition
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2CreateTypeDefinition'
      responses:
        '201':
          description: Created definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TypeDefinition'
        '400':
          description: Invalid request or invalid_cursor; restart without cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Super Admin credentials required for writes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Type not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: Type ID already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: application/json required.
          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; honor Retry-After seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2CreateTypeDefinition:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 500
        label:
          type: string
          minLength: 1
          maxLength: 1000
        description:
          type: string
          nullable: true
          maxLength: 10000
        fields:
          type: object
          additionalProperties:
            type: object
            properties:
              label:
                type: string
                minLength: 1
                maxLength: 1000
              description:
                type: string
                nullable: true
                maxLength: 10000
              type:
                type: string
                minLength: 1
                maxLength: 500
              options:
                type: object
                additionalProperties:
                  type: object
                  properties:
                    label:
                      type: string
                      minLength: 1
                      maxLength: 1000
                    description:
                      type: string
                      maxLength: 10000
                  required:
                    - label
                  additionalProperties: false
            required:
              - label
              - type
            additionalProperties: false
          maxProperties: 1000
      required:
        - id
        - label
      additionalProperties: false
    V2TypeDefinition:
      allOf:
        - $ref: '#/components/schemas/V2TypeSummary'
        - type: object
          properties:
            fields:
              type: object
              additionalProperties:
                type: object
                properties:
                  label:
                    type: string
                  description:
                    type: string
                    nullable: true
                  type:
                    type: string
                  options:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        label:
                          type: string
                          minLength: 1
                          maxLength: 1000
                        description:
                          type: string
                          maxLength: 10000
                      required:
                        - label
                      additionalProperties: false
                  revision:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                required:
                  - label
                  - description
                  - type
                  - options
                  - revision
                additionalProperties: false
          required:
            - fields
          additionalProperties: false
    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.
            dataset:
              type: string
              enum:
                - naic
              description: Dataset needed for dataset_not_enabled.
          required:
            - code
    V2TypeSummary:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        description:
          type: string
          nullable: true
        revision:
          type: integer
          minimum: 0
          exclusiveMinimum: true
      required:
        - id
        - label
        - description
        - revision
      additionalProperties: false
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  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.