api-20261005T180724Z / page 2 of 3 / documentation capture

api/organization Changed · +6 / -0 lines

from line 5839

58395839

58405840 default: false

58415841

5842- `include_default: optional boolean`

5843

5844 Whether to include the organization's default Workspace in the response

5845

5846 default: false

5847

58425848- `limit: optional number`

58435849

58445850 Number of items to return per page.

api/organization/workspaces Changed · +6 / -0 lines

from line 27

2727

2828 default: false

2929

30- `include_default: optional boolean`

31

32 Whether to include the organization's default Workspace in the response

33

34 default: false

35

3036- `limit: optional number`

3137

3238 Number of items to return per page.

api/organization/workspaces/list Changed · +6 / -0 lines

from line 25

2525

2626 default: false

2727

28- `include_default: optional boolean`

29

30 Whether to include the organization's default Workspace in the response

31

32 default: false

33

2834- `limit: optional number`

2935

3036 Number of items to return per page.

build-with-claude/claude-in-amazon-bedrock Changed · +4 / -4 lines

from line 102

102102 <Tabs>

103103 <Tab title="Gradle">

104104 ```kotlin

105 implementation("com.anthropic:anthropic-java:2.67.0")

106 implementation("com.anthropic:anthropic-java-bedrock:2.67.0")

105 implementation("com.anthropic:anthropic-java:2.68.0")

106 implementation("com.anthropic:anthropic-java-bedrock:2.68.0")

107107 ```

108108 </Tab>

109109

from line 112

112112 <dependency>

113113 <groupId>com.anthropic</groupId>

114114 <artifactId>anthropic-java</artifactId>

115 <version>2.67.0</version>

115 <version>2.68.0</version>

116116 </dependency>

117117 <dependency>

118118 <groupId>com.anthropic</groupId>

119119 <artifactId>anthropic-java-bedrock</artifactId>

120 <version>2.67.0</version>

120 <version>2.68.0</version>

121121 </dependency>

122122 ```

123123 </Tab>

build-with-claude/claude-in-microsoft-foundry Changed · +4 / -4 lines

from line 80

8080 <Tabs>

8181 <Tab title="Gradle">

8282 ```kotlin

83 implementation("com.anthropic:anthropic-java:2.67.0")

84 implementation("com.anthropic:anthropic-java-foundry:2.67.0")

83 implementation("com.anthropic:anthropic-java:2.68.0")

84 implementation("com.anthropic:anthropic-java-foundry:2.68.0")

8585

8686 // For Entra ID authentication, also add the Azure Identity library

8787 implementation("com.azure:azure-identity:1.18.3")

from line 93

9393 <dependency>

9494 <groupId>com.anthropic</groupId>

9595 <artifactId>anthropic-java</artifactId>

96 <version>2.67.0</version>

96 <version>2.68.0</version>

9797 </dependency>

9898 <dependency>

9999 <groupId>com.anthropic</groupId>

100100 <artifactId>anthropic-java-foundry</artifactId>

101 <version>2.67.0</version>

101 <version>2.68.0</version>

102102 </dependency>

103103

104104 <dependency>

build-with-claude/claude-on-amazon-bedrock-legacy Changed · +4 / -4 lines

from line 54

5454 <Tab title="Java">

5555 <CodeGroup>

5656 ```groovy Gradle

57 implementation("com.anthropic:anthropic-java:2.67.0")

58 implementation("com.anthropic:anthropic-java-bedrock:2.67.0")

57 implementation("com.anthropic:anthropic-java:2.68.0")

58 implementation("com.anthropic:anthropic-java-bedrock:2.68.0")

5959 ```

6060

6161 ```xml Maven

from line 62

6262 <dependency>

6363 <groupId>com.anthropic</groupId>

6464 <artifactId>anthropic-java</artifactId>

65 <version>2.67.0</version>

65 <version>2.68.0</version>

6666 </dependency>

6767 <dependency>

6868 <groupId>com.anthropic</groupId>

6969 <artifactId>anthropic-java-bedrock</artifactId>

70 <version>2.67.0</version>

70 <version>2.68.0</version>

7171 </dependency>

7272 ```

7373

build-with-claude/claude-on-vertex-ai Changed · +4 / -4 lines

from line 45

4545 <Tab title="Java">

4646 <CodeGroup exclude="shell, python, typescript, csharp, go, php, ruby">

4747 ```groovy Gradle

48 implementation("com.anthropic:anthropic-java:2.67.0")

49 implementation("com.anthropic:anthropic-java-vertex:2.67.0")

48 implementation("com.anthropic:anthropic-java:2.68.0")

49 implementation("com.anthropic:anthropic-java-vertex:2.68.0")

5050 ```

5151

5252 ```xml Maven

from line 53

5353 <dependency>

5454 <groupId>com.anthropic</groupId>

5555 <artifactId>anthropic-java</artifactId>

56 <version>2.67.0</version>

56 <version>2.68.0</version>

5757 </dependency>

5858 <dependency>

5959 <groupId>com.anthropic</groupId>

6060 <artifactId>anthropic-java-vertex</artifactId>

61 <version>2.67.0</version>

61 <version>2.68.0</version>

6262 </dependency>

6363 ```

6464

build-with-claude/claude-platform-on-aws Changed · +4 / -4 lines

from line 305

305305

306306 <Tab title="Java">

307307 ```kotlin Gradle

308 implementation("com.anthropic:anthropic-java:2.67.0")

309 implementation("com.anthropic:anthropic-java-aws:2.67.0")

308 implementation("com.anthropic:anthropic-java:2.68.0")

309 implementation("com.anthropic:anthropic-java-aws:2.68.0")

310310 ```

311311

312312 ```xml Maven

from line 313

313313 <dependency>

314314 <groupId>com.anthropic</groupId>

315315 <artifactId>anthropic-java</artifactId>

316 <version>2.67.0</version>

316 <version>2.68.0</version>

317317 </dependency>

318318 <dependency>

319319 <groupId>com.anthropic</groupId>

320320 <artifactId>anthropic-java-aws</artifactId>

321 <version>2.67.0</version>

321 <version>2.68.0</version>

322322 </dependency>

323323 ```

324324 </Tab>

build-with-claude/embeddings Changed · +91 / -75 lines

### Voyage AI Python library ### Voyage AI HTTP API ### Voyage Python library ### Voyage HTTP API

from line 14

1414

1515## How to get embeddings with Anthropic

1616

17Anthropic does not offer its own embedding model. One embeddings provider that has a wide variety of options and capabilities encompassing all of the preceding considerations is Voyage AI.

17Anthropic does not offer its own embedding model. One embeddings provider with a wide variety of models and capabilities is Voyage AI by MongoDB.

1818

19Voyage AI makes state-of-the-art embedding models and offers customized models for specific industry domains such as finance and healthcare, or bespoke fine-tuned models for individual customers.

19Voyage AI makes embedding models and rerankers. Its embedding models include general-purpose, multimodal, contextualized, and domain-specific models.

2020

2121The rest of this guide is for Voyage AI, but you should assess a variety of embeddings vendors to find the best fit for your specific use case.

2222

2323## Available models

2424

25Voyage recommends using the following text embedding models:

25Voyage AI offers the following text embedding models:

2626

27**Voyage 4 (latest generation)**

27**Latest generation**

2828

30| ---------------- | -------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

