How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vital compendium API

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

Vital compendium API is one of 18 APIs that Vital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include compendium. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 0.4.497.

Requests are made against 4 base URLs: https://api.us.junction.com, https://api.eu.junction.com, https://api.sandbox.us.junction.com, https://api.sandbox.eu.junction.com.

2 operations 2 paths 11 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.4.497
Base URL
https://api.us.junction.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Vital compendium API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-vital-api-key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Vital Team API Key

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

compendium 2
POST
/v3/compendium/search
Search Compendium
search_compendium_v3_compendium_search_post body → 200422
POST
/v3/compendium/convert
Convert Compendium
convert_compendium_v3_compendium_convert_post body → 200422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are PerLabCandidate (15 properties), CanonicalCandidate (10 properties), ConvertCompendiumResponse (8 properties), SearchCompendiumBody (7 properties). Each schema is shown below with its type and property counts.

HTTPValidationError
object
1 property
SearchMode
string
ℹ️ This enum is non-exhaustive.
ConvertCompendiumBody
object
4 properties 1 required
PerLabCandidate
object
15 properties 7 required
CompendiumSearchLabs
string
ℹ️ This enum is non-exhaustive.
ConvertCompendiumResponse
object
8 properties 2 required
SearchCompendiumBody
object
7 properties 1 required
CanonicalCandidate
object
10 properties 4 required
SearchCompendiumResponse
object
5 properties 1 required
ProviderIdConversionResponse
object
2 properties 1 required
RelatedCandidate
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vital-io-compendium-api-openapi.yml Raw ↑

Other APIs Vital publishes across the network.

Vital Management API
Vital Aggregate API
Vital insurance API
Vital introspect API
Vital lab_account API
Vital lab_report API
Vital lab_tests API
Vital link API
Vital order API
Vital order_transaction API
Vital orders API
Vital payor API
Where this information came from

This is an independent, third-party profile of Vital compendium API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.