Bareun AI API

openapi: 3.1.0
info:
  title: Bareun AI API
  version: '2026-11-02'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-02: 19 operation(s) read from 8 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Bareun AI has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 19
    documentation: 0
    pages-with-code: 7
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-02'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://bareun.ai/docs/howtouse/rest-api.md
  - https://bareun.ai/docs/howtouse/homonym-sense.md
  - https://bareun.ai/docs/compare/spellcheck-apis.md
  - https://bareun.ai/docs/howtouse/api-dict-search.md
  - https://bareun.ai/docs/howtouse/integration/cli.md
  - https://bareun.ai/docs/howtouse/before-30-rc3/rest-api.md
  - https://bareun.ai/docs/howtouse/integration/apikey-ops.md
  - https://bareun.ai/docs/howtouse/integration/protocol-choice.md
servers:
- url: https://api.bareun.ai
paths:
  /bareun.CustomDictionaryService/CheckConflict:
    post:
      operationId: post_bareun_CustomDictionaryService_CheckConflict
      tags:
      - Bareun
      summary: POST /bareun.CustomDictionaryService/CheckConflict
      x-source: https://bareun.ai/docs/howtouse/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunCustomdictionaryserviceCheckconflictRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -H \"api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321\"  -H \"Content-Type: application/json\"  -X POST https://api.bareun.ai/bareun.CustomDictionaryService/CheckConflict\
          \  -d '{\"domain_names\": [\"compare1\", \"compare2\"]}'\n    ```"
  /bareun.CustomDictionaryService/GetCustomDictionary:
    post:
      operationId: post_bareun_CustomDictionaryService_GetCustomDictionary
      tags:
      - Bareun
      summary: POST /bareun.CustomDictionaryService/GetCustomDictionary
      x-source: https://bareun.ai/docs/howtouse/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunCustomdictionaryserviceGetcustomdictionaryRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -H \"api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321\"  -H \"Content-Type: application/json\"  -X POST https://api.bareun.ai/bareun.CustomDictionaryService/GetCustomDictionary\
          \  -d '{ \"domain_name\": \"mydomain\"}'\n    ```"
  /bareun.CustomDictionaryService/GetCustomDictionaryList:
    post:
      operationId: post_bareun_CustomDictionaryService_GetCustomDictionaryList
      tags:
      - Bareun
      summary: POST /bareun.CustomDictionaryService/GetCustomDictionaryList
      x-source: https://bareun.ai/docs/howtouse/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -H \"api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321\"  -H \"Content-Type: application/json\"  -X POST https://api.bareun.ai/bareun.CustomDictionaryService/GetCustomDictionaryList\
          \  -d '{}'\n    ```"
  /bareun.CustomDictionaryService/RemoveCustomDictionaries:
    post:
      operationId: post_bareun_CustomDictionaryService_RemoveCustomDictionaries
      tags:
      - Bareun
      summary: POST /bareun.CustomDictionaryService/RemoveCustomDictionaries
      x-source: https://bareun.ai/docs/howtouse/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunCustomdictionaryserviceRemovecustomdictionariesReq'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -H \"api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321\"  -H \"Content-Type: application/json\"  -X POST https://api.bareun.ai/bareun.CustomDictionaryService/RemoveCustomDictionaries\
          \  -d '{\"domain_names\": [\"mydomain\"],\"all\": true}'\n    ```"
  /bareun.CustomDictionaryService/UpdateCustomDictionary:
    post:
      operationId: post_bareun_CustomDictionaryService_UpdateCustomDictionary
      tags:
      - Bareun
      summary: POST /bareun.CustomDictionaryService/UpdateCustomDictionary
      x-source: https://bareun.ai/docs/howtouse/rest-api.md
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl  -H "api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321"  -H "Content-Type: application/json"  -X POST https://api.bareun.ai/bareun.CustomDictionaryService/UpdateCustomDictionary  -d
          ''{ "domain_name": "mydomain",  "dict":  {"domain_name": "mydomain",  "np_set": {  "items": {  "광화문": 1  "숭례문": 1  "흥인지문": 1  }, "type":
          "WORD_LIST", "name": "np_set"},  "cp_set": {  "items": { "논밭": 1  "봄비": 1  "자유여행"'
  /bareun.DictSearchService/SearchDict:
    post:
      operationId: post_bareun_DictSearchService_SearchDict
      tags:
      - Bareun
      summary: POST /bareun.DictSearchService/SearchDict
      x-source: https://bareun.ai/docs/howtouse/api-dict-search.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunDictsearchserviceSearchdictRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s -X POST https://api.bareun.ai/bareun.DictSearchService/SearchDict  -H \"api-key: <API-KEY>\"  -H \"Content-Type: application/json\"\
          \  -d '{\n        \"pattern\": \"아지\",\n        \"anchor\": \"DICT_SEARCH_ANCHOR_SUFFIX\",\n        \"pos\": [\"명사\"],\n        \"std_only\"\
          : true,\n        \"with_definition\": true,\n        \"limit\": 20\n      }'\n    ```"
  /bareun.LanguageService/AnalyzeSyntax:
    post:
      operationId: post_bareun_LanguageService_AnalyzeSyntax
      tags:
      - Bareun
      summary: POST /bareun.LanguageService/AnalyzeSyntax
      x-source: https://bareun.ai/docs/howtouse/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunLanguageserviceAnalyzesyntaxRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -H \"api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321\"  -H \"Content-Type: application/json\"  -X POST https://api.bareun.ai/bareun.LanguageService/AnalyzeSyntax\
          \  -d '{\"document\": {\"content\": \"안녕하세요. 반가워요.\",\"language\": \"ko-KR\"}, \"encoding_type\": \"UTF8\", \"custom_dict_names\": [\"\
          testDomain\"]}'\n    ```"
  /bareun.LanguageService/AnalyzeSyntaxList:
    post:
      operationId: post_bareun_LanguageService_AnalyzeSyntaxList
      tags:
      - Bareun
      summary: POST /bareun.LanguageService/AnalyzeSyntaxList
      x-source: https://bareun.ai/docs/howtouse/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunLanguageserviceAnalyzesyntaxlistRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -H \"api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321\"  -H \"Content-Type: application/json\"  -X POST https://api.bareun.ai/bareun.LanguageService/AnalyzeSyntaxList\
          \  -d '{\"document\": {\"sentences\": ['안녕하세요.', '바른 형태소분석기입니다.', '만나서 반갑습니다.'], \"language\": \"ko-KR\"}, \"encoding_type\": \"UTF8\"\
          , \"custom_dict_names\": [\"testDomain\"]}'\n    ```"
  /bareun.LanguageService/Tokenize:
    post:
      operationId: post_bareun_LanguageService_Tokenize
      tags:
      - Bareun
      summary: POST /bareun.LanguageService/Tokenize
      x-source: https://bareun.ai/docs/howtouse/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunLanguageserviceTokenizeRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -H \"api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321\"  -H \"Content-Type: application/json\"  -X POST https://api.bareun.ai/bareun.LanguageService/Tokenize\
          \  -d '{\"document\": {\"content\": \"안녕하세요. 반가워요.\",\"language\": \"ko-KR\"}, \"encoding_type\": \"UTF8\"}'\n    ```"
  /bareun.RevisionService/CorrectError:
    post:
      operationId: post_bareun_RevisionService_CorrectError
      tags:
      - Bareun
      summary: POST /bareun.RevisionService/CorrectError
      x-source: https://bareun.ai/docs/howtouse/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunRevisionserviceCorrecterrorRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -H \"api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321\"  -H \"Content-Type: application/json\"  -X POST https://api.bareun.ai/bareun.RevisionService/CorrectError\
          \  -d '{\"document\": {\"content\": \"밥이 떡처럼 되서 못먹었어요\",\"language\": \"ko-KR\"}, \"encoding_type\": \"UTF32\", \"custom_dict_names\"\
          : [\"testDomain\"]}'\n    ```"
  /bareun/api/v1/analyze:
    post:
      operationId: post_bareun_api_v1_analyze
      tags:
      - Bareun
      summary: POST /bareun/api/v1/analyze
      x-source: https://bareun.ai/docs/howtouse/before-30-rc3/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunApiV1AnalyzeRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321"  -X POST http://localhost:5656/bareun/api/v1/analyze  -d ''{"document":
          {"content": "안녕하세요. 반가워요.","language": "ko-KR"}, "encoding_type": "UTF8", "custom_dict_names": ["testDomain"]}''

          ```'
  /bareun/api/v1/analyze-list:
    post:
      operationId: post_bareun_api_v1_analyze_list
      tags:
      - Bareun
      summary: POST /bareun/api/v1/analyze-list
      x-source: https://bareun.ai/docs/howtouse/before-30-rc3/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunApiV1AnalyzeListRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321"  -X POST http://localhost:5656/bareun/api/v1/analyze-list  -d ''{"document":
          {"sentences": [''안녕하세요.'', ''바른 형태소분석기입니다.'', ''만나서 반갑습니다.''], "language": "ko-KR"}, "encoding_type": "UTF8", "custom_dict_names": ["testDomain"]}''

          ```'
  /bareun/api/v1/correct-error:
    post:
      operationId: post_bareun_api_v1_correct_error
      tags:
      - Bareun
      summary: POST /bareun/api/v1/correct-error
      x-source: https://bareun.ai/docs/howtouse/before-30-rc3/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunApiV1CorrectErrorRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321"  -X POST http://localhost:5656/bareun/api/v1/correct-error  -d ''{"document":
          {"content": "밥이 떡처럼 되서 못먹었어요","language": "ko-KR"}, "encoding_type": "UTF32", "custom_dict_names": ["testDomain"]}''

          ```'
  /bareun/api/v1/customdict:
    get:
      operationId: get_bareun_api_v1_customdict
      tags:
      - Bareun
      summary: GET /bareun/api/v1/customdict
      x-source: https://bareun.ai/docs/howtouse/before-30-rc3/rest-api.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl  -H "api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321"  http://localhost:5656/bareun/api/v1/customdict

          ```'
  /bareun/api/v1/customdict/check-conflict:
    post:
      operationId: post_bareun_api_v1_customdict_check_conflict
      tags:
      - Bareun
      summary: POST /bareun/api/v1/customdict/check-conflict
      x-source: https://bareun.ai/docs/howtouse/before-30-rc3/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunApiV1CustomdictCheckConflictRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321"  -X POST http://localhost:5656/bareun/api/v1/customdict/check-conflict  -d
          ''{"domain_names": ["compare1", "compare2"]}''

          ```'
  /bareun/api/v1/customdict/delete:
    post:
      operationId: post_bareun_api_v1_customdict_delete
      tags:
      - Bareun
      summary: POST /bareun/api/v1/customdict/delete
      x-source: https://bareun.ai/docs/howtouse/before-30-rc3/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunApiV1CustomdictDeleteRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321"  -X POST http://localhost:5656/bareun/api/v1/customdict/delete  -d ''{"domain_names":
          ["mydomain"],"all": true}''

          ```'
  /bareun/api/v1/customdict/mydomain:
    get:
      operationId: get_bareun_api_v1_customdict_mydomain
      tags:
      - Bareun
      summary: GET /bareun/api/v1/customdict/mydomain
      x-source: https://bareun.ai/docs/howtouse/before-30-rc3/rest-api.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl   -H "api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321"  http://localhost:5656/bareun/api/v1/customdict/mydomain

          ```'
    post:
      operationId: post_bareun_api_v1_customdict_mydomain
      tags:
      - Bareun
      summary: POST /bareun/api/v1/customdict/mydomain
      x-source: https://bareun.ai/docs/howtouse/before-30-rc3/rest-api.md
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl  -H "api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321"  -X POST http://localhost:5656/bareun/api/v1/customdict/mydomain  -d
          ''{ "domain_name": "mydomain",  "dict":  {"domain_name": "mydomain",  "np_set": {  "items": {  "광화문": 1  "숭례문": 1  "흥인지문": 1  }, "type":
          "WORD_LIST", "name": "np_set"},  "cp_set": {  "items": { "논밭": 1  "봄비": 1  "자유여행": 1  }, "type": "WORD_LIST", "name": "cp_set"}, "cp_caret'
  /bareun/api/v1/tokenize:
    post:
      operationId: post_bareun_api_v1_tokenize
      tags:
      - Bareun
      summary: POST /bareun/api/v1/tokenize
      x-source: https://bareun.ai/docs/howtouse/before-30-rc3/rest-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBareunApiV1TokenizeRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "api-key: koba-ABCDEFG-1234567-LMNOPQR-7654321"  -X POST http://localhost:5656/bareun/api/v1/tokenize  -d ''{"document":
          {"content": "안녕하세요. 반가워요.","language": "ko-KR"}, "encoding_type": "UTF8"}''

          ```'
components:
  schemas:
    PostBareunCustomdictionaryserviceCheckconflictRequest:
      type: object
      properties:
        domain_names:
          type: array
          items:
            type: string
    PostBareunCustomdictionaryserviceGetcustomdictionaryRequest:
      type: object
      properties:
        domain_name:
          type: string
    PostBareunCustomdictionaryserviceRemovecustomdictionariesReq:
      type: object
      properties:
        domain_names:
          type: array
          items:
            type: string
        all:
          type: boolean
    PostBareunDictsearchserviceSearchdictRequest:
      type: object
      properties:
        pattern:
          type: string
        anchor:
          type: string
        pos:
          type: array
          items:
            type: string
        std_only:
          type: boolean
        with_definition:
          type: boolean
        limit:
          type: integer
    PostBareunLanguageserviceAnalyzesyntaxRequest:
      type: object
      properties:
        document:
          type: object
          properties:
            content:
              type: string
            language:
              type: string
        encoding_type:
          type: string
        custom_dict_names:
          type: array
          items:
            type: string
    PostBareunLanguageserviceAnalyzesyntaxlistRequest:
      type: object
      properties:
        document:
          type: object
          properties:
            sentences:
              type: array
              items:
                type: string
            language:
              type: string
        encoding_type:
          type: string
        custom_dict_names:
          type: array
          items:
            type: string
    PostBareunLanguageserviceTokenizeRequest:
      type: object
      properties:
        document:
          type: object
          properties:
            content:
              type: string
            language:
              type: string
        encoding_type:
          type: string
    PostBareunRevisionserviceCorrecterrorRequest:
      type: object
      properties:
        document:
          type: object
          properties:
            content:
              type: string
            language:
              type: string
        encoding_type:
          type: string
        custom_dict_names:
          type: array
          items:
            type: string
    PostBareunApiV1AnalyzeRequest:
      type: object
      properties:
        document:
          type: object
          properties:
            content:
              type: string
            language:
              type: string
        encoding_type:
          type: string
        custom_dict_names:
          type: array
          items:
            type: string
    PostBareunApiV1AnalyzeListRequest:
      type: object
      properties:
        document:
          type: object
          properties:
            sentences:
              type: array
              items:
                type: string
            language:
              type: string
        encoding_type:
          type: string
        custom_dict_names:
          type: array
          items:
            type: string
    PostBareunApiV1CorrectErrorRequest:
      type: object
      properties:
        document:
          type: object
          properties:
            content:
              type: string
            language:
              type: string
        encoding_type:
          type: string
        custom_dict_names:
          type: array
          items:
            type: string
    PostBareunApiV1CustomdictCheckConflictRequest:
      type: object
      properties:
        domain_names:
          type: array
          items:
            type: string
    PostBareunApiV1CustomdictDeleteRequest:
      type: object
      properties:
        domain_names:
          type: array
          items:
            type: string
        all:
          type: boolean
    PostBareunApiV1TokenizeRequest:
      type: object
      properties:
        document:
          type: object
          properties:
            content:
              type: string
            language:
              type: string
        encoding_type:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: api-key
security:
- apiKey: []
tags:
- name: Bareun