---
title: "POST /v2/messages"
method: POST
path: "/v2/messages"
tags: ["Messages"]
---

# POST /v2/messages

`POST /v2/messages`

## Request

- Base URL: `https://glass.health/api/external`
- URL: `https://glass.health/api/external/v2/messages`
- Auth: API key in header `X-Api-Key`

Generate a message with an explicit version.

## Request body

- object
  - `messages` object[], required
    - `role` 'user' | 'assistant', required
    - `content` string, required
  - `stream` boolean
  - `metadata` object
  - `response_format` object
    - `type` 'json_object', required
  - `version` '5.0-2025-08-22' | '5.5-2026-03-31', required
  - `fileUploadIds` string[]

## Response `200`

Successful response body

- union
  - object
    - `id` string, required
    - `metadata` object
    - `role` 'assistant', required
    - `text` string
    - `usage` object, required
      - `inputTokens` number, required
      - `outputTokens` number, required
    - `references` union[]
      - union
        - object
          - `index` number, required
          - `type` 'literature', required
          - `id` string, required
          - `doc_id` string, required
          - `url` string, required
          - `title` string, required
          - `journal_title` string, required
          - `year` number, required
          - `pub_date` string, nullable, required
          - `doi` string, nullable, required
          - `authors` string, nullable, required
          - `types` string[], required
          - `is_high_impact_journal` boolean
          - `is_highly_cited_article` boolean
          - `is_recently_published` boolean
          - `pmid` number, nullable
          - `authors_structured` object[], required
            - `first_name` string, nullable
            - `last_name` string, required
            - `initials` string, nullable
          - `display` object, required
            - `heading` string, required
            - `subheading` string, nullable, required
            - `authors` string, nullable, required
            - `detail` string, nullable, required
          - `locator` object, nullable, required
            - `page` number, nullable, required
            - `section` string, nullable, required
            - `chunkIndex` number, nullable, required
            - `chunkCount` number, nullable, required
        - object
          - `index` number, required
          - `type` 'compound', required
          - `id` string, required
          - `doc_id` string, required
          - `url` string, required
          - `generic_name` string, required
          - `manufactured_name` string, required
          - `effective_time` string, required
          - `display` object, required
            - `heading` string, required
            - `subheading` string, nullable, required
            - `detail` string, nullable, required
          - `locator` object, nullable, required
            - `page` number, nullable, required
            - `section` string, nullable, required
            - `chunkIndex` number, nullable, required
            - `chunkCount` number, nullable, required
        - object
          - `index` number, required
          - `type` 'billing_code', required
          - `id` string, required
          - `doc_id` string, required
          - `url` string, required
          - `code` string, required
          - `code_system` 'icd-10-cm' | 'hcpcs', required
          - `description` string, required
          - `is_billable` boolean, required
          - `display` object, required
            - `heading` string, required
            - `subheading` string, nullable, required
            - `detail` string, nullable, required
          - `locator` object, nullable, required
            - `page` number, nullable, required
            - `section` string, nullable, required
            - `chunkIndex` number, nullable, required
            - `chunkCount` number, nullable, required
        - object
          - `index` number, required
          - `type` 'context_library_file', required
          - `id` string, required
          - `doc_id` string, required
          - `url` string, required
          - `display` object, required
            - `heading` string, required
            - `subheading` string, nullable, required
            - `detail` string, nullable, required
          - `locator` object, nullable, required
            - `page` number, nullable, required
            - `section` string, nullable, required
            - `chunkIndex` number, nullable, required
            - `chunkCount` number, nullable, required
          - `context_library_id` string, required
          - `file_id` string, required
          - `file_name` string, required
          - `media_type` string, required
    - `progress` union[]
      - union
        - object
          - `step` 'retrievalQueryGeneration' | 'retrieval' | 'outputGeneration' | 'metricEvaluation', required
        - object
          - `step` 'sendProgressUpdate', required
          - `text` string, required
  - object
    - `id` string, required
    - `metadata` object
    - `role` 'assistant', required
    - `error` object, required
      - `errorCode` 'tokens_exceeded' | 'unknown' | 'invalid_json', required
    - `text` string
    - `usage` object, required
      - `inputTokens` number, required
      - `outputTokens` number, required
    - `progress` union[]
      - union
        - object
          - `step` 'retrievalQueryGeneration' | 'retrieval' | 'outputGeneration' | 'metricEvaluation', required
        - object
          - `step` 'sendProgressUpdate', required
          - `text` string, required
    - `references` union[]
      - union
        - object
          - `index` number, required
          - `type` 'literature', required
          - `id` string, required
          - `doc_id` string, required
          - `url` string, required
          - `title` string, required
          - `journal_title` string, required
          - `year` number, required
          - `pub_date` string, nullable, required
          - `doi` string, nullable, required
          - `authors` string, nullable, required
          - `types` string[], required
          - `is_high_impact_journal` boolean
          - `is_highly_cited_article` boolean
          - `is_recently_published` boolean
          - `pmid` number, nullable
          - `authors_structured` object[], required
            - `first_name` string, nullable
            - `last_name` string, required
            - `initials` string, nullable
          - `display` object, required
            - `heading` string, required
            - `subheading` string, nullable, required
            - `authors` string, nullable, required
            - `detail` string, nullable, required
          - `locator` object, nullable, required
            - `page` number, nullable, required
            - `section` string, nullable, required
            - `chunkIndex` number, nullable, required
            - `chunkCount` number, nullable, required
        - object
          - `index` number, required
          - `type` 'compound', required
          - `id` string, required
          - `doc_id` string, required
          - `url` string, required
          - `generic_name` string, required
          - `manufactured_name` string, required
          - `effective_time` string, required
          - `display` object, required
            - `heading` string, required
            - `subheading` string, nullable, required
            - `detail` string, nullable, required
          - `locator` object, nullable, required
            - `page` number, nullable, required
            - `section` string, nullable, required
            - `chunkIndex` number, nullable, required
            - `chunkCount` number, nullable, required
        - object
          - `index` number, required
          - `type` 'billing_code', required
          - `id` string, required
          - `doc_id` string, required
          - `url` string, required
          - `code` string, required
          - `code_system` 'icd-10-cm' | 'hcpcs', required
          - `description` string, required
          - `is_billable` boolean, required
          - `display` object, required
            - `heading` string, required
            - `subheading` string, nullable, required
            - `detail` string, nullable, required
          - `locator` object, nullable, required
            - `page` number, nullable, required
            - `section` string, nullable, required
            - `chunkIndex` number, nullable, required
            - `chunkCount` number, nullable, required
        - object
          - `index` number, required
          - `type` 'context_library_file', required
          - `id` string, required
          - `doc_id` string, required
          - `url` string, required
          - `display` object, required
            - `heading` string, required
            - `subheading` string, nullable, required
            - `detail` string, nullable, required
          - `locator` object, nullable, required
            - `page` number, nullable, required
            - `section` string, nullable, required
            - `chunkIndex` number, nullable, required
            - `chunkCount` number, nullable, required
          - `context_library_id` string, required
          - `file_id` string, required
          - `file_name` string, required
          - `media_type` string, required

## Other responses

- `401`: Unauthorized
- `422`: Request validation error
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/glass/apis/glass-health-api.md) - [All operations](https://skmtc.dev/glass/apis/glass-health-api/llms.txt) - [OpenAPI document](https://skmtc.dev/glass/apis/glass-health-api/revisions/0417e5333583?raw)
