​
API Structure

The Praxis AI API is organized into two functional areas:

Authenticate

Signin or Authenticate to retrieve an access token

Runtime

Endpoints for selecting a Digital Twin, creating conversations, , developing assistants, dialoguing with AI models

Administration

Endpoints for configuring Digital Twins, setting up permissions and entitlements, auditing user history and monitoring

​
Getting Started

Before using the API, you’ll need to:
  1. Obtain an authorization token: All API requests require an authorization token that is issued on successfull authentication
  2. Understand Base URL: All API requests are made to https://hiimpria.ai/api
  3. Review Authentication: See our Authentication guide for details on how to use your access token

​
Using the API

The praxis API follows RESTful principles with these standard conventions:
  • All requests and responses use JSON format
  • HTTP status codes indicate success or failure of requests
  • Error responses include a consistent structure with error details
  • Rate limits apply to protect the stability of the service

​
Example Request

curl https://hiimpria.ai/api \
  -H "x-access-token: your_api_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "welcome-message",
    "tag": "production"
  }'

​
API vs SDK

While the API gives you direct access to Praxis’s capabilities, we also offer SDKs for TypeScript/JavaScript that provide a more convenient, language-specific interface.

API Benefits

  • Direct access to all praxis features
  • Language-agnostic integration
  • Fine-grained control over requests and responses
  • Useful for custom integrations and platforms

SDK Benefits

  • Higher-level abstractions
  • Type safety and autocomplete
  • Built-in error handling
  • Automatic retries and caching
  • Simplified authentication
For most use cases, we recommend using our SDKs, but the API is available for scenarios where direct access is preferred.

​
Error Handling

The API uses standard HTTP status codes to indicate the success or failure of requests:
  • 2xx codes indicate success
  • 4xx codes indicate client errors (invalid requests)
  • 5xx codes indicate server errors

​
Next Steps

Explore the API reference documentation for each endpoint: