Appendix

Appendix api reference API

Appendix api reference API as documented publicly: 24 operations. Contract generated from the documentation by API Evangelist (2026-11-01); not the provider's own document.

Documentation GitHub OpenAPI

Operations 24

GET /api/v1/agent/encounters/{encounterId}/events Poll for messages #

POST /api/v1/agent/encounters/{encounterId}/events Reply on the patient's behalf #

POST /api/v1/agent/encounters/{encounterId}/events/read Mark messages read #

POST /api/v1/agent/query Send one of the following in the Authorization header. #

GET /api/v1/config/conditions Conditions list #

GET /api/v1/config/pricing Pricing #

GET /api/v1/encounters List your encounters #

GET /api/v1/encounters/{id} Get encounter #

POST /api/v1/encounters/{id}/cancel Cancel encounter #

GET /api/v1/encounters/{id}/latest-turn Latest turn #

GET /api/v1/encounters/{id}/turns List turns #

GET /api/v1/knowledge/search Knowledge base search #

GET /api/v1/patients Retrieve patient identifiers for binding encounters. #

POST /api/v1/patients Add a person #

DELETE /api/v1/patients/{id} Remove patient #

GET /api/v1/patients/{id} Get patient #

PATCH /api/v1/patients/{id} Update patient #

GET /api/v1/subscriptions/me Current subscription #

GET /api/v1/subscriptions/me/invoices Recent invoices #

GET /api/v1/subscriptions/me/payment-method Default payment method #

GET /api/v1/users/me Current user #

GET /api/v1/users/me/api-keys List API keys #

POST /api/v1/users/me/api-keys Create API key #

GET /api/v1/users/me/submissions List submissions #

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/appendix-com:api-reference-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

openapi: 3.1.0
info:
  title: Appendix api reference API
  version: '2026-11-01'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-01: 24 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Appendix has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 34
    pages-with-code: 7
    pages-read: 12
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-01'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://appendix.com/docs/api-reference/account
  - https://appendix.com/docs/api-reference/chat
  - https://appendix.com/docs/api-reference/overview
  - https://appendix.com/docs/api-reference/query
  x-docs-section: api-reference
servers:
- url: https://api.appendix.com
paths:
  /api/v1/agent/encounters/{encounterId}/events:
    get:
      operationId: get_api_v1_agent_encounters_encounterId_events
      tags:
      - Api
      summary: Poll for messages
      x-source: https://appendix.com/docs/api-reference/chat
      parameters:
      - name: encounterId
        in: path
        required: true
        schema:
          type: string
      - name: since
        in: query
        required: false
        schema:
          type: string
        description: RFC3339 timestamp. Return only messages created after this time.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Maximum number of messages to return. Returns the most recent N.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1AgentEncountersEncounteridEventsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_agent_encounters_encounterId_events
      tags:
      - Api
      summary: Reply on the patient's behalf
      x-source: https://appendix.com/docs/api-reference/chat
      parameters:
      - name: encounterId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1AgentEncountersEncounteridEventsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/agent/encounters/{encounterId}/events/read:
    post:
      operationId: post_api_v1_agent_encounters_encounterId_events_read
      tags:
      - Api
      summary: Mark messages read
      x-source: https://appendix.com/docs/api-reference/chat
      parameters:
      - name: encounterId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1AgentEncountersEncounteridEventsReadRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/agent/query:
    post:
      operationId: post_api_v1_agent_query
      tags:
      - Api
      summary: Send one of the following in the Authorization header.
      x-source: https://appendix.com/docs/api-reference/chat
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/config/conditions:
    get:
      operationId: get_api_v1_config_conditions
      tags:
      - Api
      summary: Conditions list
      x-source: https://appendix.com/docs/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/config/pricing:
    get:
      operationId: get_api_v1_config_pricing
      tags:
      - Api
      summary: Pricing
      x-source: https://appendix.com/docs/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/encounters:
    get:
      operationId: get_api_v1_encounters
      tags:
      - Api
      summary: List your encounters
      x-source: https://appendix.com/docs/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/encounters/{id}:
    get:
      operationId: get_api_v1_encounters_id
      tags:
      - Api
      summary: Get encounter
      x-source: https://appendix.com/docs/api-reference/overview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/encounters/{id}/cancel:
    post:
      operationId: post_api_v1_encounters_id_cancel
      tags:
      - Api
      summary: Cancel encounter
      x-source: https://appendix.com/docs/api-reference/overview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/encounters/{id}/latest-turn:
    get:
      operationId: get_api_v1_encounters_id_latest_turn
      tags:
      - Api
      summary: Latest turn
      x-source: https://appendix.com/docs/api-reference/overview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/encounters/{id}/turns:
    get:
      operationId: get_api_v1_encounters_id_turns
      tags:
      - Api
      summary: List turns
      x-source: https://appendix.com/docs/api-reference/overview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/knowledge/search:
    get:
      operationId: get_api_v1_knowledge_search
      tags:
      - Api
      summary: Knowledge base search
      x-source: https://appendix.com/docs/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/patients:
    get:
      operationId: get_api_v1_patients
      tags:
      - Api
      summary: Retrieve patient identifiers for binding encounters.
      description: Retrieve the list of patients associated with the authenticated caller, used for binding encounters via patient_id.
      x-source: https://appendix.com/docs/api-reference/query
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1PatientsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_patients
      tags:
      - Api
      summary: Add a person
      x-source: https://appendix.com/docs/api-reference/overview
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/patients/{id}:
    delete:
      operationId: delete_api_v1_patients_id
      tags:
      - Api
      summary: Remove patient
      x-source: https://appendix.com/docs/api-reference/overview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_v1_patients_id
      tags:
      - Api
      summary: Get patient
      x-source: https://appendix.com/docs/api-reference/overview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_api_v1_patients_id
      tags:
      - Api
      summary: Update patient
      x-source: https://appendix.com/docs/api-reference/overview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/subscriptions/me:
    get:
      operationId: get_api_v1_subscriptions_me
      tags:
      - Api
      summary: Current subscription
      x-source: https://appendix.com/docs/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/subscriptions/me/invoices:
    get:
      operationId: get_api_v1_subscriptions_me_invoices
      tags:
      - Api
      summary: Recent invoices
      x-source: https://appendix.com/docs/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/subscriptions/me/payment-method:
    get:
      operationId: get_api_v1_subscriptions_me_payment_method
      tags:
      - Api
      summary: Default payment method
      x-source: https://appendix.com/docs/api-reference/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/users/me:
    get:
      operationId: get_api_v1_users_me
      tags:
      - Api
      summary: Current user
      x-source: https://appendix.com/docs/api-reference/account
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1UsersMeResponse'
      x-evidence:
        kind: documentation
  /api/v1/users/me/api-keys:
    get:
      operationId: get_api_v1_users_me_api_keys
      tags:
      - Api
      summary: List API keys
      x-source: https://appendix.com/docs/api-reference/account
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1UsersMeApiKeysResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_users_me_api_keys
      tags:
      - Api
      summary: Create API key
      x-source: https://appendix.com/docs/api-reference/account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1UsersMeApiKeysRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1UsersMeApiKeysResponse'
      x-evidence:
        kind: documentation
  /api/v1/users/me/submissions:
    get:
      operationId: get_api_v1_users_me_submissions
      tags:
      - Api
      summary: List submissions
      x-source: https://appendix.com/docs/api-reference/account
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1UsersMeSubmissionsResponse'
      x-evidence:
        kind: documentation
