Vim

Vim is a United States healthcare technology company (getvim.com) that operates a clinical workflow and point-of-care integration platform connecting health plans, provider organizations, and digital-health applications to physicians inside their existing electronic health records. Through the Vim Canvas developer platform and the VimOS.js JavaScript SDK, applications embed actionable clinical insights - diagnosis gaps, risk, quality, and social determinants of health - directly into supported ambulatory EHR workflows and can read and write EHR resources (Patient, Encounter, Orders, Referral, Claim) at the point of care. Vim also exposes a REST API at api.getvim.com/v1 for provisioning applications, organizations, invitations, appointment lookups, and chart retrieval, authenticated with OAuth 2.0 client credentials via an Auth0-backed authorization server (auth.getvim.com). Vim is HIPAA, SOC 2, and HITRUST certified. The platform is proprietary REST and SDK based; it is not an HL7 FHIR API and publishes no FHIR CapabilityStatement. The API is available only to application servers hosted within the United States.

Vim publishes 10 API contracts indexed on the APIs.io network, including Access Token Retrieval API, Applications API, Appointments API, and 7 more. Tagged areas include Healthcare, United States, Clinical AI, EHR Integration, and Point of Care.

The Vim catalog on APIs.io includes 1 event-driven AsyncAPI specification and 1 Spectral governance ruleset.

Vim’s developer surface includes changelog, sandbox, authentication, documentation, API reference, getting-started guide, support, and 41 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

62.9/100 strong ▬ flat Agent 48/100 agent ready Front door AI 4/6 moderate Heartbeat 66/100 alive saas Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

AccessApproval

2 published contracts 4 Agent Skills

Healthcare United States Clinical AI EHR Integration Point of Care Interoperability Value-Based Care Care Gaps OAuth Authentication

What this lets a business do 1

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Patient Access Management

BC-2800

Appointments

GET /appointments/{vimOrganizationId}

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 62.9/100 · strong

Contract Quality 10.8 / 19

Developer Ergonomics 11.7 / 15

Access Clarity 6.5 / 15

Operational Transparency 8.2 / 10

Contract Governance 2.9 / 9

Discoverability 4.8 / 8

Regulatory Posture 5.5 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 48/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 6 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 6 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 6 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 0 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Health regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/vim/"><img src="https://apis.io/badge/vim/card.svg" alt="Vim on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Documented Reversibility +6 pts — a reversal operation in the contract, graded up when a window is documented too
Pagination +5 pts — share of collection GETs (an array, or one wrapped in data/items/results ...) that declare a page/limit/offset/cursor parameter, a Link header or a next/cursor field; na with no collection GETs
Protected Resource Metadata +5 pts — a served /.well-known/oauth-protected-resource carrying `resource` (documented), and naming its authorization_servers (verified)

4 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Access Clarity scores 43.4 — up to +11.3 composite points
Contract Quality scores 57.7 — up to +10.6 composite points
Contract Governance scores 31.8 — up to +8.2 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/vim/apis.yml: open an issue on github.com/api-evangelist/vim to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Medical Technology (certified health IT, FDA-authorized AI devices)	regulated	28.8 (thin)	-	-
Certified Health IT (health IT accreditation and certification registers)	regulated	28.8 (thin)	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 4

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

OAuth

tagged — the provider's own APIs.json carries the standard as a tag; implementation not verified

Dynamic Client Registration

measured — observed by APIs.io (published)

OpenAPI

measured — observed by APIs.io (published)

OAuth 2.0

measured — observed by APIs.io (declared)

APIs 10

Individual APIs this provider publishes, each with its own machine-readable definition.

Vim Canvas SDK (VimOS.js)

