> ## Documentation Index
> Fetch the complete documentation index at: https://api.tryspecter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Health check

> Returns HTTP `200` with `{"status":"OK"}` while the API is up, serving traffic, and able to reach both of its backing databases.

<Note>
This endpoint is free of charge and does not consume credits.
</Note>




## OpenAPI

````yaml /api-ref/bundle_api.yaml get /health
openapi: 3.0.0
info:
  title: Specter API
  termsOfService: https://tryspecter.com/terms/
  contact:
    name: API support
    email: api-support@tryspecter.com
  version: 1.0.0
servers:
  - description: Production
    url: https://app.tryspecter.com/api/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Enrich
    description: >
      Look up a company, person, or investor and, if Specter does not already
      hold it, fetch it on demand. Includes email-based person enrichment.
  - name: Search
    description: |
      Find records across every product from a single plain-English query.
  - name: Companies
    description: >
      Company profiles, funding, headcount, traction, the per-company signals
      and sub-resources attached to a single company, and identifier resolution.
  - name: People
    description: >
      Specter people records: profile data, contact details, and per-person
      lookups for a known person ID.
  - name: Investors
    description: >
      Specter investor records: profile, activity, targeting, funds, portfolio
      companies, and the funding rounds they have participated in.
  - name: Transactions
    description: |
      Transaction detail by ID: funding rounds, acquisitions, and IPOs.
  - name: News Signals
    description: |
      Company-level news signals: by ID, and for a saved list or company search.
  - name: Revenue Signals
    description: >
      Revenue and profitability signals: by ID, by date, and for a saved list or
      company search.
  - name: Talent Signals
    description: |
      Talent signals: by ID and in bulk by ID.
  - name: Investor Interest Signals
    description: |
      Investor interest signals: by ID and in bulk by ID.
  - name: Company Lists
    description: |
      Create, query, and maintain lists of companies, including their results.
  - name: Investor Lists
    description: |
      Create, query, and maintain lists of investors, including their results.
  - name: People Lists
    description: |
      Create, query, and maintain lists of people, including their results.
  - name: Saved Searches
    description: |
      List and delete searches saved via tryspecter.com.
  - name: Company Saved Searches
    description: |
      Details and results for saved company searches.
  - name: People Saved Searches
    description: |
      Details and results for saved people searches.
  - name: Investor Saved Searches
    description: |
      Details and results for saved investor searches.
  - name: Talent Signals Saved Searches
    description: |
      Details and results for saved Talent Signals searches.
  - name: Investor Interest Saved Searches
    description: |
      Details and results for saved Investor Interest Signals searches.
  - name: Network
    description: >
      Your team's LinkedIn network: the people and companies your teammates are
      connected to, and your reach into a given company.
  - name: Account
    description: >
      Organisation-level resources: your team's members, API call logs, and
      credit balance.
paths:
  /health:
    get:
      tags:
        - Account
      summary: Health check
      description: >
        Returns HTTP `200` with `{"status":"OK"}` while the API is up, serving
        traffic, and able to reach both of its backing databases.


        <Note>

        This endpoint is free of charge and does not consume credits.

        </Note>
      responses:
        '200':
          description: The API is serving traffic and both databases are reachable.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - postgres
                  - clickhouse
                properties:
                  status:
                    type: string
                    enum:
                      - OK
                    example: OK
                  postgres:
                    type: string
                    enum:
                      - OK
                    example: OK
                  clickhouse:
                    type: string
                    enum:
                      - OK
                    example: OK
        '503':
          description: >
            The API is serving traffic but at least one backing database is
            unreachable. Each dependency is reported individually and the
            failing one (or ones) is marked `ERROR`.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - postgres
                  - clickhouse
                properties:
                  status:
                    type: string
                    enum:
                      - ERROR
                    example: ERROR
                  postgres:
                    type: string
                    enum:
                      - OK
                      - ERROR
                    example: OK
                  clickhouse:
                    type: string
                    enum:
                      - OK
                      - ERROR
                    example: ERROR
              example:
                status: ERROR
                postgres: OK
                clickhouse: ERROR
      security: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````