security:
- bearer: []
components:
  schemas:
    GetApiV1AgentEncountersEncounteridEventsResponse:
      type: object
      properties:
        encounterId:
          type: string
        state:
          type: string
        events:
          type: array
          description: List of event objects
    PostApiV1AgentEncountersEncounteridEventsRequest:
      type: object
      properties:
        message:
          type: string
          description: The message text.
      required:
      - message
    PostApiV1AgentEncountersEncounteridEventsReadRequest:
      type: object
      properties:
        eventIds:
          type: string
          description: IDs of the events to mark read.
      required:
      - eventIds
    GetApiV1PatientsResponse:
      type: object
      properties:
        patients:
          type: array
          description: List of patient objects belonging to the authenticated account.
    GetApiV1UsersMeResponse:
      type: object
      properties:
        id:
          type: string
          description: User UUID
        email:
          type: string
          description: User email
        role:
          type: string
          description: User role
        identityVerification:
          type: object
          description: Identity verification status object
        createdAt:
          type: string
          description: Timestamp of creation
    GetApiV1UsersMeApiKeysResponse:
      type: object
      properties:
        keyId:
          type: string
          description: Key UUID
        prefix:
          type: string
          description: Key prefix
        label:
          type: string
          description: Label of the key
        expiresAt:
          type: string
          description: Expiration timestamp
        createdAt:
          type: string
          description: Creation timestamp
        lastUsedAt:
          type: string
          description: Timestamp of last use
    PostApiV1UsersMeApiKeysRequest:
      type: object
      properties:
        label:
          type: string
          description: Human‑readable label for the key
        expiresAt:
          type: string
          description: Expiration timestamp (ISO‑8601)
      required:
      - label
      - expiresAt
    PostApiV1UsersMeApiKeysResponse:
      type: object
      properties:
        key:
          type: string
          description: Raw API key (only returned on creation)
        keyId:
          type: string
          description: Key UUID
        prefix:
          type: string
          description: Key prefix
        label:
          type: string
          description: Label supplied in request
        expiresAt:
          type: string
          description: Expiration timestamp
        createdAt:
          type: string
          description: Creation timestamp
    GetApiV1UsersMeSubmissionsResponse:
      type: object
      properties:
        submission:
          type: object
          description: Flattened submission entry with metadata and query preview
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: Api