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/chroma:chroma-system-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.2.0
info:
  title: chroma-frontend System API
  description: ''
  license:
    name: ''
  version: 1.0.0
tags:
- name: System
paths:
  /api/v2/healthcheck:
    get:
      tags:
      - System
      summary: Healthcheck
      description: Returns the health status of the service.
      operationId: healthcheck
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codeSamples: []
  /api/v2/heartbeat:
    get:
      tags:
      - System
      summary: Heartbeat
      description: Returns a nanosecond timestamp of the current time.
      operationId: heartbeat
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeartbeatResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codeSamples:
      - label: Heartbeat
        lang: typescript
        source: const timestamp = await client.heartbeat();
      - label: Heartbeat
        lang: python
        source: timestamp = client.heartbeat()
      - label: Heartbeat
        lang: rust
        source: let timestamp = client.heartbeat().await?;
  /api/v2/pre-flight-checks:
    get:
      tags:
      - System
      summary: Pre-flight checks
      description: Returns basic readiness information.
      operationId: pre_flight_checks
      responses:
        '200':
          description: Pre flight checks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChecklistResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v2/reset:
    post:
      tags:
      - System
      summary: Reset database
      description: Resets the database. Requires authorization.
      operationId: reset
      responses:
        '200':
          description: Reset successful
          content:
            text/plain:
              schema:
                type: boolean
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      x-hidden: true
  /api/v2/version:
    get:
      tags:
      - System
      summary: Get version
      description: Returns the version of the server.
      operationId: version
      responses:
        '200':
          description: Get server version
          content:
            text/plain:
              schema:
                type: string
      x-codeSamples:
      - label: Get version
        lang: typescript
        source: const version = await client.version();
      - label: Get version
        lang: python
        source: version = client.get_version()
components:
  schemas:
    ChecklistResponse:
      type: object
      required:
      - max_batch_size
      - supports_base64_encoding
      properties:
        max_batch_size:
          type: integer
          format: int32
          minimum: 0
        supports_base64_encoding:
          type: boolean
    HeartbeatResponse:
      type: object
      required:
      - nanosecond heartbeat
      properties:
        nanosecond heartbeat:
          type: integer
          minimum: 0
    ErrorResponse:
      type: object
      required:
      - error
      - message
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-chroma-token
x-provenance:
  method: harvested
  publisher: Chroma
  source: https://api.trychroma.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)