@agentskit/adapters β Variables
API variables for @agentskit/adapters.
#Variable: azureOpenAIAdapter
constazureOpenAIAdapter: (config) =>AdapterFactory=azureOpenAI
Defined in: packages/adapters/src/azure-openai.ts:82
Creates an adapter for Azure OpenAI chat completions.
Creates an adapter for Azure OpenAI chat completions.
#Parameters
#config
Adapter configuration.
#Returns
AdapterFactory
An AgentsKit adapter factory.
#Example
const adapter = azureOpenAI({ apiKey: 'β¦', endpoint: 'https://example.openai.azure.com', deployment: 'chat' })#Param
config
Adapter configuration.
#Returns
An AgentsKit adapter factory.
#Variable: bailAdapter
constbailAdapter: (config) =>AdapterFactory=bail
Defined in: packages/adapters/src/bail.ts:43
Creates an adapter that fails with a configured error.
Alibaba Bailian (Qwen) via the DashScope OpenAI-compatibility endpoint.
Supports the Qwen-2.5 / 3 chat series and Qwen-VL multimodal models. APAC users typically prefer this over OpenAI for latency + data residency.
Default model: qwen-max.
#Parameters
#config
Partial<BailConfig> & object
#Returns
AdapterFactory
#Param
config
Adapter configuration.
#Returns
An AgentsKit adapter factory.
#Variable: bedrockAdapter
constbedrockAdapter: (config) =>AdapterFactory=bedrock
Defined in: packages/adapters/src/bedrock.ts:279
Creates an adapter for Amazon Bedrock Converse streaming.
Creates an adapter for Amazon Bedrock Converse streaming.
#Parameters
#config
Adapter configuration.
#Returns
AdapterFactory
An AgentsKit adapter factory.
#Example
const adapter = bedrock({ model: 'anthropic.claude-3-5-sonnet-20241022-v2:0' })#Variable: cerebrasAdapter
constcerebrasAdapter: (config) =>AdapterFactory=cerebras
Defined in: packages/adapters/src/cerebras.ts:43
Creates an adapter for Cerebras chat completions.
Cerebras β ultra-fast inference on wafer-scale chips. OpenAI-compatible endpoint serving Llama / Qwen models with very low first-token latency.
Default model: llama-3.3-70b.
#Parameters
#config
Partial<CerebrasConfig> & object
#Returns
AdapterFactory
#Param
config
Adapter configuration.
#Returns
An AgentsKit adapter factory.
#Example
const adapter = cerebrasAdapter({ apiKey: 'β¦', model: 'model-name' })#Variable: CLIPROXYAPI_DEFAULT_BASE_URL
constCLIPROXYAPI_DEFAULT_BASE_URL:"http://127.0.0.1:8317/v1"='http://127.0.0.1:8317/v1'
Defined in: packages/adapters/src/provider.ts:12
Default CLIProxyAPI local endpoint (OpenAI-compatible).
#Variable: cohereAdapter
constcohereAdapter: (config) =>AdapterFactory=cohere
Defined in: packages/adapters/src/cohere.ts:42
Alias for naming consistency with other native adapters.
Cohere Command models via Cohere's OpenAI-compatibility endpoint.
- Streams tokens via SSE (OpenAI-compatible chunks).
- Supports tool calls in the OpenAI
toolsshape. - Reports
usageon the final stream chunk when the upstream model returns it (Cohere's compatibility layer mirrors OpenAI'sstream_options: \{ include_usage: true \}semantics). - Inherits auto-retry from the shared OpenAI core (
retry).
Default model: command-r-plus. Override via model.
#Parameters
#config
Partial<CohereConfig> & object
#Returns
AdapterFactory
#Variable: deepseek
constdeepseek: (config) =>AdapterFactory
Defined in: packages/adapters/src/deepseek.ts:16
Creates an adapter for DeepSeek chat completions.
#Parameters
#config
Adapter configuration.
#Returns
AdapterFactory
An AgentsKit adapter factory.
#Example
const adapter = deepseek({ apiKey: 'β¦', model: 'model-name' })#Variable: deepseekEmbedder
constdeepseekEmbedder: (config) =>EmbedFn
Defined in: packages/adapters/src/embedders/deepseek.ts:13
Creates an embedder for DeepSeek embeddings.
#Parameters
#config
OpenAICompatibleEmbedderConfig
Embedder configuration.
#Returns
EmbedFn
An embedding function.
#Variable: DEFAULT_CARBON_TABLE
constDEFAULT_CARBON_TABLE:CarbonTable
Defined in: packages/adapters/src/carbon.ts:34
Default carbon table. Keys are provider:region; values are
estimated gCO2eq per 1k tokens of typical mixed input/output. Lower
is greener.
#Variable: DEFAULT_DEPRECATION_TABLE
constDEFAULT_DEPRECATION_TABLE:ModelDeprecation[]
Defined in: packages/adapters/src/deprecation.ts:50
Known deprecations (current as of AgentsKit shipping). Bump on each release; PRs welcome. Successor picks lean towards the same provider's current default unless the entire family is gone.
#Variable: fireworks
constfireworks: (config) =>AdapterFactory
Defined in: packages/adapters/src/fireworks.ts:12
Fireworks AI. OpenAI-compatible endpoint with tuned open-source models and fine-tunes (Llama, DeepSeek, Qwen, etc.).
#Parameters
#config
#Returns
AdapterFactory
#Variable: grok
constgrok: (config) =>AdapterFactory
Defined in: packages/adapters/src/grok.ts:16
Creates an adapter for xAI Grok chat completions.
#Parameters
#config
Adapter configuration.
#Returns
AdapterFactory
An AgentsKit adapter factory.
#Example
const adapter = grok({ apiKey: 'β¦', model: 'model-name' })#Variable: grokEmbedder
constgrokEmbedder: (config) =>EmbedFn
Defined in: packages/adapters/src/embedders/grok.ts:13
Creates an embedder for xAI embeddings.
#Parameters
#config
OpenAICompatibleEmbedderConfig
Embedder configuration.
#Returns
EmbedFn
An embedding function.
#Variable: groqAdapter
constgroqAdapter: (config) =>AdapterFactory=groq
Defined in: packages/adapters/src/groq.ts:36
Alias for naming consistency with other native adapters.
Groq β OpenAI-compatible endpoint serving Llama / Mixtral on LPUs. Known for very low first-token latency.
Default model: openai/gpt-oss-120b.
#Parameters
#config
Partial<GroqConfig> & object
#Returns
AdapterFactory
#Variable: huggingface
consthuggingface: (config) =>AdapterFactory
Defined in: packages/adapters/src/huggingface.ts:14
Hugging Face Inference Providers router. OpenAI-compatible
endpoint that fans out to HF-hosted model inference providers.
Pass any supported repo id as model, e.g.
meta-llama/Meta-Llama-3.1-8B-Instruct.
#Parameters
#config
#Returns
AdapterFactory
#Variable: kimi
constkimi: (config) =>AdapterFactory
Defined in: packages/adapters/src/kimi.ts:16
Creates an adapter for Moonshot Kimi chat completions.
#Parameters
#config
Adapter configuration.
#Returns
AdapterFactory
An AgentsKit adapter factory.
#Example
const adapter = kimi({ apiKey: 'β¦', model: 'model-name' })#Variable: kimiEmbedder
constkimiEmbedder: (config) =>EmbedFn
Defined in: packages/adapters/src/embedders/kimi.ts:13
Creates an embedder for Moonshot Kimi embeddings.
#Parameters
#config
OpenAICompatibleEmbedderConfig
Embedder configuration.
#Returns
EmbedFn
An embedding function.
#Variable: llamacpp
constllamacpp: (config) =>AdapterFactory
Defined in: packages/adapters/src/llamacpp.ts:12
llama.cpp's OpenAI-compatible HTTP server (llama-server). Defaults
to http://localhost:8080/v1, matching the binary's default port.
#Parameters
#config
#Returns
AdapterFactory
#Variable: lmstudio
constlmstudio: (config) =>AdapterFactory
Defined in: packages/adapters/src/lmstudio.ts:13
LM Studio local server. Start the built-in OpenAI-compatible
server in LM Studio, then point this adapter at
http://localhost:1234/v1 (the default).
#Parameters
#config
#Returns
AdapterFactory
#Variable: mistral
constmistral: (config) =>AdapterFactory
Defined in: packages/adapters/src/mistral.ts:13
Mistral AI. Uses the OpenAI-compatible chat completions endpoint.
Default models: mistral-large-latest, mistral-small-latest,
open-mistral-nemo.
#Parameters
#config
#Returns
AdapterFactory
#Variable: openrouter
constopenrouter: (config) =>AdapterFactory
Defined in: packages/adapters/src/openrouter.ts:14
OpenRouter β routes to 300+ provider models behind a single
OpenAI-compatible endpoint. Pass the fully-qualified id as
model, e.g. anthropic/claude-sonnet-4-6.
#Parameters
#config
#Returns
AdapterFactory
#Variable: openRouter
constopenRouter: (config) =>AdapterFactory=openrouter
Defined in: packages/adapters/src/openrouter.ts:17
Camel-case alias for the existing OpenRouter factory.
#Parameters
#config
#Returns
AdapterFactory
#Variable: qwen
constqwen: (config) =>AdapterFactory=bail
Defined in: packages/adapters/src/bail.ts:45
Alias matching Alibaba's product naming.
Alibaba Bailian (Qwen) via the DashScope OpenAI-compatibility endpoint.
Supports the Qwen-2.5 / 3 chat series and Qwen-VL multimodal models. APAC users typically prefer this over OpenAI for latency + data residency.
Default model: qwen-max.
#Parameters
#config
Partial<BailConfig> & object
#Returns
AdapterFactory
#Variable: replicateAdapter
constreplicateAdapter: (config) =>AdapterFactory=replicate
Defined in: packages/adapters/src/replicate.ts:154
Creates an adapter for Replicate streaming predictions.
Creates an adapter for Replicate streaming predictions.
#Parameters
#config
Adapter configuration.
#Returns
AdapterFactory
An AgentsKit adapter factory.
#Example
const adapter = replicate({ apiKey: 'β¦', model: 'model-name' })#Param
config
Adapter configuration.
#Returns
An AgentsKit adapter factory.
#Variable: together
consttogether: (config) =>AdapterFactory
Defined in: packages/adapters/src/together.ts:12
Together AI. OpenAI-compatible endpoint, broad open-model catalog (Llama, Qwen, DeepSeek, Mixtral, etc.).
#Parameters
#config
#Returns
AdapterFactory
#Variable: vertexAdapter
constvertexAdapter: (config) =>AdapterFactory=vertex
Defined in: packages/adapters/src/vertex.ts:92
Creates an adapter for Vertex AI Gemini streaming.
Creates an adapter for Vertex AI Gemini streaming.
#Parameters
#config
Adapter configuration.
#Returns
AdapterFactory
An AgentsKit adapter factory.
#Example
const adapter = vertex({ project: 'my-project', region: 'us-central1', model: 'gemini-2.5-pro' })#Param
config
Adapter configuration.
#Returns
An AgentsKit adapter factory.
#Variable: vllm
constvllm: (config) =>AdapterFactory
Defined in: packages/adapters/src/vllm.ts:12
vLLM's OpenAI-compatible serving endpoint. Defaults to
http://localhost:8000/v1 β the standard vllm serve ... port.
#Parameters
#config
#Returns
AdapterFactory
#Variable: webllmAdapter
constwebllmAdapter: (config) =>AdapterFactory=webllm
Defined in: packages/adapters/src/webllm.ts:160
Creates an adapter for WebLLM chat generation.
Creates an adapter for WebLLM chat generation.
#Parameters
#config
Adapter configuration.
#Returns
AdapterFactory
An AgentsKit adapter factory.
#Example
const adapter = webllm({ model: 'Llama-3.1-8B-Instruct-q4f16_1-MLC' })#Param
config
Adapter configuration.
#Returns
An AgentsKit adapter factory.