Skip to main content

Models API

ByteEngine provides access to various AI models optimized for healthcare applications. This API allows you to discover available models and understand their capabilities for different use cases.

Base URL​

https://api.engine.boolbyte.com/api/models

Get Available Models​

GET /api/models

Retrieves all available AI models with their capabilities and specifications.

Using JavaScript SDK:

import { EngineClient } from '@boolbyte/engine';

const client = new EngineClient({ apiKey: 'YOUR_API_KEY' });

const models = await client.model.getModels();

Response:

{
  "success": true,
  "message": "Models retrieved successfully",
  "data": [
    {
      "id": "openai/gpt-4",
      "name": "GPT-4",
      "description": "Advanced language model with strong reasoning capabilities"
    },
    {
      "id": "openai/gpt-3.5-turbo",
      "name": "GPT-3.5 Turbo",
      "description": "Fast and efficient model for general tasks"
    },
    {
      "id": "anthropic/claude-3-sonnet",
      "name": "Claude 3 Sonnet",
      "description": "Balanced model with strong analytical capabilities"
    },
    {
      "id": "anthropic/claude-3-haiku",
      "name": "Claude 3 Haiku",
      "description": "Fast and lightweight model for quick responses"
    }
  ]
}

Error Handling​

{
  "success": false,
  "message": "Model not available",
  "data": null,
  "error": {
    "code": "model_not_found",
    "details": "Model 'invalid-model' is not available"
  }
}

Common Error Codes​

  • model_not_found: Specified model is not available
  • model_quota_exceeded: Model usage quota exceeded
  • model_temporarily_unavailable: Model is temporarily unavailable
  • invalid_model_configuration: Model configuration is invalid

Next Steps​