32| `voyage-4` | 32,000 | 1024 (default), 256, 512, 2048 | Optimized for general-purpose and multilingual retrieval quality. Balances quality and efficiency. See the [Voyage 4 blog post](https://blog.voyageai.com/2026/01/15/voyage-4/) for details. |

34| `voyage-4-nano` | 32,000 | 1024 (default), 256, 512, 2048 | Open-weight model (Apache 2.0 license) available on Hugging Face. See the [Voyage 4 blog post](https://blog.voyageai.com/2026/01/15/voyage-4/) for details. |

30| ---------------- | -------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

32| `voyage-4` | 32,000 | 1024 (default), 256, 512, 2048 | Optimized for general-purpose and multilingual retrieval quality. Balances quality and efficiency. See the [Voyage 4 blog post](https://blog.voyageai.com/2026/01/15/voyage-4/) for details. |

34| `voyage-code-4` | 32,000 | 1024 (default), 256, 512, 2048 | Optimized for **code** retrieval and agentic coding applications. See the [voyage-code-4 blog post](https://blog.voyageai.com/2026/08/13/voyage-code-4/) for details. |

35| `voyage-4-nano` | 32,000 | 2048 (default), 256, 512, 1024 | Open-weight model (Apache 2.0 license) that you download from [Hugging Face](https://huggingface.co/voyageai/voyage-4-nano) and run yourself. Not available through the Atlas Embedding and Reranking API. See the [Voyage 4 blog post](https://blog.voyageai.com/2026/01/15/voyage-4/) for details. |

3536

3637**Previous generation**

3738

39| ------------------ | -------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

40| `voyage-3-large` | 32,000 | 1024 (default), 256, 512, 2048 | The best general-purpose and multilingual retrieval quality. See the [voyage-3-large blog post](https://blog.voyageai.com/2025/01/07/voyage-3-large/) for details. |

41| `voyage-3.5` | 32,000 | 1024 (default), 256, 512, 2048 | Optimized for general-purpose and multilingual retrieval quality. See the [voyage-3.5 blog post](https://blog.voyageai.com/2025/05/20/voyage-3-5/) for details. |

44| `voyage-finance-2` | 32,000 | 1024 | Optimized for **finance** retrieval and RAG. See the [voyage-finance-2 blog post](https://blog.voyageai.com/2024/06/03/domain-specific-embeddings-finance-edition-voyage-finance-2/) for details. |

45| `voyage-law-2` | 16,000 | 1024 | Optimized for **legal** and **long-context** retrieval and RAG. Also improved performance across all domains. See the [voyage-law-2 blog post](https://blog.voyageai.com/2024/04/15/domain-specific-embeddings-and-retrieval-legal-edition-voyage-law-2/) for details. |

39For each model's lifecycle status and recommended replacement, see [Model deprecations, lifecycle states, and support](https://www.mongodb.com/docs/voyageai/models/lifecycle/) in the MongoDB documentation.

4640

47Additionally, Voyage recommends the following multimodal embedding models:

42| ------------------ | -------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

47| `voyage-finance-2` | 32,000 | 1024 | Optimized for **finance** retrieval and RAG. See the [voyage-finance-2 blog post](https://blog.voyageai.com/2024/06/03/domain-specific-embeddings-finance-edition-voyage-finance-2/) for details. |

48| `voyage-law-2` | 16,000 | 1024 | Optimized for **legal** retrieval and RAG. See the [voyage-law-2 blog post](https://blog.voyageai.com/2024/04/15/domain-specific-embeddings-and-retrieval-legal-edition-voyage-law-2/) for details. |

4849

50Additionally, Voyage AI offers the following multimodal embedding models. Call these models with `multimodal_embed()` instead of `embed()`:

51

5053| ----------------------- | -------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

5154| `voyage-multimodal-3.5` | 32,000 | 1024 (default), 256, 512, 2048 | Rich multimodal embedding model that can vectorize interleaved text, images, and videos. Includes video support as the first production-grade video embedding model. See the [voyage-multimodal-3.5 blog post](https://blog.voyageai.com/2026/01/15/voyage-multimodal-3-5/) for details. |

52| `voyage-multimodal-3` | 32,000 | 1024 | Rich multimodal embedding model that can vectorize interleaved text and content-rich images, such as screenshots of PDFs, slides, tables, figures, and more. See the [voyage-multimodal-3 blog post](https://blog.voyageai.com/2024/11/12/voyage-multimodal-3/) for details. |

55| `voyage-multimodal-3` | 32,000 | 1024 | Previous generation of `voyage-multimodal-3.5`. Vectorizes interleaved text and content-rich images, such as screenshots of PDFs, slides, tables, figures, and more. See the [voyage-multimodal-3 blog post](https://blog.voyageai.com/2024/11/12/voyage-multimodal-3/) for details. |

5356

5457The following contextualized chunk embedding models produce chunk-level vectors that capture full document context without manual metadata augmentation. Call these models with `contextualized_embed()` instead of `embed()`:

5558

from line 59

5760| ------------------ | -------------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

5861| `voyage-context-4` | 120,000 | 1024 (default), 256, 512, 2048 | Contextualized chunk embeddings optimized for general-purpose and multilingual retrieval quality. See the [voyage-context-4 blog post](https://blog.voyageai.com/2026/06/29/voyage-context-4/) for details. |

59| `voyage-context-3` | 120,000 | 1024 (default), 256, 512, 2048 | Contextualized chunk embeddings optimized for general-purpose and multilingual retrieval quality. See the [voyage-context-3 blog post](https://blog.voyageai.com/2025/07/23/voyage-context-3/) for details. |

62| `voyage-context-3` | 120,000 | 1024 (default), 256, 512, 2048 | Previous generation of `voyage-context-4`. See the [voyage-context-3 blog post](https://blog.voyageai.com/2025/07/23/voyage-context-3/) for details. |

6063

64The 120,000-token limit applies when you set `enable_auto_chunking` to `true`. Otherwise, the total number of tokens across all inputs can't exceed 32,000.

65

6166Voyage AI also offers rerankers, which take a query and a list of documents and return them ranked by relevance to the query. Call these models with `rerank()`:

6267

63| Model | Context length | Description |

64| ----------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |

65| `rerank-2.5` | 32,000 | Highest accuracy. Recommended for most applications. See the [rerank-2.5 blog post](https://blog.voyageai.com/2025/08/11/rerank-2-5/) for details. |

66| `rerank-2.5-lite` | 32,000 | Optimized for latency and cost. See the [rerank-2.5 blog post](https://blog.voyageai.com/2025/08/11/rerank-2-5/) for details. |

68| Model | Context length | Description |

69| ----------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |

70| `rerank-3` | 32,000 | Highest accuracy. Recommended for most applications. See the [rerank-3 blog post](https://blog.voyageai.com/2026/09/30/rerank-3/) for details. |

71| `rerank-3-lite` | 32,000 | Optimized for latency and cost. See the [rerank-3 blog post](https://blog.voyageai.com/2026/09/30/rerank-3/) for details. |

72| `rerank-2.5` | 32,000 | Previous generation of `rerank-3`. See the [rerank-2.5 blog post](https://blog.voyageai.com/2025/08/11/rerank-2-5/) for details. |

73| `rerank-2.5-lite` | 32,000 | Previous generation of `rerank-3-lite`. See the [rerank-2.5 blog post](https://blog.voyageai.com/2025/08/11/rerank-2-5/) for details. |

6774

68Need help deciding which text embedding model to use? Check out the [Voyage AI FAQ](https://docs.voyageai.com/docs/faq#what-embedding-models-are-available-and-which-one-should-i-use\&ref=anthropic).

75Need help deciding which model to use? See [Voyage AI embedding and reranking models overview](https://www.mongodb.com/docs/voyageai/models/) in the MongoDB documentation.

6976

7077## Getting started with Voyage AI

7178

72To access Voyage embeddings:

79To access Voyage AI models, create a model API key in MongoDB Atlas:

7380

741. Sign up on Voyage AI's website.

752. Obtain an API key.

811. Sign up for a MongoDB Atlas account, or log in.

822. In your Atlas project, select **AI Model APIs** in the navigation bar, click **Create model API key**, name the key, and click **Create**.

76833. Set the API key as an environment variable for convenience:

7784

7885```bash

79export VOYAGE_API_KEY="<your secret key>"

86export VOYAGE_API_KEY="<your model API key>"

8087```

8188

82You can obtain the embeddings by either using the official [`voyageai` Python package](https://github.com/voyage-ai/voyageai-python) or HTTP requests, as described in the following sections.

89For more detail, see [Voyage AI quick start](https://www.mongodb.com/docs/voyageai/quickstart/) in the MongoDB documentation.

8390

84### Voyage Python library

91You can obtain the embeddings by either using the official [`voyageai` Python package](https://github.com/voyage-ai/voyageai-python) or HTTP requests, as described in the following sections. Voyage AI also has an official TypeScript client. To use it with a model API key from Atlas, set its `environment` option to `https://ai.mongodb.com/v1`, as described in [TypeScript client](https://www.mongodb.com/docs/voyageai/api-and-clients/#typescript-client) in the MongoDB documentation.

8592

86Install the `voyageai` package using the following command:

93### Voyage AI Python library

8794

95Install the `voyageai` package using the following command. To use a model API key from Atlas, you need version 0.3.7 or later.

96

8897```bash

8998pip install -U voyageai

9099```

from line 105

96105

97106vo = voyageai.Client()

98107# This will automatically use the environment variable VOYAGE_API_KEY.

99# Alternatively, you can use vo = voyageai.Client(api_key="<your secret key>")

108# Alternatively, you can use vo = voyageai.Client(api_key="<your model API key>")

100109

101110texts = ["Sample text 1", "Sample text 2"]

102111

from line 123

114123

115124When creating the embeddings, you can specify a few other arguments to the `embed()` function.

116125

117For more information on the Voyage Python package, see the [Voyage Python package documentation](https://docs.voyageai.com/docs/embeddings#python-api).

126For more information on the Python package, see [Accessing Voyage AI models](https://www.mongodb.com/docs/voyageai/api-and-clients/) in the MongoDB documentation.

118127

119### Voyage HTTP API

128### Voyage AI HTTP API

120129

121You can also get embeddings by requesting Voyage HTTP API. For example, you can send an HTTP request through the `curl` command in a terminal:

130You can also get embeddings by sending HTTP requests to the Atlas Embedding and Reranking API. For example, you can send an HTTP request through the `curl` command in a terminal:

122131

123132```bash cURL

124curl https://api.voyageai.com/v1/embeddings \

133curl https://ai.mongodb.com/v1/embeddings \

125134 -H "Content-Type: application/json" \

126135 -H "Authorization: Bearer $VOYAGE_API_KEY" \

127136 -d '{

128137 "input": ["Sample text 1", "Sample text 2"],

129 "model": "voyage-4"

138 "model": "voyage-4",

139 "input_type": "document"

130140 }'

131141```

132142

from line 147

137147 "object": "list",

138148 "data": [

139149 {

150 "object": "embedding",

140151 "embedding": [-0.013131560757756233, 0.019828535616397858 /* ... */],

141152 "index": 0

142153 },

143154 {

155 "object": "embedding",

144156 "embedding": [-0.0069352793507277966, 0.020878976210951805 /* ... */],

145157 "index": 1

146158 }

from line 164

152164}

153165```

154166

155For more information on the Voyage HTTP API, see the [Voyage HTTP API documentation](https://docs.voyageai.com/reference/embeddings-api).

167Model API keys from Atlas work with `ai.mongodb.com`, except keys scoped to a geography, which use that geography's endpoint. If you have an API key from the Voyage AI platform instead, see [Migrate your applications to use the Atlas Embedding and Reranking API](https://www.mongodb.com/docs/voyageai/tutorials/migrate-to-atlas/) in the MongoDB documentation.

156168

169For the full request and response reference, see [Create text embeddings](https://www.mongodb.com/docs/api/doc/atlas-embedding-and-reranking-api/operation/operation-createembedding) in the Atlas Embedding and Reranking API documentation.

170

157171### AWS Marketplace

158172

159Voyage embeddings are available on [AWS Marketplace](https://aws.amazon.com/marketplace/seller-profile?id=c9032c7b-70dd-459f-834f-c1e23cf3d092). Instructions for accessing Voyage on AWS are available in the [Voyage AWS Marketplace documentation](https://docs.voyageai.com/docs/aws-marketplace-mongodb-voyage?ref=anthropic).

173Voyage AI models are also available on AWS Marketplace through [MongoDB's seller profile](https://aws.amazon.com/marketplace/seller-profile?id=c9032c7b-70dd-459f-834f-c1e23cf3d092). For instructions, see [Deploy Voyage AI models using AWS Marketplace](https://www.mongodb.com/docs/voyageai/management/aws-marketplace/) in the MongoDB documentation.

160174

161175## Quickstart example

162176

from line 189

175189]

176190```

177191

178First, use Voyage to convert each document into an embedding vector.

192First, use Voyage AI to convert each document into an embedding vector.

179193

180194```python

181195import voyageai

from line 215

201215query_embd = vo.embed([query], model="voyage-4", input_type="query").embeddings[0]

202216

203217# Compute the similarity

204# Voyage embeddings are normalized to length 1, therefore dot-product

218# Voyage AI embeddings are normalized to length 1, so dot-product

205219# and cosine similarity are the same.

206220similarities = np.dot(doc_embds, query_embd)

207221

from line 223

209223print(documents[retrieved_id])

210224```

211225

212Note that `input_type="document"` and `input_type="query"` are used for embedding the document and query, respectively. More specification can be found in [Voyage Python library](https://platform.claude.com/docs/en/build-with-claude/embeddings#voyage-python-library).

226Note that `input_type="document"` and `input_type="query"` are used for embedding the document and query, respectively. For more about `input_type`, see [When and how should I use the input\_type parameter?](https://platform.claude.com/docs/en/build-with-claude/embeddings#faq) in the FAQ.

213227

214228The output is the fifth document, which is indeed the most relevant to the query:

215229

from line 236

222236## FAQ

223237

224238<AccordionGroup>

225 <Accordion title="Why do Voyage embeddings have superior quality?">

226 Embedding models rely on powerful neural networks to capture and compress semantic context, similar to generative models. Voyage's team of experienced AI researchers optimizes every component of the embedding process, including:

239 <Accordion title="Why do Voyage AI embeddings have superior quality?">

240 Embedding models rely on powerful neural networks to capture and compress semantic context, similar to generative models. Voyage AI's team of experienced AI researchers optimizes every component of the embedding process, including:

227241

228242 * Model architecture

229243 * Data collection

from line 244

230244 * Loss functions

231245 * Optimizer selection

232246

233 Learn more about Voyage's technical approach on the [Voyage AI blog](https://blog.voyageai.com/).

247 Learn more about Voyage AI's technical approach on the [Voyage AI blog](https://blog.voyageai.com/).

234248 </Accordion>

235249

236250 <Accordion title="What embedding models are available and which should I use?">

from line 259

245259 Domain-specific models:

246260

247261 * Legal tasks: `voyage-law-2`

248 * Code and programming documentation: `voyage-code-3`

262 * Code retrieval and agentic coding: `voyage-code-4`

249263 * Finance-related tasks: `voyage-finance-2`

250264

251265 For chunk-level and document-level retrieval: `voyage-context-4`

266

267 For text, images, and video: `voyage-multimodal-3.5`

252268 </Accordion>

253269

254270 <Accordion title="Which similarity function should I use?">

255 You can use Voyage embeddings with either dot-product similarity, cosine similarity, or Euclidean distance. For an explanation of embedding similarity, see this [vector similarity guide](https://www.pinecone.io/learn/vector-similarity/).

271 You can use Voyage AI embeddings with dot-product similarity, cosine similarity, or Euclidean distance. For an explanation of embedding similarity, see this [vector similarity guide](https://www.pinecone.io/learn/vector-similarity/).

256272

257273 Voyage AI embeddings are normalized to length 1, which means that:

258274

from line 277

261277 </Accordion>

262278

263279 <Accordion title="What is the relationship between characters, words, and tokens?">

264 See the [Voyage tokenization guide](https://docs.voyageai.com/docs/tokenization?ref=anthropic).

280 See [Tokenization](https://www.mongodb.com/docs/voyageai/tutorials/tokenization/) in the MongoDB documentation.

265281 </Accordion>

266282

267283 <Accordion title="When and how should I use the input_type parameter?">

from line 287

271287

272288 > 📘 **Prompts associated with `input_type`**

273289 >

274 > * For a query, the prompt is “Represent the query for retrieving supporting documents: “.

290 > * For a query, the prompt is `"Represent the query for retrieving supporting documents: "`.

275291 >

276 > * For a document, the prompt is “Represent the document for retrieval: “.

292 > * For a document, the prompt is `"Represent the document for retrieval: "`.

277293 >

278294 > * Example

279295 >

280 > * When `input_type="query"`, a query like "When is Apple's conference call scheduled?" will become "**Represent the query for retrieving supporting documents:** When is Apple's conference call scheduled?"

281 > * When `input_type="document"`, a query like "Apple's conference call to discuss fourth fiscal quarter results and business updates is scheduled for Thursday, November 2, 2023 at 2:00 p.m. PT / 5:00 p.m. ET." will become "**Represent the document for retrieval:** Apple's conference call to discuss fourth fiscal quarter results and business updates is scheduled for Thursday, November 2, 2023 at 2:00 p.m. PT / 5:00 p.m. ET."

282

283 `voyage-large-2-instruct`, as the name suggests, is trained to be responsive to additional instructions that are prepended to the input text. For classification, clustering, or other [MTEB](https://huggingface.co/mteb) subtasks, use the [voyage-large-2-instruct instructions](https://github.com/voyage-ai/voyage-large-2-instruct).

296 > * When `input_type="query"`, a query such as "When is Apple's conference call scheduled?" will become "**Represent the query for retrieving supporting documents:** When is Apple's conference call scheduled?"

297 > * When `input_type="document"`, a document such as "Apple's conference call to discuss fourth fiscal quarter results and business updates is scheduled for Thursday, November 2, 2023 at 2:00 p.m. PT / 5:00 p.m. ET." will become "**Represent the document for retrieval:** Apple's conference call to discuss fourth fiscal quarter results and business updates is scheduled for Thursday, November 2, 2023 at 2:00 p.m. PT / 5:00 p.m. ET."

284298 </Accordion>

285299

286300 <Accordion title="What quantization options are available?">

287 Quantization in embeddings converts high-precision values, such as 32-bit single-precision floating-point numbers, to lower-precision formats such as 8-bit integers or 1-bit binary values, reducing storage, memory, and costs by 4x and 32x, respectively. Supported Voyage models enable quantization by specifying the output data type with the `output_dtype` parameter:

301 Quantization in embeddings converts high-precision values, such as 32-bit single-precision floating-point numbers, to lower-precision formats such as 8-bit integers or 1-bit binary values, reducing storage, memory, and costs by 4x and 32x, respectively. Supported Voyage AI models enable quantization by specifying the output data type with the `output_dtype` parameter:

288302

289303 * `float`: Each returned embedding is a list of 32-bit (4-byte) single-precision floating-point numbers. This is the default and provides the highest precision / retrieval accuracy.

290304 * `int8` and `uint8`: Each returned embedding is a list of 8-bit (1-byte) integers ranging from -128 to 127 and 0 to 255, respectively.

291 * `binary` and `ubinary`: Each returned embedding is a list of 8-bit integers that represent bit-packed, quantized single-bit embedding values: `int8` for `binary` and `uint8` for `ubinary`. The length of the returned list of integers is 1/8 of the actual dimension of the embedding. The binary type uses the offset binary method, which you can learn more about in the [embeddings FAQ](https://platform.claude.com/docs/en/build-with-claude/embeddings#faq).

305 * `binary` and `ubinary`: Each returned embedding is a list of 8-bit integers that represent bit-packed, quantized single-bit embedding values: `int8` for `binary` and `uint8` for `ubinary`. The length of the returned list of integers is 1/8 of the actual dimension of the embedding. The binary type uses the offset binary method, as the following example shows.

292306

293307 > **Binary quantization example**

294308 >

from line 310

296310 >

297311 > * `ubinary`: The binary sequence is directly converted and represented as the unsigned integer (`uint8`) 77.

298312 > * `binary`: The binary sequence is represented as the signed integer (`int8`) -51, calculated using the offset binary method (77 - 128 = -51).

313

314 For the models that support each data type, see [Create text embeddings](https://www.mongodb.com/docs/api/doc/atlas-embedding-and-reranking-api/operation/operation-createembedding) in the Atlas Embedding and Reranking API documentation.

299315 </Accordion>

300316

301317 <Accordion title="How can I truncate Matryoshka embeddings?">

302 Matryoshka learning creates embeddings with coarse-to-fine representations within a single vector. Voyage models, such as `voyage-code-3`, that support multiple output dimensions generate such Matryoshka embeddings. You can truncate these vectors by keeping the leading subset of dimensions. For example, the following Python code demonstrates how to truncate 1024-dimensional vectors to 256 dimensions:

318 Matryoshka learning creates embeddings with coarse-to-fine representations within a single vector. Voyage AI models that support multiple output dimensions, such as `voyage-code-4`, generate such Matryoshka embeddings. To get shorter vectors from the API, pass `output_dimension` (for example, `output_dimension=256`). To shorten vectors you already stored, truncate them by keeping the leading subset of dimensions, then normalize them again. For example, the following Python code demonstrates how to truncate 1024-dimensional vectors to 256 dimensions:

303319

304320 ```python

305321 import voyageai

from line 335

319335

320336 vo = voyageai.Client()

321337

322 # Generate voyage-code-3 vectors, which by default are 1024-dimensional floating-point numbers

323 embd = vo.embed(["Sample text 1", "Sample text 2"], model="voyage-code-3").embeddings

338 # Generate voyage-code-4 vectors, which by default are 1024-dimensional floating-point numbers

339 embd = vo.embed(["Sample text 1", "Sample text 2"], model="voyage-code-4").embeddings

324340

325341 # Set shorter dimension

326342 short_dim = 256

from line 349

333349

334350## Pricing

335351

336Visit Voyage's [pricing page](https://docs.voyageai.com/docs/pricing?ref=anthropic) for the most up to date pricing details.

352For the most up-to-date pricing details, see [Model pricing](https://www.mongodb.com/docs/voyageai/management/billing/#model-pricing) in the MongoDB documentation.

337353

home Changed · +168 / -0 lines

from line 22

2222 <HomeQuickChip icon="CodeBrackets" href="https://platform.claude.com/docs/en/api/overview">

2323 API reference

2424 </HomeQuickChip>

25

26 ```python Python

27 import anthropic

28

29 client = anthropic.Anthropic()

30

31 message = client.messages.create(

32 model="claude-opus-5-5",

33 max_tokens=1024,

34 messages=[

35 {

36 "role": "user",

37 "content": "Hello, Claude",

38 }

39 ],

40 )

41 for block in message.content:

42 if block.type == "text":

43 print(block.text)

44 ```

45

46 ```typescript TypeScript

47 import Anthropic from "@anthropic-ai/sdk";

48

49 const client = new Anthropic();

50

51 const msg = await client.messages.create({

52 model: "claude-opus-5-5",

53 max_tokens: 1024,

54 messages: [

55 {

56 role: "user",

57 content: "Hello, Claude"

58 }

59 ]

60 });

61 for (const block of msg.content) {

62 if (block.type === "text") {

63 console.log(block.text);

64 }

65 }

66 ```

67

68 ```go Go

69 import "github.com/anthropics/anthropic-sdk-go"

70

71 client := anthropic.NewClient()

72 msg, _ := client.Messages.New(

73 context.TODO(),

74 anthropic.MessageNewParams{

75 Model: anthropic.ModelClaudeOpus5_5,

76 MaxTokens: 1024,

77 Messages: []anthropic.MessageParam{

78 anthropic.NewUserMessage(

79 anthropic.NewTextBlock("Hello, Claude"),

80 ),

81 },

82 },

83 )

84 for _, block := range msg.Content {

85 if textBlock, ok := block.AsAny().(anthropic.TextBlock); ok {

86 fmt.Println(textBlock.Text)

87 }

88 }

89 ```

90

91 ```java Java

92 import com.anthropic.client.okhttp.AnthropicOkHttpClient;

93

94 var client = AnthropicOkHttpClient

95 .fromEnv();

96

97 var msg = client.messages().create(

98 MessageCreateParams.builder()

99 .model("claude-opus-5-5")

100 .maxTokens(1024)

101 .addUserMessage("Hello, Claude")

102 .build()

103 );

104 for (var block : msg.content()) {

105 block.text().ifPresent(

106 textBlock -> System.out.println(textBlock.text()));

107 }

108 ```

109

110 ```ruby Ruby

111 require "anthropic"

112

113 client = Anthropic::Client.new

114

115 msg = client.messages.create(

116 model: "claude-opus-5-5",

117 max_tokens: 1024,

118 messages: [{

119 role: "user",

120 content: "Hello, Claude"

121 }]

122 )

123 msg.content.each do |block|

124 puts block.text if block.type == :text

125 end

126 ```

127

128 ```php PHP

129 use Anthropic\Client;

130

131 $client = new Client();

132

133 $message = $client->messages->create(

134 model: "claude-opus-5-5",

135 maxTokens: 1024,

136 messages: [['role' => 'user',

137 'content' => 'Hello, Claude']],

138 );

139 foreach ($message->content as $block) {

140 if ($block->type === 'text') {

141 echo $block->text, PHP_EOL;

142 }

143 }

144 ```

145

146 ```csharp C#

147 using Anthropic;

148

149 var client = new AnthropicClient();

150

151 var msg = await client.Messages

152 .Create(new() {

153 Model = "claude-opus-5-5",

154 MaxTokens = 1024,

155 Messages = [new() {

156 Role = Role.User,

157 Content = "Hello, Claude"

158 }]

159 });

160 foreach (var block in msg.Content)

161 {

162 if (block.TryPickText(out var textBlock))

163 {

164 Console.WriteLine(textBlock.Text);

165 }

166 }

167 ```

168

169 ```bash cURL

170 curl https://api.anthropic.com/v1/messages \

171 -H "content-type: application/json" \

172 -H "x-api-key: $ANTHROPIC_API_KEY" \

173 -H "anthropic-version: 2023-06-01" \

174 -d '{

175 "model": "claude-opus-5-5",

176 "max_tokens": 1024,

177 "messages": [{

178 "role": "user",

179 "content": "Hello, Claude"

180 }]

181 }'

182 ```

183

184 ```bash CLI

185 ant messages create \

186 --model claude-opus-5-5 \

187 --max-tokens 1024 \

188 --message '{

189 role: user,

190 content: "Hello, Claude"

191 }'

192 ```

25193 </HomeHero>

26194

27195 <HomeSection>

manage-claude/cmek Changed · +3 / -2 lines

from line 90

9090* Chat search is disabled because chat titles and content are encrypted under your key. Members cannot search past chats, and the **Search and reference chats** toggle stays off, so Claude cannot search them either.

9191* [Project knowledge search](https://support.claude.com/en/articles/11473015-retrieval-augmented-generation-rag-for-projects) (retrieval-augmented generation, or RAG) is disabled. Project knowledge loads directly into each conversation's context instead of being indexed and searched. As a result, a project can use substantially less knowledge than it could without CMEK. Knowledge beyond what can be loaded is left out of the conversation.

9292* Claude Code on the web and Claude in Slack are unavailable: new sessions cannot be started and Claude in Slack declines requests, even if an admin turns these products on. Claude Code Desktop remains available for local sessions but is off unless an admin turns it on under [claude.ai > Organization settings > Claude Code](https://claude.ai/admin-settings/claude-code).

93* Artifacts cannot be shared publicly, only within your organization.

94* Certain analytics are degraded: admin analytics for claude.ai skills and connectors (under claude.ai/analytics/usage and through the [Claude Enterprise Analytics API](https://platform.claude.com/docs/en/manage-claude/analytics-api)), Claude smart reports (under claude.ai/analytics/insights), and Claude Code contribution metrics (under claude.ai/analytics/claude-code).

93* Claude Code cannot [publish artifacts](https://code.claude.com/docs/en/artifacts#availability). However, artifacts made in chat or Cowork can be shared within your organization, but not publicly.

94* Certain analytics are disabled, regardless of admin settings: Claude smart reports (beta, under claude.ai/analytics/insights) and Claude Code contribution metrics from GitHub (beta, under claude.ai/analytics/claude-code). Admin analytics for skills and connectors, in the claude.ai analytics dashboard and through the [Claude Enterprise Analytics API](https://platform.claude.com/docs/en/manage-claude/analytics-api), don't include usage in chat, and hide the names of custom skills, plugins, and connectors.

9595* Organization data exports and audit log exports, both under [claude.ai > Organization settings > Data and privacy](https://claude.ai/admin-settings/data-privacy-controls), are disabled.

9696* Response ratings (thumbs up and thumbs down on Claude's responses) are disabled.

97* [Skill and plugin security scanning](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/enterprise#skill-content-scanning) is unavailable: the setting cannot be turned on, and skills and plugins are installed without a scan.

9798* The following beta and research preview features are unavailable in CMEK organizations, regardless of admin settings: Claude Design, Claude Slides, and Claude Docs in conversations and the **Artifacts** tab, and routines.

9899

99100### Encrypted with Anthropic key

manage-claude/inference-hooks Changed · +6 / -0 lines

from line 79

7979

8080Governed requests are the inference requests behind the user's conversation. Ancillary requests, such as conversation title generation, aren't sent to your endpoint, and system prompts and tool definitions are never included in what is sent. Voice mode is not covered.

8181

82Some features that Anthropic runs for your organization make model calls of their own. Your organization sees the results of those calls but not their transcripts. These calls aren't governed requests and aren't sent to your endpoint. They include the following:

83

84* **Claude Security scans (beta).** [Claude Security](https://claude.com/product/claude-security) runs hosted scans on your connected repositories. A session a user opens to fix a finding, and the Claude Security plugin in Claude Code, are governed.

85* **Code Review (research preview).** [Code Review](https://code.claude.com/docs/en/code-review) runs reviews on your GitHub pull requests. A review a user runs locally in Claude Code with `/code-review` is governed.

86* **Smart reports (beta).** Anthropic makes model calls to build your organization's [smart reports](https://support.claude.com/en/articles/16893491-get-started-with-smart-reports).

87

8288***

8389

8490## Inference hooks versus the Compliance API

manage-claude/plugins-api Changed · +13 / -11 lines

from line 40

4040* Your primary owner creates an Admin API key with the `read:plugins` scope, the `write:plugins` scope, or both in [claude.ai > Organization settings > API](https://claude.ai/admin-settings/api-access). See [Create an Admin API key](https://platform.claude.com/docs/en/manage-claude/admin-api-keys#create-a-key-for-a-claude-enterprise-organization).

4141* Every request carries three headers: `x-api-key`, `anthropic-version: 2023-06-01`, and `anthropic-beta: ce-plugins-2026-09-01`.

4242

43The Python, TypeScript, C#, Go, Java, PHP, and Ruby SDKs expose these endpoints under `client.beta.organization` (csharp, go: `client.Beta.Organization`; java: `client.beta().organization()`; php: `$client->beta->organization`), and the [`ant` CLI](https://platform.claude.com/docs/en/cli-sdks-libraries/cli/quickstart) under `ant beta:organization`; they send the `anthropic-version` and `anthropic-beta` headers for you. The examples on this page use each SDK's default client, which, like the CLI, reads the Admin API key from the `ANTHROPIC_API_KEY` environment variable; the curl examples read the key from the same variable and pass it in the `x-api-key` header. In the Python, TypeScript, C#, Go, Java, and Ruby list examples and in the CLI, the SDK fetches more pages as you iterate, so `limit` sets the page size, not the total; the PHP and curl examples return one page (see [Pagination](https://platform.claude.com/docs/en/manage-claude/plugins-api#pagination)).

43The Python, TypeScript, C#, Go, Java, PHP, and Ruby SDKs expose these endpoints under `client.beta.organization` (csharp, go: `client.Beta.Organization`; java: `client.beta().organization()`; php: `$client->beta->organization`), and the [`ant` CLI](https://platform.claude.com/docs/en/cli-sdks-libraries/cli/quickstart) under `ant beta:organization`; they send the `anthropic-version` and `anthropic-beta` headers for you. The examples on this page use each SDK's default client, which, like the CLI, reads the Admin API key from the `ANTHROPIC_API_KEY` environment variable; the curl examples read the key from the same variable and pass it in the `x-api-key` header. Where an SDK or the CLI fetches more pages for you, `limit` sets the page size, not the total (see [Pagination](https://platform.claude.com/docs/en/manage-claude/plugins-api#pagination)).

4444

4545API keys belong to the organization and keep working after the person who created them leaves. Do not share them or check them into source control.

4646

from line 251

251251* `organization`: you can manage it through this API, except that a plugin in a marketplace synchronized from Git cannot receive uploads or be deleted here.

252252* `user`: it lives in one member's personal marketplace. You can read its details and download its files, and delete it if its marketplace is `manual`. Uploading versions and choosing the served version return `403`. Sharing is managed only by the member, in claude.ai.

253253

254Removing a member from the organization does not remove their plugins. They stay in the inventory under the member's `user_id`, and the `owner_user_id` filter still finds them, so you can review and remove a departed member's content. They are deleted when the member's account is deleted.

254Removing a member from the organization does not remove their plugins. They stay in the inventory under the member's `user_id`, and the `owner_user_id` filter still finds them, so you can review and remove a departed member's content. They are removed from the inventory when the member's account is deleted.

255255

256256### Versions and the served version

257257

from line 260

260260* `latest_version_id`: the newest version.

261261* `served_version_id`: the version members are served.

262262

263By default `served_version_pinned` is `false`: the served version follows the newest one, and each new version is served as soon as it is stored.

263By default `served_version_pinned` is `false`: the served version normally follows the newest one. When content scanning is on, a version saved in claude.ai might **wait** for its content scan: it is stored but not served at once. This page uses "wait" only for a version saved in claude.ai, not for one that a member or an administrator publishes into a plugin. While scanning is on, a waiting version is served only after its scan completes with `pass` or `warn`. While a version waits, `served_version_id` names an earlier version than `latest_version_id`. Do not poll until the two IDs match: they might stay different, for example when the scan fails.

264264

265265Choosing a version with `POST /v1/organizations/plugins/{plugin_id}` **pins** the plugin (`served_version_pinned: true`). So does an administrator choosing a version in claude.ai, or accepting a member's request to publish into the plugin. From then on, new uploads are stored and advance `latest_version_id`, but members keep the pinned version until you point `served_version_id` at another one. A plugin whose two pointers differ has a stored version that is not being served.

266266

from line 303

303303

304304While scanning is on, members are served a plugin only when its served version's scan is `completed` with `pass` or `warn`. While the scan runs, or after it fails, errors, or reaches no verdict, the plugin is withheld from members, and an earlier version is not served in its place. A version that was never scanned (`content_scan: null`) is served normally.

305305

306On a plugin that is not pinned, each upload becomes the served version at once. Members lose the plugin until the new version's scan passes, and stay without it if the scan fails. If members should keep the current version while a new one is scanned, pin the plugin first (see [Versions and the served version](https://platform.claude.com/docs/en/manage-claude/plugins-api#versions-and-the-served-version)).

306A version you upload through this API never waits for its content scan. When it becomes the served version, members lose the plugin until its scan passes, and stay without it if the scan fails. If members should keep the current version while a new one is scanned, pin the plugin first (see [Versions and the served version](https://platform.claude.com/docs/en/manage-claude/plugins-api#versions-and-the-served-version)).

307307

308While a version saved in claude.ai waits for its scan, the served version does not change. When your API upload becomes the served version, any wait ends: the waiting version is served only if someone chooses it. To see a waiting version's scan, read the version (see [List a plugin's versions](https://platform.claude.com/docs/en/manage-claude/plugins-api#list-a-plugins-versions)).

309

308310After an upload, `content_scan.status` is `processing` and the verdict arrives asynchronously. Read the version to see it; the plugin object shows only its served version's scan. Changing the served version to a version whose scan is still running returns `409 scan_pending`; to one whose scan failed, `400 scan_failed`.

309311

310312### Reach

from line 495

493495

494496Run a nightly job that flags plugins reaching outside the member's session or failing their content scan.

495497

4961. Page through [`GET /v1/organizations/plugins?limit=100`](https://platform.claude.com/docs/en/manage-claude/plugins-api#list-plugins) until `next_page` is `null` (see [Pagination](https://platform.claude.com/docs/en/manage-claude/plugins-api#pagination)). Read each plugin's `reach` and `content_scan` from that list on every run: a scan verdict that arrives later does not move `updated_at`. `updated_at` tells you which plugins have new content or a new served version since the last run (worth a fresh archive download); the full re-list is also what catches removals, because a plugin removed by a Git synchronization or an account deletion disappears without an event.

4972. Flag each plugin whose `reach` is `remote` (it declares an MCP server or a CLI), or whose `content_scan.assessment` is `fail` or `unknown`.

4983. For each flagged plugin, download the served version's archive for review with `GET /v1/organizations/plugins/{plugin_id}/versions/{served_version_id}/content` (see [Download a version's files](https://platform.claude.com/docs/en/manage-claude/plugins-api#download-a-versions-files)).

4981. Page through [`GET /v1/organizations/plugins?limit=100`](https://platform.claude.com/docs/en/manage-claude/plugins-api#list-plugins) until `next_page` is `null` (see [Pagination](https://platform.claude.com/docs/en/manage-claude/plugins-api#pagination)). Read each plugin's `reach` and `content_scan` from that list on every run: a scan verdict that arrives later does not move `updated_at`. `updated_at` normally tells you which plugins have new content or a new served version since the last run (worth a fresh archive download). A waiting version (see [Versions and the served version](https://platform.claude.com/docs/en/manage-claude/plugins-api#versions-and-the-served-version)) moves `updated_at` when it becomes the served version, not necessarily when it is stored. To notice one, compare `latest_version_id` with the value from your last run. The full re-list is also what catches removals, because a plugin removed by a Git synchronization or an account deletion disappears without an event.

4992. Flag each plugin whose `reach` is `remote` (it declares an MCP server or a CLI), or whose `content_scan.assessment` is `fail` or `unknown`. These fields describe the served version. To also check a newer version that is not served, list the plugin's versions when `latest_version_id` differs from `served_version_id` (see [List a plugin's versions](https://platform.claude.com/docs/en/manage-claude/plugins-api#list-a-plugins-versions)).

5003. For each flagged plugin, download the served version's archive for review with `GET /v1/organizations/plugins/{plugin_id}/versions/{served_version_id}/content` (see [Download a version's files](https://platform.claude.com/docs/en/manage-claude/plugins-api#download-a-versions-files)). Also download any unserved version that meets step 2's test, by its ID.

4995014. To take a plugin away from members while you review it, see [Delete a plugin](https://platform.claude.com/docs/en/manage-claude/plugins-api#delete-a-plugin) for the reversible (organization-owned) and permanent options.

500502

501503## Plugins

from line 510

508510| `name` | From the manifest. Unique within its marketplace, not across the organization. Fixed for an organization-owned plugin; changes if a member renames their own plugin in claude.ai. |

509511| `display_name`, `description`, `manifest_version` | The served version's manifest `displayName`, `description`, and `version`; each is `null` when the manifest declares none. `manifest_version` is normalized for display: one leading `v` or `V` is dropped, so a manifest `version` of `"v1.4.0"` is returned as `"1.4.0"`. It is also `null` for a value that does not look like a version number, such as `"latest"`, and for a plugin version created before claude.ai began recording this field in August 2026. An upload is never refused because of its `version`, and `manifest_version` is not unique. |

510512| `served_version_id`, `latest_version_id` | Prefixed `pluginver_`: the version members are served, and the newest version. See [Versions and the served version](https://platform.claude.com/docs/en/manage-claude/plugins-api#versions-and-the-served-version). |

511| `served_version_pinned` | `false` while the served version follows each new version; `true` once a version has been chosen explicitly. |

513| `served_version_pinned` | `false` until the plugin is pinned (see [Versions and the served version](https://platform.claude.com/docs/en/manage-claude/plugins-api#versions-and-the-served-version)); `true` from then on. |

512514| `owner` | `{"type": "organization"}`, or `{"type": "user", "user_id": "user_..."}` for a member's personal marketplace. |

513515| `marketplace_id` | Prefixed `marketplace_`. |

514516| `created_by` | Who created the plugin: `{"type": "user_actor", "user_id": "user_...", "email_address": "..."}` for a person in claude.ai (`email_address` may be `null`), or `{"type": "api_actor", "api_key_id": "apikey_..."}` for an API key. Other actor types may appear. `null` when no creator is recorded, such as for plugins synchronized from Git. |

from line 518

516518| `content_scan` | The served version's scan result, an object with `status`, `assessment`, and `reason` (described after this table). `null` when it was never scanned. |

517519| `components` | The served version's components, each `{"type", "name", "description"}` with `type` one of `skill`, `mcp_server`, `command`, `agent`, `hook`, or `cli`, listed in that type order and then by name. For an MCP server, `name` is its key in the manifest; for a hook, the event it runs on; for a CLI, the executable's name. `description` is always `null` for MCP servers, hooks, and CLIs. `null` when not recorded. |

518520| `reach` | `contained`, `privileged`, or `remote`. See [Reach](https://platform.claude.com/docs/en/manage-claude/plugins-api#reach). |

519| `updated_at` | Changes only when a new version is stored or the served version changes. It does not change for installation settings, shares, or new scan results. |

521| `updated_at` | Changes when the served version changes, when the plugin becomes pinned, and normally when a new version is stored. A waiting version (see [Versions and the served version](https://platform.claude.com/docs/en/manage-claude/plugins-api#versions-and-the-served-version)) changes it when it becomes the served version, not necessarily when it is stored. It does not change for installation settings, shares, or new scan results. |

520522

521523The `content_scan` object:

522524

from line 1137

11351137

11361138### Change the served version

11371139

1138`POST /v1/organizations/plugins/{plugin_id}` changes which version of an organization-owned plugin members are served. Pass an earlier version to roll back, or a newer one to promote a build that was stored without being served. This pins the plugin, and a pinned plugin cannot currently be unpinned, here or in claude.ai (see [Versions and the served version](https://platform.claude.com/docs/en/manage-claude/plugins-api#versions-and-the-served-version)). The only updatable field is `served_version_id`, and it is required. The change reaches members before the response returns and does not create a version. When content scanning is on, the version must be one members can be served (see [Content scanning](https://platform.claude.com/docs/en/manage-claude/plugins-api#content-scanning)). Passing the version already served on a pinned plugin changes nothing; passing it on an unpinned plugin pins it there, so later uploads stop being served automatically. Returns the plugin. Requires the `write:plugins` scope.

1140`POST /v1/organizations/plugins/{plugin_id}` changes which version of an organization-owned plugin members are served. Pass an earlier version to roll back, or a newer one to promote a build that was stored without being served. This pins the plugin, and a pinned plugin cannot currently be unpinned, here or in claude.ai (see [Versions and the served version](https://platform.claude.com/docs/en/manage-claude/plugins-api#versions-and-the-served-version)). The only updatable field is `served_version_id`, and it is required. The change reaches members before the response returns and does not create a version. When content scanning is on, the version must be one members can be served (see [Content scanning](https://platform.claude.com/docs/en/manage-claude/plugins-api#content-scanning)). Passing the version already served on a pinned plugin changes nothing; passing it on an unpinned plugin pins it there, so later uploads stop being served automatically. Pinning also ends any wait: a version that was waiting for its content scan stays stored, and is served only if someone chooses it. Returns the plugin. Requires the `write:plugins` scope.

11391141

11401142<CodeGroup>

11411143 ```bash cURL

from line 1522

15201522

15211523### Create a version

15221524

1523`POST /v1/organizations/plugins/{plugin_id}/versions` adds a version to an organization-owned plugin in a `manual` marketplace. The body is `multipart/form-data`, with the same `files[]` and `release_notes` fields, [upload requirements](https://platform.claude.com/docs/en/manage-claude/plugins-api#upload-requirements), and file, manifest, archive, and size errors as [Create a plugin](https://platform.claude.com/docs/en/manage-claude/plugins-api#create-a-plugin). The uploaded name (the manifest's `name`) must equal the plugin's `name`. If the plugin is not pinned, the new version is served as soon as it is stored; if it is pinned, the version is stored but not served until you change the served version to it. To check, compare the response's `id` with the plugin's `served_version_id`. Returns the version. Requires the `write:plugins` scope.

1525`POST /v1/organizations/plugins/{plugin_id}/versions` adds a version to an organization-owned plugin in a `manual` marketplace. The body is `multipart/form-data`, with the same `files[]` and `release_notes` fields, [upload requirements](https://platform.claude.com/docs/en/manage-claude/plugins-api#upload-requirements), and file, manifest, archive, and size errors as [Create a plugin](https://platform.claude.com/docs/en/manage-claude/plugins-api#create-a-plugin). The uploaded name (the manifest's `name`) must equal the plugin's `name`. If the plugin is not pinned, the new version is normally served as soon as it is stored; if it is pinned, the version is stored but not served until you change the served version to it. To check, compare the response's `id` with the plugin's `served_version_id`. Returns the version. Requires the `write:plugins` scope.

15241526

15251527<CodeGroup>

15261528 ```bash cURL

release-notes/overview Changed · +4 / -0 lines

### October 1, 2026

from line 12

1212 For updates to Claude Code, see the [complete CHANGELOG.md](https://github.com/anthropics/claude-code/blob/main/CHANGELOG.md) in the `claude-code` repository.

1313</Tip>

1414

15### October 1, 2026

16

17* We've added a `line` field to the [Models API](https://platform.claude.com/docs/en/api/models/list). `GET /v1/models` and `GET /v1/models/{model_id}` now return the model line each model belongs to. Claude Opus 4.5 and Claude Opus 4.6 both report `opus`, for example. Use `line` to group models without parsing their IDs. `line` is `null` for a model that belongs to no line. See [Using the Models API](https://platform.claude.com/docs/en/models/overview#using-the-models-api).

18

1519### September 30, 2026

1620

1721* We announced the deprecation of the Claude Sonnet 4.5 model (`claude-sonnet-4-5-20250929`), with retirement on the Claude API scheduled for November 30, 2026. We recommend migrating to [Claude Sonnet 5.5](https://platform.claude.com/docs/en/models/sonnet-5-5/migration-guide#migrating-from-sonnet-45). Read more in [Model deprecations](https://platform.claude.com/docs/en/about-claude/model-deprecations).

about-claude/use-case-guides/customer-support-chat Changed · +1 / -1 lines

from line 1147

11471147

11481148When dealing with large amounts of static and dynamic context, including all information in the prompt can lead to high costs, slower response times, and reaching context window limits. In this scenario, implementing Retrieval Augmented Generation (RAG) techniques can improve performance and efficiency.

11491149

1150By using [embedding models like Voyage](https://platform.claude.com/docs/en/build-with-claude/embeddings) to convert information into vector representations, you can create a more scalable and responsive system. This approach allows for dynamic retrieval of relevant information based on the current query, rather than including all possible context in every prompt.

1150You can create a more scalable and responsive system by converting information into vector representations with [embedding models](https://platform.claude.com/docs/en/build-with-claude/embeddings), such as those from Voyage AI by MongoDB. This approach allows for dynamic retrieval of relevant information based on the current query, rather than including all possible context in every prompt.

11511151

11521152Implementing RAG for support use cases has been shown to increase accuracy, reduce response times, and reduce API costs in systems with extensive context requirements. See the [RAG recipe](https://platform.claude.com/cookbook/capabilities-retrieval-augmented-generation-guide) for a worked example.

11531153

cli-sdks-libraries/cli/quickstart Changed · +1 / -1 lines

from line 32

3232 For Linux environments, download the release binary directly.

3333

3434 ```bash

35 VERSION=1.37.0

35 VERSION=1.38.0

3636 OS=$(uname -s | tr '[:upper:]' '[:lower:]')

3737 case $(uname -m) in

3838 x86_64) ARCH=amd64 ;;

cli-sdks-libraries/sdks/java Changed · +2 / -2 lines

from line 15

1515<Tabs>

1616 <Tab title="Gradle">

1717 ```kotlin

18 implementation("com.anthropic:anthropic-java:2.67.0")

18 implementation("com.anthropic:anthropic-java:2.68.0")

1919 ```

2020 </Tab>

2121

from line 24

2424 <dependency>

2525 <groupId>com.anthropic</groupId>

2626 <artifactId>anthropic-java</artifactId>

27 <version>2.67.0</version>

27 <version>2.68.0</version>

2828 </dependency>

2929 ```

3030 </Tab>

get-started Changed · +2 / -2 lines

from line 436

436436 }

437437

438438 dependencies {

439 implementation("com.anthropic:anthropic-java:2.67.0")

439 implementation("com.anthropic:anthropic-java:2.68.0")

440440 }

441441

442442 application {

from line 462

462462 <dependency>

463463 <groupId>com.anthropic</groupId>

464464 <artifactId>anthropic-java</artifactId>

465 <version>2.67.0</version>

465 <version>2.68.0</version>

466466 </dependency>

467467 </dependencies>

468468 </project>

manage-claude/analytics-api Changed · +1 / -1 lines

from line 83

8383

8484**Engagement and adoption endpoints** (user activity, summaries, projects, skills, connectors) return a per-day snapshot for the date you specify. Data for a given day is typically available by about 13:00–13:30 UTC the following day (a 1-day lag); until then, the most recent available day is usually two days before the current UTC date. Data arrives later on days when an upstream data pipeline runs late, and exact freshness varies by query, so rather than assuming a fixed time, check the error response: requesting a date that is not yet available returns a 400 error naming the most recent available day. If data is not available well past the typical lag, it usually indicates a data pipeline failure on Anthropic's side; contact support if the gap persists.

8585

86**Cost and usage endpoints** follow a different freshness model. Data is typically available within four hours of the underlying usage but may take up to 24 hours. Values for a given date can be revised for up to 30 days as late events arrive and reconciliation runs. For invoicing-grade totals, query dates at least 30 days in the past.

86**Cost and usage endpoints** follow a different freshness model. Data is typically available within four hours of the underlying usage but may take up to 24 hours. Values can be revised as late events arrive and reconciliation runs, until about 7 days after the end of the calendar month. For example, values for October 1 can change until about November 7. For invoicing-grade totals, query only months that ended at least 7 days ago.

8787

8888<Note>

8989 Cost and usage responses include a `data_refreshed_at` timestamp. When `ending_at` is omitted (the default is the current time), the response includes a tail of data after `data_refreshed_at` that is incomplete. For stable results across repeated calls, set `ending_at` to a value at or before a previously returned `data_refreshed_at`.

manage-claude/inference-hooks-configuration Changed · +1 / -1 lines

from line 101

101101

102102Under **Exclusions**, select roles whose members are not covered by Inference hooks: their prompts are never sent to your AI security server. Only custom roles your organization created can be excluded; the built-in roles aren't offered. Pick them in the role selector, whose placeholder reads **Select roles to exclude**, and manage who holds each role from the roles admin page (**Manage roles**); changing exclusions requires identity management permission. The list is empty by default, and with no roles excluded, every governed request is inspected.

103103

104Exclusion applies to a user's interactive sessions; traffic authenticated by machine credentials is always inspected. Changes to the exclusion list are recorded in the audit trail.

104Exclusion applies to a user's interactive sessions. Changes to the exclusion list are recorded in your organization's [Activity Feed](https://platform.claude.com/docs/en/manage-claude/compliance-activity-feed) as role permission changes (`rbac_role_permission_added` and `rbac_role_permission_removed`).

105105

106106## Custom blocked prompt message

107107

manage-claude/usage-cost-api Changed · +4 / -0 lines

from line 64

6464 Advanced querying and visualization through OpenTelemetry

6565 </Card>

6666

67 <Card title="Tempo" icon="chart" href="https://help.tempo.io/workforceintelligence/latest/connect-to-anthropic">

68 Usage and cost attribution to Jira work items

69 </Card>

70

6771 <Card title="Vantage" icon="chart" href="https://docs.vantage.sh/connecting_anthropic">

6872 FinOps platform for LLM cost & usage observability

6973 </Card>

managed-agents/github Changed · +1 / -1 lines

from line 241

241241 ```

242242</CodeGroup>

243243

244Then create a session that mounts the GitHub repository. A `limited` [environment](https://platform.claude.com/docs/en/managed-agents/environments#networking) blocks an agent's MCP servers unless its networking sets `allow_mcp_servers: true` or lists each server's host in `allowed_hosts`. With neither set, session creation fails with a 400 error.

244Then create a session that mounts the GitHub repository. With a `limited` [environment](https://platform.claude.com/docs/en/managed-agents/environments#networking), session creation fails with a 400 error when the agent declares an MCP server whose host is not in `allowed_hosts`. Setting `allow_mcp_servers: true` in the environment's networking turns this check off.

245245

246246<CodeGroup>

247247 ```bash cURL

managed-agents/mcp-connector Changed · +2 / -2 lines

from line 291

291291

292292When starting a session, pass `vault_ids` to provide credentials for your MCP servers. Vaults are collections of credentials that you register once and reference by ID. See [Authenticate with vaults](https://platform.claude.com/docs/en/managed-agents/vaults) for how to create vaults and manage credentials.

293293

294A `limited` [environment](https://platform.claude.com/docs/en/managed-agents/environments#networking) blocks an agent's MCP servers unless its networking sets `allow_mcp_servers: true` or lists each server's host in `allowed_hosts`. With neither set, session creation fails with a 400 error.

294With a `limited` [environment](https://platform.claude.com/docs/en/managed-agents/environments#networking), session creation fails with a 400 error when the agent declares an MCP server whose host is not in `allowed_hosts`. Setting `allow_mcp_servers: true` in the environment's networking turns this check off.

295295

296296<CodeGroup>

297297 ```bash cURL

from line 386

386386

387387### Handle connection and authentication failures

388388

389Session creation does not validate MCP connectivity or credentials. If an MCP server is unreachable or rejects the supplied credential, the session still starts and interaction remains possible. A [`session.error`](https://platform.claude.com/docs/en/managed-agents/events-and-streaming) event is emitted with the `mcp_server_name` of the affected server and a `retry_status`:

389Session creation does not validate MCP connectivity or credentials. It does check each declared server's host against the environment's networking: with a `limited` environment, session creation fails with a 400 error when a host is not allowed, as described under [Provide authentication at session creation](https://platform.claude.com/docs/en/managed-agents/mcp-connector#provide-authentication-at-session-creation). If an MCP server is unreachable or rejects the supplied credential, the session still starts and interaction remains possible. A [`session.error`](https://platform.claude.com/docs/en/managed-agents/events-and-streaming) event is emitted with the `mcp_server_name` of the affected server and a `retry_status`:

390390

391391| Error type | Meaning |

392392| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

managed-agents/multiagent-orchestration Changed · +1 / -1 lines

from line 417

417417

418418[Agent configuration overrides](https://platform.claude.com/docs/en/managed-agents/sessions#override-agent-configuration-for-a-session) at session creation can replace the coordinator's MCP servers and those of its `self` copies.

419419

420A `limited` [environment](https://platform.claude.com/docs/en/managed-agents/environments#networking) blocks an agent's MCP servers unless its networking sets `allow_mcp_servers: true` or lists each server's host in `allowed_hosts`. With neither set, session creation fails with a 400 error. The check covers every agent the coordinator can delegate to.

420With a `limited` [environment](https://platform.claude.com/docs/en/managed-agents/environments#networking), session creation fails with a 400 error when the coordinator, or an agent it can delegate to, declares an MCP server whose host is not in `allowed_hosts`. Setting `allow_mcp_servers: true` in the environment's networking turns this check off.

421421

422422Create the researcher, which declares the GitHub MCP server, and the coordinator that delegates to the researcher:

423423

managed-agents/quickstart Changed · +2 / -2 lines

from line 43

4343 For Linux environments, download the release binary directly.

4444

4545 ```bash

46 VERSION=1.37.0

46 VERSION=1.38.0

4747 OS=$(uname -s | tr '[:upper:]' '[:lower:]')

4848 case $(uname -m) in

4949 x86_64) ARCH=amd64 ;;

from line 94

9494

9595 <Tab title="Java">

9696 ```groovy Gradle

97 implementation("com.anthropic:anthropic-java:2.67.0")

97 implementation("com.anthropic:anthropic-java:2.68.0")

9898 ```

9999 </Tab>

100100

One read of Claude Developer Platformapi-20261005T180724Z

What this read moved