Get Model Details

GET

/org/:org_id/project/:project_id/model/:model_id_or_name

GET

/api/v1/org/:org_id/project/:project_id/model/:model_id_or_name

$ curl https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/model/ec217e75-72ea-4281-a1b8-cb7bd0ef9f41 \
>      -H "Authorization: Bearer <token>"

1 {
2   "provider": "OpenAI",
3   "vendor": "openai",
4   "name": "gpt-4-turbo",
5   "alias": "GPT-4 Turbo",
6   "description": "Latest GPT-4 Turbo model with vision capabilities. 128K context window with training cut off of Dec 2023.",
7   "supports_vision": true,
8   "max_context_window": 128000,
9   "id": "ec217e75-72ea-4281-a1b8-cb7bd0ef9f41",
10   "supports_image_output": false,
11   "supports_pdf_vision": false,
12   "supports_tool_calling": true,
13   "supports_context_caching": false,
14   "price": "average",
15   "speed": "fast",
16   "knowledge_cutoff": "2023-12-01",
17   "model_params": {
18     "temperature": {
19       "default": 0.3,
20       "description": "Controls randomness in the output. Lower values make output more focused and deterministic.",
21       "maximum": 1,
22       "minimum": 0,
23       "type": "number"
24     }
25   },
26   "created": "2024-01-16T13:33:25.247662Z",
27   "modified": "2024-01-16T13:33:25.247662Z",
28   "llm_model_comments": []
29 }

Retrieve detailed information about a specific LLM model by its ID or name.

This endpoint accepts either a UUID or the model name (e.g., “gpt-4-turbo” or “claude-3-opus”).

Returns complete model information including:

Provider and vendor details
Model capabilities (vision support, context window)
Retirement status and replacement information
Disabled parameters

Use this endpoint to:

Verify model capabilities before using in a task
Check if a model has been retired
Look up model details by name for easier integration
Get detailed model specifications
Find replacement models for retired ones

Retrieve detailed information about a specific LLM model by its ID or name. This endpoint accepts either a UUID or the model name (e.g., "gpt-4-turbo" or "claude-3-opus"). Returns complete model information including: - Provider and vendor details - Model capabilities (vision support, context window) - Retirement status and replacement information - Disabled parameters Use this endpoint to: - Verify model capabilities before using in a task - Check if a model has been retired - Look up model details by name for easier integration - Get detailed model specifications - Find replacement models for retired ones

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

model_id_or_namestringRequired

The UUID or name of the LLM model to retrieve (e.g., ‘ec217e75-72ea-4281-a1b8-cb7bd0ef9f41’ or ‘gpt-4-turbo’).

org_idstringRequiredformat: "uuid"

The unique identifier of the organization.

project_idstringRequiredformat: "uuid"

The unique identifier of the project.

Response

Successfully retrieved model details

providerstring

The company that produces the LLM (e.g., OpenAI, Anthropic, Meta).

vendorstring

The service provider or platform hosting the model (e.g., OpenAI, Azure, Groq).

namestring

The model's reference name used for API calls.

aliasstring

Human-readable name for the model.

descriptionstring

Detailed description of the model's capabilities, context window, and knowledge cutoff.

supports_visionboolean

Whether the model can process and analyze images.

max_context_windowinteger>=0

Maximum number of tokens the model can process in a single request.

idstringformat: "uuid"

supports_image_outputbooleanOptionalDefaults to false

Whether the model can generate images as output.

supports_pdf_visionbooleanOptionalDefaults to false

Whether the model can process PDFs as visual input.

supports_tool_callingbooleanOptionalDefaults to false

Whether the model supports tool calling APIs.

supports_context_cachingbooleanOptionalDefaults to false

Whether the model supports provider-native context caching.

priceenum or nullOptional

Coarse model price tier for selector comparison.

speedenum or nullOptional

Coarse model inference speed tier for selector comparison.

knowledge_cutoffdate or nullOptional

Date of the model's most recent training data, when known.

pdf_vision_configobject or nullOptional

Configuration limits for PDF vision processing.

model_paramsmap from strings to any or nullOptional

JSON Schema defining allowed model parameters for this model. Each parameter name maps to a JSON Schema specification defining its type, constraints, and validation rules.

createdstring or nullOptional

modifiedstring or nullOptional

replaced_bystring or nullOptionalformat: "uuid"

retiredstring or nullOptional

llm_model_commentslist of objectsOptionalDefaults to []

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error