> This page is also available as Markdown: append .md to its URL. The full index of Sikaru docs is at https://docs.sikaru.ai/llms.txt. Code examples use only operations from the public API reference at https://docs.sikaru.ai/api-reference.

# Model

GET https://api.sikaru.ai/v1/models/{model}

Reference: https://docs.sikaru.ai/api-reference/models/retrieve

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `model` (string, required)

## Response

### 200

Successful Response

- `created` (integer, required)
- `display_name` (string, required)
- `id` (string, required)
- `object` ("model", required)
- `owned_by` (string, required)
- `pricing` (ModelPricing, required) — US dollars per million tokens.
- `specs` (ModelSpecs, required) — What a model accepts: limits, modalities, endpoints, reasoning controls and supported parameters.
- `deprecation_date` (date, optional, nullable)

## Types

### ModelPricing

US dollars per million tokens.

- `input_usd_per_mtok` (double, required)
- `output_usd_per_mtok` (double, required)
- `cache_read_usd_per_mtok` (double, optional, nullable)

### ModelSpecs

What a model accepts: limits, modalities, endpoints, reasoning controls and supported parameters.

- `context_window` (integer, required)
- `endpoints` (list of enum, required)
  - Allowed values: `chat`, `completions`, `responses`
- `max_output_tokens` (integer, required)
- `modalities` (Modalities, required)
- `reasoning` (PublishedReasoning, required, nullable) — A model's reasoning declaration plus what each standard effort value runs at.
- `supported_parameters` (list of string, required)
- `supports_reasoning` (boolean, required)
- `sampling_defaults` (SamplingDefaults, optional, nullable) — The model lab's recommended sampling; a request that omits a value runs at it.

### Modalities

- `input` (list of string, required)
- `output` (list of string, required)

### PublishedReasoning

A model's reasoning declaration plus what each standard effort value runs at.

- `normalization` (map from string to enum, required)
  - Allowed values: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`
- `budget` (boolean, optional, default: false)
- `default_effort` (enum, optional, nullable)
  - Allowed values: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`
- `default_history` (enum, optional, nullable)
  - Allowed values: `disabled`, `interleaved`, `preserved`
- `efforts` (list of enum, optional, default: [])
  - Allowed values: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`
- `history` (list of enum, optional, default: [])
  - Allowed values: `disabled`, `interleaved`, `preserved`
- `summary` (boolean, optional, default: false)

### SamplingDefaults

The model lab's recommended sampling; a request that omits a value runs at it.

- `min_p` (double, optional, nullable)
- `temperature` (double, optional, nullable)
- `top_k` (integer, optional, nullable)
- `top_p` (double, optional, nullable)

## Examples

**Response**

```json
{
  "created": 1,
  "display_name": "string",
  "id": "string",
  "object": "string",
  "owned_by": "string",
  "pricing": {
    "input_usd_per_mtok": 1.1,
    "output_usd_per_mtok": 1.1,
    "cache_read_usd_per_mtok": 1.1
  },
  "specs": {
    "context_window": 1,
    "endpoints": [
      "chat"
    ],
    "max_output_tokens": 1,
    "modalities": {
      "input": [
        "string"
      ],
      "output": [
        "string"
      ]
    },
    "reasoning": {
      "normalization": {},
      "budget": false,
      "default_effort": "none",
      "default_history": "disabled",
      "efforts": [
        "none"
      ],
      "history": [
        "disabled"
      ],
      "summary": false
    },
    "supported_parameters": [
      "string"
    ],
    "supports_reasoning": true,
    "sampling_defaults": {
      "min_p": 0.5,
      "temperature": 1.1,
      "top_k": 1,
      "top_p": 0.5
    }
  },
  "deprecation_date": "2023-01-15"
}
```

**SDK Code**

```python
import requests

url = "https://api.sikaru.ai/v1/models/model"

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.sikaru.ai/v1/models/model';
const options = {method: 'GET', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sikaru.ai/v1/models/model"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sikaru.ai/v1/models/model")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.sikaru.ai/v1/models/model")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sikaru.ai/v1/models/model', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sikaru.ai/v1/models/model");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sikaru.ai/v1/models/model")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```