API Reference

The ARKH API allows you to programmatically manage apps, send vibes, and access installation data. All API requests require authentication.

Base URL

https://developer.arkh.com/api

Authentication

All API requests require authentication via an API key passed in the Authorization header:

Authorization: Bearer arkh_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Create API keys on the API Keys page. See the Authentication docs for detailed usage and security best practices.

Endpoints

  • /apps - Retrieve your ARKH apps
  • /vibes - Send haptic feedback and Ring UI notifications to users

Response Format

All responses are JSON. Successful responses include the requested data. Error responses include an error code and message:

Error Response

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key provided is invalid or has been revoked."
  }
}