> ## Documentation Index
> Fetch the complete documentation index at: https://dev.writer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add terms

<Warning>
  We're deprecating these API endpoints, so the AI Studio API key setup won't work. \[Contact support] ([https://support.writer.com/](https://support.writer.com/)) if you need them.
</Warning>


## OpenAPI

````yaml post /terminology/organization/{organizationId}/team/{teamId}
openapi: 3.0.3
info:
  title: Writer Enterprise API
  version: '1.9'
servers:
  - url: https://enterprise-api.writer.com
security: []
tags:
  - name: content
    description: Content
  - name: snippet
    description: Snippet
  - name: coWrite
    description: CoWrite
  - name: user
    description: User
  - name: terminology
    description: Terminology
  - name: LLM
    description: LLM
  - name: billing
    description: Billing
  - name: styleguide
    description: Styleguide
paths:
  /terminology/organization/{organizationId}/team/{teamId}:
    post:
      tags:
        - terminology
      summary: Add terms
      operationId: addTerms
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
        - name: organizationId
          in: path
          required: true
          schema:
            type: integer
            format: int64
        - name: teamId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTermsRequest'
        required: true
      responses:
        '200':
          description: ''
          headers:
            Action-Id:
              required: true
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTermsResponse'
        '400':
          description: Bad Request
          headers:
            Action-Id:
              required: true
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
        '401':
          description: Unauthorized
          headers:
            Action-Id:
              required: true
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
        '403':
          description: Forbidden
          headers:
            Action-Id:
              required: true
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
        '404':
          description: Not Found
          headers:
            Action-Id:
              required: true
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
        '500':
          description: Internal Server Error
          headers:
            Action-Id:
              required: true
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
components:
  schemas:
    CreateTermsRequest:
      type: object
      properties:
        models:
          type: array
          items:
            $ref: '#/components/schemas/TermCreate'
        failHandling:
          type: string
          enum:
            - accumulate
            - validate
            - skip
            - validateOnly
    CreateTermsResponse:
      type: object
      properties:
        models:
          type: array
          items:
            $ref: '#/components/schemas/FullTermWithUser'
        fails:
          type: array
          items:
            $ref: '#/components/schemas/FailMessage'
    FailResponse:
      required:
        - tpe
        - extras
      type: object
      properties:
        tpe:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FailMessage'
        extras:
          $ref: '#/components/schemas/Json'
    TermCreate:
      required:
        - term
        - type
        - caseSensitive
      type: object
      properties:
        reference:
          type: string
        term:
          type: string
        type:
          type: string
          enum:
            - approved
            - banned
            - pending
        pos:
          type: string
          enum:
            - noun
            - verb
            - adverb
            - adjective
        caseSensitive:
          type: boolean
        description:
          type: string
        highlight:
          type: boolean
        examples:
          type: array
          items:
            $ref: '#/components/schemas/TermExampleCreate'
        mistakes:
          type: array
          items:
            $ref: '#/components/schemas/TermMistakeCreate'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TermTagCreate'
        linkedTerms:
          type: array
          items:
            $ref: '#/components/schemas/LinkedTermCreate'
        approvedTermExtension:
          $ref: '#/components/schemas/ApprovedTermExtensionCreate'
    FullTermWithUser:
      required:
        - id
        - termBankId
        - term
        - type
        - caseSensitive
        - highlight
        - creationTime
        - modificationTime
        - createdUser
        - modifiedUser
      type: object
      properties:
        id:
          type: integer
          format: int64
        termBankId:
          type: integer
          format: int64
        term:
          type: string
        type:
          type: string
          enum:
            - approved
            - banned
            - pending
        pos:
          type: string
          enum:
            - noun
            - verb
            - adverb
            - adjective
        caseSensitive:
          type: boolean
        description:
          type: string
        highlight:
          type: boolean
        creationTime:
          type: string
          format: date-time
        modificationTime:
          type: string
          format: date-time
        createdUser:
          $ref: '#/components/schemas/TerminologyUser'
        modifiedUser:
          $ref: '#/components/schemas/TerminologyUser'
        examples:
          type: array
          items:
            $ref: '#/components/schemas/TermExample'
        mistakes:
          type: array
          items:
            $ref: '#/components/schemas/TermMistake'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TermTagResponse'
        linkedTerms:
          type: array
          items:
            $ref: '#/components/schemas/FullLinkedTerm'
        backlinkedTerms:
          type: array
          items:
            $ref: '#/components/schemas/FullLinkedTerm'
        approvedTermExtension:
          $ref: '#/components/schemas/ApprovedTermExtension'
    FailMessage:
      required:
        - description
        - key
        - extras
      type: object
      properties:
        description:
          type: string
        key:
          type: string
        extras:
          $ref: '#/components/schemas/Json'
    Json: {}
    TermExampleCreate:
      required:
        - example
        - type
      type: object
      properties:
        example:
          type: string
        type:
          type: string
          enum:
            - good
            - bad
    TermMistakeCreate:
      required:
        - mistake
        - caseSensitive
      type: object
      properties:
        reference:
          type: string
        mistake:
          type: string
        pos:
          type: string
          enum:
            - noun
            - verb
            - adverb
            - adjective
        caseSensitive:
          type: boolean
    TermTagCreate:
      required:
        - tag
      type: object
      properties:
        tag:
          type: string
    LinkedTermCreate:
      type: object
      properties:
        reference:
          type: string
        linkedTermId:
          type: integer
          format: int64
    ApprovedTermExtensionCreate:
      required:
        - capitalize
        - fixCommonMistakes
        - fixCase
      type: object
      properties:
        capitalize:
          type: boolean
        fixCommonMistakes:
          type: boolean
        fixCase:
          type: boolean
    TerminologyUser:
      required:
        - id
      type: object
      properties:
        id:
          type: integer
          format: int64
        fullName:
          type: string
        email:
          type: string
    TermExample:
      required:
        - termId
        - termBankId
        - example
        - type
      type: object
      properties:
        id:
          type: integer
          format: int64
        termId:
          type: integer
          format: int64
        termBankId:
          type: integer
          format: int64
        example:
          type: string
        type:
          type: string
          enum:
            - good
            - bad
    TermMistake:
      required:
        - termId
        - termBankId
        - mistake
        - caseSensitive
      type: object
      properties:
        id:
          type: integer
          format: int64
        termId:
          type: integer
          format: int64
        termBankId:
          type: integer
          format: int64
        mistake:
          type: string
        pos:
          type: string
          enum:
            - noun
            - verb
            - adverb
            - adjective
        caseSensitive:
          type: boolean
    TermTagResponse:
      required:
        - id
        - tag
        - termId
        - parentTagId
      type: object
      properties:
        id:
          type: integer
          format: int64
        tag:
          type: string
        termId:
          type: integer
          format: int64
        parentTagId:
          type: integer
          format: int64
    FullLinkedTerm:
      required:
        - termId
        - linkedTermId
        - term
        - caseSensitive
      type: object
      properties:
        id:
          type: integer
          format: int64
        termId:
          type: integer
          format: int64
        linkedTermId:
          type: integer
          format: int64
        term:
          type: string
        pos:
          type: string
          enum:
            - noun
            - verb
            - adverb
            - adjective
        caseSensitive:
          type: boolean
        approvedTermExtension:
          $ref: '#/components/schemas/ApprovedTermExtension'
    ApprovedTermExtension:
      required:
        - termId
        - capitalize
        - fixCommonMistakes
        - fixCase
      type: object
      properties:
        id:
          type: integer
          format: int64
        termId:
          type: integer
          format: int64
        capitalize:
          type: boolean
        fixCommonMistakes:
          type: boolean
        fixCase:
          type: boolean

````