The Vim Canvas developer platform and VimOS.js JavaScript SDK for embedding applications at the point of care. Reads EHR state (Patient, Encounter, Orders, Referral, Claim, plus...

Vim Access Token Retrieval API

Obtaining a Bearer service token to make API requests

Vim Applications API

The Applications API from Vim — 2 operation(s) for applications.

Vim Appointments API

The Appointments API from Vim — 1 operation(s) for appointments.

Vim Authentication API

The Authentication API from Vim — 1 operation(s) for authentication.

Vim Chart Retrieval API

The Chart Retrieval API from Vim — 1 operation(s) for chart retrieval.

Vim Get Patient Care Insights API

Retrieving patient care insights such as diagnosis gaps and care insights

Vim Invitations API

The Invitations API from Vim — 1 operation(s) for invitations.

Vim Patient Care Insights Feedback API

Sending feedback about the care insights

Vim Patient Identification API

Identify the patient based on personal information

Scroll for all 10

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Vim Data Source API Integration

OPEN COLLECTION

Agent Skills 4

Packaged agent skills for driving this provider's APIs from an AI assistant.

Identify a patient and fetch their care insights

AGENT SKILL

Onboard an organization to a Vim application and track its users

AGENT SKILL

Request and download an encounter chart from Vim

AGENT SKILL

Submit clinician feedback on a gap or insight

AGENT SKILL

Vim API pricing

Rate limits

: 10 1 minute
: 10 1 minute
: 50 1 minute

All 5 limits →

Pricing Plans 1

Published pricing tiers and plan structures.

Vim Plans Pricing

0 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Vim Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Vim Finops

FINOPS

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Vim Webhooks

ASYNCAPI

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Vim API Rules

56 rules · 45 errors 5 warnings 6 info

SPECTRAL

OpenAPI Overlays 2

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Vim Data Source Overlay

3 actions · update · vim-data-source-openapi-original.json

DERIVED

Vim Rest Api Overlay

7 actions · documentation · vim-rest-api-openapi-original.json

DERIVED

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Vim Authentication

http/oauth2 · 2 schemes

SECURITY

Vim Domain Security

TLSv1.3 · HSTS · DNSSEC · DMARC

SECURITY

Vim Trust Center

HITRUST CSF, SOC 2 Type II, HIPAA

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Vim Scopes

4 scopes · implicit/clientCredentials

4 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Vim Agentic Access

10 operations · 6 acting

AGENTIC

Resources

Get Started 4

Portal, sign-up, and the first successful call

Sandbox

Sandbox

DeveloperPortal

DeveloperPortal

GettingStarted

GettingStarted

Login

Documentation 4

Reference material describing how the API behaves

OpenAPI

OpenAPI

Documentation

APIReference

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

X-MCPServerCandidate

AgentSkill

WellKnown

LLMsTxt

AgenticAccess

Design & Contract 9

Pagination, idempotency, versioning, errors, and events

ErrorCatalog

Conventions

DataModel

Lifecycle

Conformance

ErrorCatalog

Webhooks

Components

OAuthMetadata

Scroll for all 9

Build 5

SDKs, sample code, and the tooling you integrate with

ToolCrosswalk

ToolCrosswalk

Packages

Packages

SDKs

SDKs

GitHubOrganization

GitHubOrganization

Postman

Postman

Access & Security 6

Authentication, authorization, and security posture

Compliance

TrustCenter

DomainSecurity

OAuthScopes

Authentication

Security

Operate 5

Status, limits, changes, and where to get help

RateLimits

ChangeLog

ChangeLog

Support

StatusPage

Commercial 3

Pricing, plans, and the legal terms of use

Plans

Plans

TermsOfService

TermsOfService

PrivacyPolicy

PrivacyPolicy

Company 3

The organization behind the API

BlogRSS

BlogRSS

Website

Website

Blog

Blog

Other 4

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Overlay

Overlay

Overlay

Overlay

OpenIDConfiguration

OpenIDConfiguration

Source (apis.yml)

aid: vim
url: https://raw.githubusercontent.com/api-evangelist/vim/refs/heads/main/apis.yml
name: Vim
kind: company
description: Vim is a United States healthcare technology company (getvim.com) that operates a clinical workflow and point-of-care
  integration platform connecting health plans, provider organizations, and digital-health applications to physicians inside
  their existing electronic health records. Through the Vim Canvas developer platform and the VimOS.js JavaScript SDK, applications
  embed actionable clinical insights - diagnosis gaps, risk, quality, and social determinants of health - directly into supported
  ambulatory EHR workflows and can read and write EHR resources (Patient, Encounter, Orders, Referral, Claim) at the point
  of care. Vim also exposes a REST API at api.getvim.com/v1 for provisioning applications, organizations, invitations, appointment
  lookups, and chart retrieval, authenticated with OAuth 2.0 client credentials via an Auth0-backed authorization server (auth.getvim.com).
  Vim is HIPAA, SOC 2, and HITRUST certified. The platform is proprietary REST and SDK based; it is not an HL7 FHIR API and
  publishes no FHIR CapabilityStatement. The API is available only to application servers hosted within the United States.
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: approval
  trial: false
  try_now: false
  public: false
  label: Requires approval
  confidence: medium
  source:
  - plans
  - authentication
  - scopes
  - rate-limits
  - security
  - sandbox
  generated: '2026-11-06'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
x-docs-platform: vitepress
x-docs-platform-confidence: medium
x-docs-platform-checked: 2026-10-17
tags:
- Healthcare
- United States
- Clinical AI
- EHR Integration
- Point of Care
- Interoperability
- Value-Based Care
- Care Gaps
- OAuth
- Authentication
tags_raw:
- Healthcare
- United States
- Clinical AI
- EHR Integration
- Point of Care
- Interoperability
- Value-Based Care
- Care Gaps
- OAuth
- Authentication
created: '2026-07-24'
modified: '2026-10-06'
specificationVersion: '0.23'
apis:
- aid: vim:vim-canvas-sdk
  name: Vim Canvas SDK (VimOS.js)
  description: The Vim Canvas developer platform and VimOS.js JavaScript SDK for embedding applications at the point of care.
    Reads EHR state (Patient, Encounter, Orders, Referral, Claim, plus problem/medication/allergy/lab/vitals lists) and writes
    back to Encounter, Referral, and Order resources through Vim Connect's EHR connectivity layer. Proprietary SDK surface
    - not FHIR.
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  tags:
  - EHR Integration
  - SDK
  - Point of Care
  properties:
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: Documentation
    url: https://docs.getvim.com/vim-os-js/vim-ehr-connectivity
  - type: GettingStarted
    url: https://docs.getvim.com/vim-os-js/setting-up
- aid: vim:vim-access-token-retrieval-api
  name: Vim Access Token Retrieval API
  description: Obtaining a Bearer service token to make API requests
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  baseURL: https://api.getvim.com/v1
  tags:
  - Access Token Retrieval
  properties:
  - type: OpenAPI
    url: openapi/vim-access-token-retrieval-api-openapi.yml
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
  - type: Postman
    url: https://docs.getvim.com/invitations-postman-collection.json
  - type: PostmanCollection
    url: collections/vim-invitations.postman_collection.json
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: Webhooks
    url: asyncapi/vim-webhooks.yml
  - type: Documentation
    url: https://data-docs.getvim.com/general-information.html
  - type: Documentation
    url: https://data-docs.getvim.com/api-integration.html
  - type: ToolCrosswalk
    url: mcp/vim-tool-crosswalk.yml
  - type: ErrorCatalog
    url: errors/vim-problem-types.yml
  - type: DataModel
    url: data-model/vim-data-model.yml
- aid: vim:vim-applications-api
  name: Vim Applications API
  description: The Applications API from Vim — 2 operation(s) for applications.
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  baseURL: https://api.getvim.com/v1
  tags:
  - Application
  tags_raw:
  - Applications
  properties:
  - type: OpenAPI
    url: openapi/vim-applications-api-openapi.yml
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
  - type: Postman
    url: https://docs.getvim.com/invitations-postman-collection.json
  - type: PostmanCollection
    url: collections/vim-invitations.postman_collection.json
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: Webhooks
    url: asyncapi/vim-webhooks.yml
  - type: Documentation
    url: https://data-docs.getvim.com/general-information.html
  - type: Documentation
    url: https://data-docs.getvim.com/api-integration.html
  - type: ToolCrosswalk
    url: mcp/vim-tool-crosswalk.yml
  - type: ErrorCatalog
    url: errors/vim-problem-types.yml
  - type: DataModel
    url: data-model/vim-data-model.yml
- aid: vim:vim-appointments-api
  name: Vim Appointments API
  description: The Appointments API from Vim — 1 operation(s) for appointments.
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  baseURL: https://api.getvim.com/v1
  tags:
  - Appointments
  properties:
  - type: OpenAPI
    url: openapi/vim-appointments-api-openapi.yml
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
  - type: Postman
    url: https://docs.getvim.com/invitations-postman-collection.json
  - type: PostmanCollection
    url: collections/vim-invitations.postman_collection.json
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: Webhooks
    url: asyncapi/vim-webhooks.yml
  - type: Documentation
    url: https://data-docs.getvim.com/general-information.html
  - type: Documentation
    url: https://data-docs.getvim.com/api-integration.html
  - type: ToolCrosswalk
    url: mcp/vim-tool-crosswalk.yml
  - type: ErrorCatalog
    url: errors/vim-problem-types.yml
  - type: DataModel
    url: data-model/vim-data-model.yml
- aid: vim:vim-authentication-api
  name: Vim Authentication API
  description: The Authentication API from Vim — 1 operation(s) for authentication.
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  baseURL: https://api.getvim.com/v1
  tags:
  - Authentication
  properties:
  - type: OpenAPI
    url: openapi/vim-authentication-api-openapi.yml
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
  - type: Postman
    url: https://docs.getvim.com/invitations-postman-collection.json
  - type: PostmanCollection
    url: collections/vim-invitations.postman_collection.json
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: Webhooks
    url: asyncapi/vim-webhooks.yml
  - type: Documentation
    url: https://data-docs.getvim.com/general-information.html
  - type: Documentation
    url: https://data-docs.getvim.com/api-integration.html
  - type: ToolCrosswalk
    url: mcp/vim-tool-crosswalk.yml
  - type: ErrorCatalog
    url: errors/vim-problem-types.yml
  - type: DataModel
    url: data-model/vim-data-model.yml
- aid: vim:vim-chart-retrieval-api
  name: Vim Chart Retrieval API
  description: The Chart Retrieval API from Vim — 1 operation(s) for chart retrieval.
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  baseURL: https://api.getvim.com/v1
  tags:
  - Chart Retrieval
  properties:
  - type: OpenAPI
    url: openapi/vim-chart-retrieval-api-openapi.yml
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
  - type: Postman
    url: https://docs.getvim.com/invitations-postman-collection.json
  - type: PostmanCollection
    url: collections/vim-invitations.postman_collection.json
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: Webhooks
    url: asyncapi/vim-webhooks.yml
  - type: Documentation
    url: https://data-docs.getvim.com/general-information.html
  - type: Documentation
    url: https://data-docs.getvim.com/api-integration.html
  - type: ToolCrosswalk
    url: mcp/vim-tool-crosswalk.yml
  - type: ErrorCatalog
    url: errors/vim-problem-types.yml
  - type: DataModel
    url: data-model/vim-data-model.yml
- aid: vim:vim-get-patient-care-insights-api
  name: Vim Get Patient Care Insights API
  description: Retrieving patient care insights such as diagnosis gaps and care insights
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  baseURL: https://api.getvim.com/v1
  tags:
  - Get Patient Care Insights
  properties:
  - type: OpenAPI
    url: openapi/vim-get-patient-care-insights-api-openapi.yml
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
  - type: Postman
    url: https://docs.getvim.com/invitations-postman-collection.json
  - type: PostmanCollection
    url: collections/vim-invitations.postman_collection.json
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: Webhooks
    url: asyncapi/vim-webhooks.yml
  - type: Documentation
    url: https://data-docs.getvim.com/general-information.html
  - type: Documentation
    url: https://data-docs.getvim.com/api-integration.html
  - type: ToolCrosswalk
    url: mcp/vim-tool-crosswalk.yml
  - type: ErrorCatalog
    url: errors/vim-problem-types.yml
  - type: DataModel
    url: data-model/vim-data-model.yml
- aid: vim:vim-invitations-api
  name: Vim Invitations API
  description: The Invitations API from Vim — 1 operation(s) for invitations.
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  baseURL: https://api.getvim.com/v1
  tags:
  - Invitations
  properties:
  - type: OpenAPI
    url: openapi/vim-invitations-api-openapi.yml
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
  - type: Postman
    url: https://docs.getvim.com/invitations-postman-collection.json
  - type: PostmanCollection
    url: collections/vim-invitations.postman_collection.json
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: Webhooks
    url: asyncapi/vim-webhooks.yml
  - type: Documentation
    url: https://data-docs.getvim.com/general-information.html
  - type: Documentation
    url: https://data-docs.getvim.com/api-integration.html
  - type: ToolCrosswalk
    url: mcp/vim-tool-crosswalk.yml
  - type: ErrorCatalog
    url: errors/vim-problem-types.yml
  - type: DataModel
    url: data-model/vim-data-model.yml
- aid: vim:vim-patient-care-insights-feedback-api
  name: Vim Patient Care Insights Feedback API
  description: Sending feedback about the care insights
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  baseURL: https://api.getvim.com/v1
  tags:
  - Patient Care Insights Feedback
  properties:
  - type: OpenAPI
    url: openapi/vim-patient-care-insights-feedback-api-openapi.yml
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
  - type: Postman
    url: https://docs.getvim.com/invitations-postman-collection.json
  - type: PostmanCollection
    url: collections/vim-invitations.postman_collection.json
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: Webhooks
    url: asyncapi/vim-webhooks.yml
  - type: Documentation
    url: https://data-docs.getvim.com/general-information.html
  - type: Documentation
    url: https://data-docs.getvim.com/api-integration.html
  - type: ToolCrosswalk
    url: mcp/vim-tool-crosswalk.yml
  - type: ErrorCatalog
    url: errors/vim-problem-types.yml
  - type: DataModel
    url: data-model/vim-data-model.yml
- aid: vim:vim-patient-identification-api
  name: Vim Patient Identification API
  description: Identify the patient based on personal information
  humanURL: https://docs.getvim.com/vim-os-js/setting-up
  baseURL: https://api.getvim.com/v1
  tags:
  - Patient Identification
  properties:
  - type: OpenAPI
    url: openapi/vim-patient-identification-api-openapi.yml
  - type: APIReference
    url: https://docs.getvim.com/api
  - type: Documentation
    url: https://docs.getvim.com/platform/platform
  - type: ErrorCatalog
    url: errors/vim-error-codes.yml
  - type: RateLimits
    url: rate-limits/vim-rate-limits.yml
  - type: OpenIDConfiguration
    url: well-known/vim-openid-configuration.json
  - type: Postman
    url: https://docs.getvim.com/invitations-postman-collection.json
  - type: PostmanCollection
    url: collections/vim-invitations.postman_collection.json
  - type: Sandbox
    url: sandbox/vim-sandbox.yml
  - type: Webhooks
    url: asyncapi/vim-webhooks.yml
  - type: Documentation
    url: https://data-docs.getvim.com/general-information.html
  - type: Documentation
    url: https://data-docs.getvim.com/api-integration.html
  - type: ToolCrosswalk
    url: mcp/vim-tool-crosswalk.yml
  - type: ErrorCatalog
    url: errors/vim-problem-types.yml
  - type: DataModel
    url: data-model/vim-data-model.yml
common:
- url: https://getvim.com/feed/
  type: BlogRSS
- type: CapabilityMap
  url: capabilities/vim-capability-edges.yml
  name: Vim Business Capability Map
- type: OpenAPI
  url: openapi/_original/vim-data-source-openapi-original.json
- type: OpenAPI
  url: openapi/_original/vim-rest-api-openapi-original.json
- type: X-MCPServerCandidate
  url: mcp/vim-mcp.yml
  note: 'Renamed from MCPServer 2026-09-03 (roadmap#247): the manifest self-describes as status: candidate — a tool list derived
    from the published API contracts, not an existing server. The scorer already read the manifest and reported mcp_server
    correctly; the MCPServer type was crediting the artifact-type surfaces with a server that does not exist.'
- type: ToolCrosswalk
  url: mcp/vim-tool-crosswalk.yml
- type: Packages
  url: packages/vim-packages.yml
- type: SDKs
  url: packages/vim-packages.yml
- type: AgentSkill
  url: skills/_index.yml
- type: ErrorCatalog
  url: errors/vim-problem-types.yml
- type: Conventions
  url: conventions/vim-conventions.yml
- type: DataModel
  url: data-model/vim-data-model.yml
- type: Lifecycle
  url: lifecycle/vim-lifecycle.yml
- type: Conformance
  url: conformance/vim-conformance.yml
- type: Compliance
  url: https://getvim.com/technology-security/
- type: TrustCenter
  url: https://compliance-self-service.getvim.com
- type: WellKnown
  url: well-known/vim-well-known.yml
- type: LLMsTxt
  url: llms/vim-llms.txt
- type: Overlay
  url: overlays/vim-data-source-overlay.yaml
- type: Overlay
  url: overlays/vim-rest-api-overlay.yaml
- type: ErrorCatalog
  url: errors/vim-error-codes.yml
- type: RateLimits
  url: rate-limits/vim-rate-limits.yml
- type: ChangeLog
  url: changelog/vim-changelog.yml
- type: Sandbox
  url: sandbox/vim-sandbox.yml
- type: Webhooks
  url: asyncapi/vim-webhooks.yml
- type: Plans
  url: plans/vim-plans-pricing.yml
- type: Components
  url: components/vim-components.yml
- type: DomainSecurity
  url: security/vim-domain-security.yml
- type: AgenticAccess
  url: agentic-access/vim-agentic-access.yml
- type: OAuthScopes
  url: scopes/vim-scopes.yml
- type: Authentication
  url: authentication/vim-authentication.yml
- type: Website
  url: https://getvim.com/
- type: DeveloperPortal
  url: https://docs.getvim.com/
- type: Documentation
  url: https://docs.getvim.com/
- type: APIReference
  url: https://docs.getvim.com/api
- type: GettingStarted
  url: https://docs.getvim.com/vim-os-js/setting-up
- type: OpenIDConfiguration
  url: well-known/vim-openid-configuration.json
- type: OAuthMetadata
  url: well-known/vim-oauth-authorization-server.json
- type: GitHubOrganization
  url: https://github.com/getvim
- type: Postman
  url: https://docs.getvim.com/invitations-postman-collection.json
- type: ChangeLog
  url: https://docs.getvim.com/change-log/
- type: Support
  url: https://getvim.com/contact-us/
- type: Login
  url: https://console.getvim.com
- type: StatusPage
  url: https://status.getvim.com
- type: Blog
  url: https://getvim.com/blog
- type: Security
  url: https://getvim.com/technology-security/
- type: TermsOfService
  url: https://getvim.com/legal/website-terms-of-use/
- type: PrivacyPolicy
  url: https://getvim.com/legal/privacy/
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
x-enrichment:
  date: '2026-08-15'
  status: enriched
  artifacts_added: 12
  pass: local-v1

Vim API — frequently asked questions

Does Vim have an API?

Yes. APIs.io lists 10 APIs from Vim, including Vim Canvas SDK (VimOS.js), Vim Access Token Retrieval API and Vim Applications API, and 7 more.

Is there an OpenAPI specification for the Vim API?

Yes. APIs.io indexes 9 OpenAPI specifications for Vim, each linked for download from this page.

How do I authenticate with the Vim API?

Vim documents its authentication (http/oauth2 · 2 schemes). The details are profiled on APIs.io as Vim Authentication.

Is the Vim API ready for AI agents?

Vim has a Kin Score of 62.9 out of 100 (strong) and an Agent Readiness score of 47.8 (agent-ready), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider 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 providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
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 provider

curl "https://apis.io/api/v1/providers/vim"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/vim/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/vim/evidence"

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.