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

# Health/auth smoke check

> Returns 204 if the API key authenticated successfully.



## OpenAPI

````yaml /openapi.yaml get /v1/ping
openapi: 3.1.0
info:
  title: Vein Public API
  version: 1.0.0
  description: >
    Phase 1 of the Vein public API. Read-only access to verified portfolio
    company data with full source attribution. See PHASE_1_DESIGN.md.
servers:
  - url: https://api.vein.finance
    description: >-
      Production (key selects live vs test via vein_sk_live_/vein_sk_test_
      prefix)
security:
  - bearerAuth: []
paths:
  /v1/ping:
    get:
      summary: Health/auth smoke check
      description: Returns 204 if the API key authenticated successfully.
      operationId: ping
      responses:
        '204':
          description: Authenticated. No body.
        '401':
          $ref: '#/components/responses/AuthError'
        '429':
          $ref: '#/components/responses/RateLimit'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  responses:
    AuthError:
      description: Authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimit:
      description: >
        Too many requests. The public API is rate limited per API key. Every
        response (not just 429s) carries the RateLimit-* headers below; on a 429
        the Retry-After header gives the seconds to wait before retrying.
      headers:
        RateLimit-Limit:
          description: Requests allowed per window for this key.
          schema:
            type: integer
            example: 120
        RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
            example: 0
        RateLimit-Reset:
          description: Seconds until the current window resets.
          schema:
            type: integer
            example: 42
        Retry-After:
          description: Seconds to wait before retrying (present on 429 only).
          schema:
            type: integer
            example: 42
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    ServerError:
      description: An unexpected server-side error occurred.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - documentation_url
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - permission_error
                - invalid_request_error
                - not_found_error
                - rate_limit_error
                - idempotency_error
                - api_error
            code:
              type: string
              example: invalid_api_key
            message:
              type: string
            request_id:
              type: string
            documentation_url:
              type: string
              format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: vein_sk
      description: 'Authorization: Bearer vein_sk_live_... or vein_sk_test_...'

````