Junction

Junction Compendium API

The compendium API from Vital — 2 operation(s) for compendium.

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v3/compendium/search Search the lab test compendium · Search Compendium #
Ask an LLM
“Can I find orderable lab tests in the compendium by CPT code?”
“Which compendium entries match a test name across several labs?”
Tell an agent
Search the compendium in {mode} mode for {query}.
Look up compendium entries for CPT codes {cpt_codes} at labs {labs}, returning at most {limit}.
POST /v3/compendium/convert Convert a lab test to another lab's equivalent · Convert Compendium #
Ask an LLM
“Can I map a lab test to the equivalent orderable tests at a different lab?”
“Which tests at a target lab correspond to the lab provider IDs I already use?”
Tell an agent
Convert lab test {lab_test} to its equivalent at {target_lab}.
Map provider IDs {provider_ids} onto the {target_lab} compendium.
POST /v3/compendium/search_orderable_tests Search Orderable Tests #

Documentation

📖
Documentation
https://docs.junction.com/api-details/junction-api
📖
Documentation
https://docs.junction.com/wearables/providers/introduction
📖
Documentation
https://docs.junction.com/api-details/junction-management-api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/junction-com/openapi/junction-com-compendium-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-user-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-provider-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-sleep-summary-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-activity-summary-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-heart-rate-timeseries-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-lab-order-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-lab-result-schema.json

Other Resources

🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-create-user-example.json
🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-link-token-example.json
🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-sleep-summary-example.json
🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-heart-rate-timeseries-example.json
🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-create-order-example.json
🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-lab-result-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/junction-com:junction-com-compendium-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

junction-com-compendium-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Junction Compendium API
  version: '1.0'
  description: 'Operations tagged compendium across 2 of this provider''s published API definitions: junction-openapi-live-2026-10-12.json, vital-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.us.junction.com
  x-fern-server-name: Production
- url: https://api.eu.junction.com
  x-fern-server-name: ProductionEU
- url: https://api.sandbox.us.junction.com
  x-fern-server-name: Sandbox
- url: https://api.sandbox.eu.junction.com
  x-fern-server-name: SandboxEU
security:
- apiKeyAuth: []
tags:
- name: compendium
paths:
  /v3/compendium/search:
    post:
      tags:
      - compendium
      summary: Search Compendium
      operationId: search_compendium_v3_compendium_search_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCompendiumBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchCompendiumResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-fern-sdk-group-name: compendium
      x-fern-sdk-method-name: search
    servers:
    - url: https://api.us.junction.com
      x-fern-server-name: Production
    - url: https://api.eu.junction.com
      x-fern-server-name: ProductionEU
    - url: https://api.sandbox.us.junction.com
      x-fern-server-name: Sandbox
    - url: https://api.sandbox.eu.junction.com
      x-fern-server-name: SandboxEU
  /v3/compendium/convert:
    post:
      tags:
      - compendium
      summary: Convert Compendium
      operationId: convert_compendium_v3_compendium_convert_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConvertCompendiumBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConvertCompendiumResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-fern-sdk-group-name: compendium
      x-fern-sdk-method-name: convert
    servers:
    - url: https://api.us.junction.com
      x-fern-server-name: Production
    - url: https://api.eu.junction.com
      x-fern-server-name: ProductionEU
    - url: https://api.sandbox.us.junction.com
      x-fern-server-name: Sandbox
    - url: https://api.sandbox.eu.junction.com
      x-fern-server-name: SandboxEU
  /v3/compendium/search_orderable_tests:
    post:
      tags:
      - compendium
      summary: Search Orderable Tests
      operationId: search_orderable_tests_v3_compendium_search_orderable_tests_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchOrderableTestsBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchOrderableTestsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-fern-sdk-group-name: compendium
      x-fern-sdk-method-name: search_orderable_tests
    servers:
    - url: https://api.us.junction.com
      x-fern-server-name: Production
    - url: https://api.eu.junction.com
      x-fern-server-name: ProductionEU
    - url: https://api.sandbox.us.junction.com
      x-fern-server-name: Sandbox
    - url: https://api.sandbox.eu.junction.com
      x-fern-server-name: SandboxEU
