Skip to main content
GET
Get Model Details

Overview

Get detailed information about a specific AI model by its ID. This endpoint returns comprehensive model information including pricing details and current status.

Path Parameters

modelId
string
required
The unique identifier of the model to retrieve

Use Cases

  • Model Verification: Confirm model availability before using in prompts
  • Pricing Lookup: Get current pricing for cost calculations
  • Integration Validation: Verify model details during system integration
  • Cost Analysis: Analyze specific model costs for budget planning

Response Structure

Testing Example

Error Responses

Model Not Found

Authentication Failed

Internal Server Error

Integration Examples

Model Validation

Cost Comparison

Prompt Configuration Helper

Best Practices

  1. Model Verification: Always verify model status before using in production
  2. Cost Monitoring: Use model details for accurate cost tracking and budgeting
  3. Error Handling: Implement proper error handling for model not found scenarios
  4. Caching: Cache model details to reduce API calls for frequently used models
  5. Validation: Validate model availability before creating prompts or campaigns

Common Integration Patterns

Pre-Campaign Validation

Verify all models used in campaign prompts are active and available before launching campaigns.

Dynamic Model Selection

Use model details to dynamically select the most appropriate model based on current pricing and requirements.

Cost Optimization

Compare model costs for different scenarios to optimize AI usage expenses.

Model Status

  • active: Model is available for use
  • inactive: Model is temporarily unavailable (not returned by list endpoint)
Only active models are returned by the API endpoints, ensuring you only work with available models.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

modelId
string
required

Response

Model details retrieved successfully

id
string
Example:

"680321c8001e2f527d82"

name
string
Example:

"GPT 5 Mini"

pricing
object
status
enum<string>
Available options:
active,
inactive
Example:

"active"

Last modified on August 29, 2025