# ![CloudFerro Sherlock logo](https://models.dev/logos/cloudferro-sherlock.svg)CloudFerro Sherlock

Access 5 CloudFerro Sherlock models through Mastra's model router. Authentication is handled automatically using the `CLOUDFERRO_SHERLOCK_API_KEY` environment variable.

Learn more in the [CloudFerro Sherlock documentation](https://docs.sherlock.cloudferro.com/).

```bash
CLOUDFERRO_SHERLOCK_API_KEY=your-api-key
```

```typescript
import { Agent } from "@mastra/core/agent";

const agent = new Agent({
  id: "my-agent",
  name: "My Agent",
  instructions: "You are a helpful assistant",
  model: "cloudferro-sherlock/MiniMaxAI/MiniMax-M2.5"
});

// Generate a response
const response = await agent.generate("Hello!");

// Stream a response
const stream = await agent.stream("Tell me a story");
for await (const chunk of stream) {
  console.log(chunk);
}
```

> **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [CloudFerro Sherlock documentation](https://docs.sherlock.cloudferro.com/) for details.

## Models

| Model                                                     | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
| --------------------------------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
| `cloudferro-sherlock/meta-llama/Llama-3.3-70B-Instruct`   | 70K     |       |           |       |       |       | $3         | $3          |
| `cloudferro-sherlock/MiniMaxAI/MiniMax-M2.5`              | 196K    |       |           |       |       |       | $0.30      | $1          |
| `cloudferro-sherlock/openai/gpt-oss-120b`                 | 131K    |       |           |       |       |       | $3         | $3          |
| `cloudferro-sherlock/speakleash/Bielik-11B-v2.6-Instruct` | 32K     |       |           |       |       |       | $0.67      | $0.67       |
| `cloudferro-sherlock/speakleash/Bielik-11B-v3.0-Instruct` | 32K     |       |           |       |       |       | $0.67      | $0.67       |

## Advanced configuration

### Custom headers

```typescript
const agent = new Agent({
  id: "custom-agent",
  name: "custom-agent",
  model: {
    url: "https://api-sherlock.cloudferro.com/openai/v1/",
    id: "cloudferro-sherlock/MiniMaxAI/MiniMax-M2.5",
    apiKey: process.env.CLOUDFERRO_SHERLOCK_API_KEY,
    headers: {
      "X-Custom-Header": "value"
    }
  }
});
```

### Dynamic model selection

```typescript
const agent = new Agent({
  id: "dynamic-agent",
  name: "Dynamic Agent",
  model: ({ requestContext }) => {
    const useAdvanced = requestContext.task === "complex";
    return useAdvanced
      ? "cloudferro-sherlock/speakleash/Bielik-11B-v3.0-Instruct"
      : "cloudferro-sherlock/MiniMaxAI/MiniMax-M2.5";
  }
});
```