Calling a Standard Vault over the API

Once your Standard Vault is set up in the Model Vault app, use the Vault endpoint URL and model name shown in the model card (see Managing Vaults) in your API calls. You authenticate with your Cohere API key.

You can call a Standard Vault three ways: the Cohere SDK, raw HTTP, or an OpenAI-compatible client. In every case you point the request directly at your vault endpoint instead of the default Cohere API base URL.

Cohere SDK

Point the Cohere SDK at your vault endpoint with base_url:

1
import cohere
2
3
co = cohere.ClientV2(
4
    api_key="<COHERE_API_KEY>",
5
    base_url="<YOUR_VAULT_ENDPOINT_URL>",
6
)
7
8
response = co.chat(
9
    model="<YOUR_VAULT_MODEL_NAME>",
10
    messages=[{"role": "user", "content": "Hello from Model Vault!"}],
11
)
12
13
print(response.message.content[0].text)

Raw HTTP

If you don’t use the SDK, call the vault endpoint directly over HTTP. Send your API key as a bearer token and use the same request body as the Cohere API:

$
curl "<YOUR_VAULT_ENDPOINT_URL>/v2/chat" \
>
  -H "Authorization: bearer <COHERE_API_KEY>" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "model": "<YOUR_VAULT_MODEL_NAME>",
>
    "messages": [{"role": "user", "content": "Hello from Model Vault!"}]
>
  }'

OpenAI-compatible API

For existing OpenAI integrations, point an OpenAI-compatible client at your vault’s compatibility base URL (<YOUR_VAULT_ENDPOINT_URL>/compatibility/v1) and use your Cohere API key:

1
from openai import OpenAI
2
3
client = OpenAI(
4
    api_key="<COHERE_API_KEY>",
5
    base_url="<YOUR_VAULT_ENDPOINT_URL>/compatibility/v1",
6
)
7
8
response = client.chat.completions.create(
9
    model="<YOUR_VAULT_MODEL_NAME>",
10
    messages=[{"role": "user", "content": "Hello from Model Vault!"}],
11
)
12
13
print(response.choices[0].message.content)

Chat, Embed, and Rerank

The chat example above points the SDK at your vault. Embed and Rerank requests work the same way: keep the base_url pointed at your vault endpoint and call co.embed(...) or co.rerank(...) with your vault’s model name.

Next steps

• Calling an Encrypted Vault over the API
• Managing Vaults
• Monitoring