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

# Check API health

> Check whether the API service responds. No API key is needed.



## OpenAPI

````yaml api-reference/openapi.json GET /v1/health
openapi: 3.0.3
info:
  title: Thred API
  version: 1.0.0
  description: >-
    Thred is the data API for the phone. Use Collect when you know who to ask:
    send a phone number and instructions, add context values in input, and
    define the answers you want with a JSON Schema in output. Use the same base
    URL for Development and Production; your API key selects the environment.
servers:
  - url: https://api.thred.dev
    description: Thred API
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Verify the workspace and environment selected by your API key.
  - name: Collect
    description: Collect structured answers from a known phone number.
  - name: Usage
    description: Read daily operational usage.
  - name: Health
    description: Check public API availability.
paths:
  /v1/health:
    get:
      tags:
        - Health
      summary: Check API health
      description: Check whether the API service responds. No API key is needed.
      operationId: getHealth
      responses:
        '200':
          description: API service is responding.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
      security: []
components:
  schemas:
    Health:
      type: object
      properties:
        service:
          type: string
          enum:
            - thred-data-backend
        status:
          type: string
          enum:
            - ok
        environment:
          type: string
          example: production
          description: >-
            API deployment environment. This is not the environment selected by
            an API key.
      required:
        - service
        - status
        - environment
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Thred API key
      description: >-
        Send Authorization: Bearer <THRED_API_KEY>. Development keys begin
        thr_dev_; Production keys begin thr_prod_. Each key is scoped to a
        workspace and environment. Keep secrets on your server.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.