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

# Check a key

> Returns 200 with your workspace id when the key is valid.



## OpenAPI

````yaml /openapi.json get /v1/health
openapi: 3.1.0
info:
  title: Rumorly API
  version: 1.0.0
  description: >-
    Send "how did you hear about us?" answers in; get channels, named entities
    and revenue out. All JSON is snake_case.
servers:
  - url: https://api.rumorly.io
    description: Production
  - url: http://localhost:4100
    description: Local development
security: []
tags:
  - name: Basics
  - name: Responses
    description: Answers and their classification.
  - name: People
    description: The people who answered.
  - name: Reports
    description: Revenue by self-reported channel.
  - name: Snippet
    description: Endpoints the JS snippet calls.
paths:
  /v1/health:
    get:
      tags:
        - Basics
      summary: Check a key
      description: Returns 200 with your workspace id when the key is valid.
      responses:
        '200':
          description: The key works.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - ok
                  organization_id:
                    type: string
                required:
                  - status
                  - organization_id
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - secretKey: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          example: invalid body
        code:
          type: string
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
            required:
              - path
              - message
      required:
        - error
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: >-
        A secret key (`sk_live_…` / `sk_test_…`) from Settings → API keys.
        Server-side only.

````

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