components:
  schemas:
    SearchMode:
      type: string
      enum:
      - canonical
      - crosswalk
      title: SearchMode
      description: ℹ️ This enum is non-exhaustive.
    SearchOrderableTestsResponse:
      properties:
        candidates:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PerLabCandidate'
            type: array
          type: object
          title: Candidates
      type: object
      title: SearchOrderableTestsResponse
    ConvertCompendiumBody:
      properties:
        lab_test_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Lab Test Id
        provider_ids:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Provider Ids
        target_lab:
          $ref: '#/components/schemas/CompendiumSearchLabs'
          description: ℹ️ This enum is non-exhaustive.
        limit:
          type: integer
          title: Limit
          default: 3
      type: object
      required:
      - target_lab
      title: ConvertCompendiumBody
    SearchCompendiumResponse:
      properties:
        mode:
          $ref: '#/components/schemas/SearchMode'
          description: ℹ️ This enum is non-exhaustive.
        selected_canonical:
          anyOf:
          - $ref: '#/components/schemas/CanonicalCandidate'
          - type: 'null'
        canonical_candidates:
          items:
            $ref: '#/components/schemas/CanonicalCandidate'
          type: array
          title: Canonical Candidates
        per_lab:
          additionalProperties:
            items:
              $ref: '#/components/schemas/PerLabCandidate'
            type: array
          type: object
          title: Per Lab
        related:
          items:
            $ref: '#/components/schemas/RelatedCandidate'
          type: array
          title: Related
      type: object
      required:
      - mode
      title: SearchCompendiumResponse
    CompendiumSearchLabs:
      type: string
      enum:
      - labcorp
      - quest
      - bioreference
      - sonora_quest
      title: CompendiumSearchLabs
      description: ℹ️ This enum is non-exhaustive.
    ConvertCompendiumResponse:
      properties:
        source_lab_test_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Source Lab Test Id
        source_lab_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Source Lab Id
        target_lab_id:
          type: integer
          title: Target Lab Id
        target_lab_slug:
          type: string
          title: Target Lab Slug
        source_provider_ids:
          items:
            type: string
          type: array
          title: Source Provider Ids
        converted_provider_ids:
          items:
            type: string
          type: array
          title: Converted Provider Ids
        unresolved_provider_ids:
          items:
            type: string
          type: array
          title: Unresolved Provider Ids
        by_source_provider_id:
          additionalProperties:
            $ref: '#/components/schemas/ProviderIdConversionResponse'
          type: object
          title: By Source Provider Id
      type: object
      required:
      - target_lab_id
      - target_lab_slug
      title: ConvertCompendiumResponse
    SearchOrderableTestsBody:
      properties:
        provider_ids:
          items:
            type: string
          type: array
          maxItems: 100
          title: Provider Ids
        target_lab:
          $ref: '#/components/schemas/CompendiumSearchLabs'
          description: ℹ️ This enum is non-exhaustive.
        per_provider_limit:
          type: integer
          title: Per Provider Limit
          default: 1
      type: object
      required:
      - provider_ids
      - target_lab
      title: SearchOrderableTestsBody
    CanonicalCandidate:
      properties:
        loinc_set_hash:
          type: string
          title: Loinc Set Hash
        display_name:
          type: string
          title: Display Name
        aliases:
          items:
            type: string
          type: array
          title: Aliases
        loinc_codes:
          items:
            type: string
          type: array
          title: Loinc Codes
        provider_ids:
          items:
            type: string
          type: array
          title: Provider Ids
        loinc_components:
          items:
            type: string
          type: array
          title: Loinc Components
        loinc_groups:
          items:
            type: string
          type: array
          title: Loinc Groups
        cpt_codes:
          items:
            type: string
          type: array
          title: Cpt Codes
        popularity_score:
          type: number
          title: Popularity Score
        confidence:
          type: number
          title: Confidence
      type: object
      required:
      - loinc_set_hash
      - display_name
      - popularity_score
      - confidence
      title: CanonicalCandidate
    HTTPValidationError:
      properties:
        detail:
          title: Detail
      type: object
      title: HTTPValidationError
    ProviderIdConversionResponse:
      properties:
        source_provider_id:
          type: string
          title: Source Provider Id
        candidates:
          items:
            $ref: '#/components/schemas/PerLabCandidate'
          type: array
          title: Candidates
      type: object
      required:
      - source_provider_id
      title: ProviderIdConversionResponse
    PerLabCandidate:
      properties:
        marker_id:
          type: integer
          title: Marker Id
        lab_id:
          type: integer
          title: Lab Id
        lab_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Lab Slug
        name:
          type: string
          title: Name
        result_names:
          items:
            type: string
          type: array
          title: Result Names
        provider_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider Id
        loinc_set_hash:
          type: string
          title: Loinc Set Hash
        loinc_codes:
          items:
            type: string
          type: array
          title: Loinc Codes
        loinc_components:
          items:
            type: string
          type: array
          title: Loinc Components
        loinc_groups:
          items:
            type: string
          type: array
          title: Loinc Groups
        cpt_codes:
          items:
            type: string
          type: array
          title: Cpt Codes
        relation:
          type: string
          title: Relation
        confidence:
          type: number
          title: Confidence
        reason_codes:
          items:
            type: string
          type: array
          title: Reason Codes
        marker_popularity_score:
          type: number
          title: Marker Popularity Score
      type: object
      required:
      - marker_id
      - lab_id
      - name
      - loinc_set_hash
      - relation
      - confidence
      - marker_popularity_score
      title: PerLabCandidate
    RelatedCandidate:
      properties:
        canonical:
          $ref: '#/components/schemas/CanonicalCandidate'
        relation:
          type: string
          title: Relation
        confidence:
          type: number
          title: Confidence
        reason_codes:
          items:
            type: string
          type: array
          title: Reason Codes
      type: object
      required:
      - canonical
      - relation
      - confidence
      title: RelatedCandidate
    SearchCompendiumBody:
      properties:
        mode:
          $ref: '#/components/schemas/SearchMode'
          description: ℹ️ This enum is non-exhaustive.
        query:
          anyOf:
          - type: string
          - type: 'null'
          title: Query
        cpt_codes:
          items:
            type: string
          type: array
          title: Cpt Codes
        loinc_set_hash:
          anyOf:
          - type: string
          - type: 'null'
          title: Loinc Set Hash
        labs:
          anyOf:
          - items:
              $ref: '#/components/schemas/CompendiumSearchLabs'
            type: array
          - type: 'null'
          title: Labs
        include_related:
          type: boolean
          title: Include Related
          default: true
        limit:
          type: integer
          title: Limit
          default: 3
      type: object
      required:
      - mode
      title: SearchCompendiumBody
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-vital-api-key
      description: Vital Team API Key
x-refined-from:
- junction-openapi-live-2026-10-12.json
- vital-openapi-original.json
x-provenance:
  method: harvested
  publisher: Junction
  source: https://api.us.junction.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)