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

# Server health check

> Check API service health status.

Returns the current operational status of the API service.
No authentication required.



## OpenAPI

````yaml get /v1/health
openapi: 3.1.0
info:
  title: Altrina Browser Agent API
  description: >

    AI-powered browser automation API that allows you to control web browsers
    programmatically.


    ## What can Altrina do?


    Altrina uses advanced AI models to understand natural language instructions
    and execute them in a web browser:

    - **Web Scraping**: Extract data from any website without writing selectors

    - **Form Automation**: Fill out complex forms and multi-step workflows

    - **Testing**: Automated end-to-end testing with natural language assertions

    - **Research**: Gather information across multiple sites and compile results

    - **Monitoring**: Check websites for changes or specific conditions


    ## Authentication

    All API endpoints (except `/v1/health`) require authentication via API key.


    ### Getting an API Key

    1. Go to
    [https://app.altrina.com/settings](https://app.altrina.com/settings)

    2. Click on "Generate API Key"

    3. Copy your API key and keep it secure


    ### Using the API Key

    Include your API key in the `Authorization` header as a Bearer token:

    ```

    Authorization: Bearer YOUR_API_KEY

    ```


    ### Example cURL Request

    ```bash

    curl -X POST "https://api.altrina.com/v1/run_browser_agent" \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "directive": "Go to news.ycombinator.com and get the titles and points of the top 3 stories on the homepage",
        "browser_config": {
          "width": 1920,
          "height": 1080,
          "residential_ip": false,
          "keep_browser_open": false,
          "use_user_browser_profile": false
        }
      }'
    ```


    **Note on Browser Profiles**: By default (`use_user_browser_profile:
    false`), each API call uses a fresh browser profile with no cookies or
    browsing history. Set `use_user_browser_profile: true` if you need to
    maintain logged-in state across multiple API calls.


    ## Rate Limits


    - **Browser Agent**: 10 requests/minute

    - **Status Polling**: 60 requests/minute

    - **Credit Balance**: 60 requests/minute


    ## Support


    For issues or questions, contact support@altrina.com
  version: 1.0.0
servers:
  - url: https://api.altrina.com
security: []
tags:
  - name: Browser Agent
    description: Start and monitor browser automation tasks
  - name: Workflows
    description: Trigger saved workflows via API or webhook
  - name: Account
    description: Manage credits and subscription
  - name: System
    description: Service health and status
paths:
  /v1/health:
    get:
      tags:
        - System
      summary: Server health check
      description: |-
        Check API service health status.

        Returns the current operational status of the API service.
        No authentication required.
      operationId: health_check_v1_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
components:
  schemas:
    HealthCheckResponse:
      properties:
        status:
          type: string
          title: Status
          description: Service health status - 'healthy' when operational
        timestamp:
          type: string
          title: Timestamp
          description: Current server timestamp in ISO 8601 format
        version:
          type: string
          title: Version
          description: API version
          default: 1.0.0
      type: object
      required:
        - status
        - timestamp
      title: HealthCheckResponse
      description: Health check response indicating API service status

````