Skip to content
zidane
SDK reference

zidane/providers/cerebras

The Cerebras provider for open models hosted on Cerebras.

import { … } from 'zidane/providers/cerebras'src/providers/cerebras.ts

Use cerebras() when your agent runs on Cerebras. It reads CEREBRAS_API_KEY when you pass no key. It wraps openaiCompat(), so it uses the OpenAI-compatible API. See Providers.

TypeScript
import { createAgent } from 'zidane'
import { cerebras } from 'zidane/providers/cerebras'

const agent = createAgent({ provider: cerebras({ defaultModel: 'gpt-oss-120b' }) })
const stats = await agent.run({ prompt: 'Summarize README.md in three bullets.' })
console.log(stats.turns)

Functions#

cerebrasFunction#

Cerebras provider.

Thin wrapper around openaiCompat with Cerebras-specific defaults (base URL, default model).

TypeScript
function cerebras(params?: CerebrasParams): Provider

Parameters

Parameters
NameTypeDescription
params?CerebrasParams

API key, default model, capabilities and extra headers.

Returns

Provider

Example

Example
import { createAgent } from 'zidane'
import { cerebras } from 'zidane/providers/cerebras'

const agent = createAgent({
  provider: cerebras({ apiKey: process.env.CEREBRAS_API_KEY }),
})
await agent.run({ prompt: 'Say hello.' })

src/providers/cerebras.ts:61

Interfaces#

CerebrasParamsInterface#

Options for cerebras.

TypeScript
interface CerebrasParams

Properties

CerebrasParams properties
NameTypeDefaultDescription
apiKey?string

API key. Falls back to the CEREBRAS_API_KEY environment variable.

capabilities?ProviderCapabilities

Provider capability flags. Cerebras currently serves text-only OSS models (GLM, Llama-family, Qwen-family) — default: { vision: false, imageInToolResult: false }. Override when routing to a vision-capable deployment.

defaultModel?string'gpt-oss-120b'

Model used when a request does not set one.

extraHeaders?Record<string, string>

Extra HTTP headers sent on every request. Forwarded to the underlying openaiCompat client — use for routing/attribution headers a proxy in front of baseURL consumes.

src/providers/cerebras.ts:7