Get a model
https://api.respan.ai/api/v1/models/{model}Returns one model, in the same format as the model list.
Returns 404 if the model does not exist or your project cannot use it.
Servers
https://api.respan.ai: Respan API Server
Authentication
Authentication is optional.
RespanApiKey
Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.
HTTP scheme: bearer; format: Respan API key.
Authorization: Bearer $RESPAN_API_KEYPath parameters
model string Requiredid. IDs can contain slashes, such as openrouter/openai/gpt-4o.Example:
"gpt-4o-mini"Responses
200
The model.
application/json
$ object Body
#/components/schemas/OpenAIModelid string Required in parentmodel in gateway requests.Example:
"gpt-4o-mini"object string Required in parent"model"Example:
"model"created integer Required in parent0 if unknown.Example:
1721260800owned_by string Required in parentExample:
"openai"context_length integer or null Required in parentnull if unknown.Example:
128000pricing object Required in parent
Reference:
#/components/schemas/OpenAIModelPricingpricing.input_cost number or null Required in parentinput_price_unit, after the Respan discount and the time-of-day schedule in effect now. Token and character prices are per 1M.Example:
0.15pricing.output_cost number or null Required in parentoutput_price_unit, after the Respan discount and the time-of-day schedule in effect now. Token and character prices are per 1M.Example:
0.6pricing.input_price_unit string Required in parentinput_cost.Allowed:
"token", "image", "second", "minute", "hour", "character"Example:
"token"pricing.output_price_unit string Required in parentoutput_cost.Allowed:
"token", "image", "second", "minute", "hour", "character"Example:
"token"OpenAPI response schema
{
"$ref": "#/components/schemas/OpenAIModel"
}Example
{
"id": "gpt-4o-mini",
"object": "model",
"created": 1721260800,
"owned_by": "openai",
"context_length": 128000,
"pricing": {
"input_cost": 0.15,
"output_cost": 0.6,
"input_price_unit": "token",
"output_price_unit": "token"
}
}404
The model does not exist or your project cannot use it.
application/json
$ object Body
#/components/schemas/OpenAIModelNotFoundErrorerror object Required in parent
error.message string Required in parent"The model 'gpt-9' does not exist or you do not have access to it. List available models with GET /api/v1/models."error.type string Required in parent"invalid_request_error"error.param string Required in parent"model"error.code string Required in parent"model_not_in_catalog"OpenAPI response schema
{
"$ref": "#/components/schemas/OpenAIModelNotFoundError"
}OpenAPI source
The operation and referenced components below retain the complete OpenAPI definitions, including constraints and examples.
OpenAPI operation
{
"summary": "Get a model",
"operationId": "getModel",
"tags": [
"Models"
],
"description": "Returns one model, in the same format as the model list.\n\nReturns `404` if the model does not exist or your project cannot use it.",
"parameters": [
{
"name": "model",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The model ID, as returned in `id`. IDs can contain slashes, such as `openrouter/openai/gpt-4o`.",
"example": "gpt-4o-mini"
}
],
"responses": {
"200": {
"description": "The model.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenAIModel"
},
"example": {
"id": "gpt-4o-mini",
"object": "model",
"created": 1721260800,
"owned_by": "openai",
"context_length": 128000,
"pricing": {
"input_cost": 0.15,
"output_cost": 0.6,
"input_price_unit": "token",
"output_price_unit": "token"
}
}
}
}
},
"404": {
"description": "The model does not exist or your project cannot use it.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenAIModelNotFoundError"
}
}
}
}
},
"security": [
{},
{
"RespanApiKey": []
}
]
}OpenAPI path metadata
{}Referenced OpenAPI components
{
"schemas": {
"OpenAIModel": {
"type": "object",
"required": [
"id",
"object",
"created",
"owned_by",
"context_length",
"pricing"
],
"properties": {
"id": {
"type": "string",
"description": "Model ID. Send it as `model` in gateway requests.",
"example": "gpt-4o-mini"
},
"object": {
"type": "string",
"enum": [
"model"
],
"example": "model"
},
"created": {
"type": "integer",
"description": "Release date as a Unix timestamp, or `0` if unknown.",
"example": 1721260800
},
"owned_by": {
"type": "string",
"description": "The organization that develops the model.",
"example": "openai"
},
"context_length": {
"type": "integer",
"nullable": true,
"description": "Context window in tokens, or `null` if unknown.",
"example": 128000
},
"pricing": {
"$ref": "#/components/schemas/OpenAIModelPricing"
}
}
},
"OpenAIModelNotFoundError": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"required": [
"message",
"type",
"param",
"code"
],
"properties": {
"message": {
"type": "string",
"example": "The model 'gpt-9' does not exist or you do not have access to it. List available models with GET /api/v1/models."
},
"type": {
"type": "string",
"example": "invalid_request_error"
},
"param": {
"type": "string",
"example": "model"
},
"code": {
"type": "string",
"example": "model_not_in_catalog"
}
}
}
}
},
"OpenAIModelPricing": {
"type": "object",
"description": "Prices in USD.",
"required": [
"input_cost",
"output_cost",
"input_price_unit",
"output_price_unit"
],
"properties": {
"input_cost": {
"type": "number",
"nullable": true,
"description": "Input price per `input_price_unit`, after the Respan discount and the time-of-day schedule in effect now. Token and character prices are per 1M.",
"example": 0.15
},
"output_cost": {
"type": "number",
"nullable": true,
"description": "Output price per `output_price_unit`, after the Respan discount and the time-of-day schedule in effect now. Token and character prices are per 1M.",
"example": 0.6
},
"input_price_unit": {
"type": "string",
"enum": [
"token",
"image",
"second",
"minute",
"hour",
"character"
],
"description": "Unit for `input_cost`.",
"example": "token"
},
"output_price_unit": {
"type": "string",
"enum": [
"token",
"image",
"second",
"minute",
"hour",
"character"
],
"description": "Unit for `output_cost`.",
"example": "token"
}
}
}
},
"securitySchemes": {
"RespanApiKey": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "Respan API key",
"description": "Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.",
"x-fern-bearer": {
"name": "respanApiKey",
"env": "RESPAN_API_KEY"
}
}
}
}