|
1 | 1 | # Anthropic
|
2 | 2 |
|
| 3 | +# Shared |
| 4 | + |
| 5 | +Types: |
| 6 | + |
| 7 | +- <code><a href="./src/resources/shared.ts">APIErrorObject</a></code> |
| 8 | +- <code><a href="./src/resources/shared.ts">AuthenticationError</a></code> |
| 9 | +- <code><a href="./src/resources/shared.ts">BillingError</a></code> |
| 10 | +- <code><a href="./src/resources/shared.ts">ErrorObject</a></code> |
| 11 | +- <code><a href="./src/resources/shared.ts">ErrorResponse</a></code> |
| 12 | +- <code><a href="./src/resources/shared.ts">GatewayTimeoutError</a></code> |
| 13 | +- <code><a href="./src/resources/shared.ts">InvalidRequestError</a></code> |
| 14 | +- <code><a href="./src/resources/shared.ts">NotFoundError</a></code> |
| 15 | +- <code><a href="./src/resources/shared.ts">OverloadedError</a></code> |
| 16 | +- <code><a href="./src/resources/shared.ts">PermissionError</a></code> |
| 17 | +- <code><a href="./src/resources/shared.ts">RateLimitError</a></code> |
| 18 | + |
3 | 19 | # Messages
|
4 | 20 |
|
5 | 21 | Types:
|
6 | 22 |
|
7 |
| -- <code><a href="./src/resources/messages.ts">ContentBlock</a></code> |
8 |
| -- <code><a href="./src/resources/messages.ts">ContentBlockDeltaEvent</a></code> |
9 |
| -- <code><a href="./src/resources/messages.ts">ContentBlockParam</a></code> |
10 |
| -- <code><a href="./src/resources/messages.ts">ContentBlockStartEvent</a></code> |
11 |
| -- <code><a href="./src/resources/messages.ts">ContentBlockStopEvent</a></code> |
12 |
| -- <code><a href="./src/resources/messages.ts">ImageBlockParam</a></code> |
13 |
| -- <code><a href="./src/resources/messages.ts">InputJSONDelta</a></code> |
14 |
| -- <code><a href="./src/resources/messages.ts">Message</a></code> |
15 |
| -- <code><a href="./src/resources/messages.ts">MessageDeltaEvent</a></code> |
16 |
| -- <code><a href="./src/resources/messages.ts">MessageDeltaUsage</a></code> |
17 |
| -- <code><a href="./src/resources/messages.ts">MessageParam</a></code> |
18 |
| -- <code><a href="./src/resources/messages.ts">MessageStartEvent</a></code> |
19 |
| -- <code><a href="./src/resources/messages.ts">MessageStopEvent</a></code> |
20 |
| -- <code><a href="./src/resources/messages.ts">MessageStreamEvent</a></code> |
21 |
| -- <code><a href="./src/resources/messages.ts">Metadata</a></code> |
22 |
| -- <code><a href="./src/resources/messages.ts">Model</a></code> |
23 |
| -- <code><a href="./src/resources/messages.ts">RawContentBlockDeltaEvent</a></code> |
24 |
| -- <code><a href="./src/resources/messages.ts">RawContentBlockStartEvent</a></code> |
25 |
| -- <code><a href="./src/resources/messages.ts">RawContentBlockStopEvent</a></code> |
26 |
| -- <code><a href="./src/resources/messages.ts">RawMessageDeltaEvent</a></code> |
27 |
| -- <code><a href="./src/resources/messages.ts">RawMessageStartEvent</a></code> |
28 |
| -- <code><a href="./src/resources/messages.ts">RawMessageStopEvent</a></code> |
29 |
| -- <code><a href="./src/resources/messages.ts">RawMessageStreamEvent</a></code> |
30 |
| -- <code><a href="./src/resources/messages.ts">TextBlock</a></code> |
31 |
| -- <code><a href="./src/resources/messages.ts">TextBlockParam</a></code> |
32 |
| -- <code><a href="./src/resources/messages.ts">TextDelta</a></code> |
33 |
| -- <code><a href="./src/resources/messages.ts">Tool</a></code> |
34 |
| -- <code><a href="./src/resources/messages.ts">ToolChoice</a></code> |
35 |
| -- <code><a href="./src/resources/messages.ts">ToolChoiceAny</a></code> |
36 |
| -- <code><a href="./src/resources/messages.ts">ToolChoiceAuto</a></code> |
37 |
| -- <code><a href="./src/resources/messages.ts">ToolChoiceTool</a></code> |
38 |
| -- <code><a href="./src/resources/messages.ts">ToolResultBlockParam</a></code> |
39 |
| -- <code><a href="./src/resources/messages.ts">ToolUseBlock</a></code> |
40 |
| -- <code><a href="./src/resources/messages.ts">ToolUseBlockParam</a></code> |
41 |
| -- <code><a href="./src/resources/messages.ts">Usage</a></code> |
| 23 | +- <code><a href="./src/resources/messages/messages.ts">Base64PDFSource</a></code> |
| 24 | +- <code><a href="./src/resources/messages/messages.ts">CacheControlEphemeral</a></code> |
| 25 | +- <code><a href="./src/resources/messages/messages.ts">ContentBlock</a></code> |
| 26 | +- <code><a href="./src/resources/messages/messages.ts">ContentBlockDeltaEvent</a></code> |
| 27 | +- <code><a href="./src/resources/messages/messages.ts">ContentBlockParam</a></code> |
| 28 | +- <code><a href="./src/resources/messages/messages.ts">ContentBlockStartEvent</a></code> |
| 29 | +- <code><a href="./src/resources/messages/messages.ts">ContentBlockStopEvent</a></code> |
| 30 | +- <code><a href="./src/resources/messages/messages.ts">DocumentBlockParam</a></code> |
| 31 | +- <code><a href="./src/resources/messages/messages.ts">ImageBlockParam</a></code> |
| 32 | +- <code><a href="./src/resources/messages/messages.ts">InputJSONDelta</a></code> |
| 33 | +- <code><a href="./src/resources/messages/messages.ts">Message</a></code> |
| 34 | +- <code><a href="./src/resources/messages/messages.ts">MessageDeltaEvent</a></code> |
| 35 | +- <code><a href="./src/resources/messages/messages.ts">MessageDeltaUsage</a></code> |
| 36 | +- <code><a href="./src/resources/messages/messages.ts">MessageParam</a></code> |
| 37 | +- <code><a href="./src/resources/messages/messages.ts">MessageStartEvent</a></code> |
| 38 | +- <code><a href="./src/resources/messages/messages.ts">MessageStopEvent</a></code> |
| 39 | +- <code><a href="./src/resources/messages/messages.ts">MessageStreamEvent</a></code> |
| 40 | +- <code><a href="./src/resources/messages/messages.ts">MessageTokensCount</a></code> |
| 41 | +- <code><a href="./src/resources/messages/messages.ts">Metadata</a></code> |
| 42 | +- <code><a href="./src/resources/messages/messages.ts">Model</a></code> |
| 43 | +- <code><a href="./src/resources/messages/messages.ts">RawContentBlockDeltaEvent</a></code> |
| 44 | +- <code><a href="./src/resources/messages/messages.ts">RawContentBlockStartEvent</a></code> |
| 45 | +- <code><a href="./src/resources/messages/messages.ts">RawContentBlockStopEvent</a></code> |
| 46 | +- <code><a href="./src/resources/messages/messages.ts">RawMessageDeltaEvent</a></code> |
| 47 | +- <code><a href="./src/resources/messages/messages.ts">RawMessageStartEvent</a></code> |
| 48 | +- <code><a href="./src/resources/messages/messages.ts">RawMessageStopEvent</a></code> |
| 49 | +- <code><a href="./src/resources/messages/messages.ts">RawMessageStreamEvent</a></code> |
| 50 | +- <code><a href="./src/resources/messages/messages.ts">TextBlock</a></code> |
| 51 | +- <code><a href="./src/resources/messages/messages.ts">TextBlockParam</a></code> |
| 52 | +- <code><a href="./src/resources/messages/messages.ts">TextDelta</a></code> |
| 53 | +- <code><a href="./src/resources/messages/messages.ts">Tool</a></code> |
| 54 | +- <code><a href="./src/resources/messages/messages.ts">ToolChoice</a></code> |
| 55 | +- <code><a href="./src/resources/messages/messages.ts">ToolChoiceAny</a></code> |
| 56 | +- <code><a href="./src/resources/messages/messages.ts">ToolChoiceAuto</a></code> |
| 57 | +- <code><a href="./src/resources/messages/messages.ts">ToolChoiceTool</a></code> |
| 58 | +- <code><a href="./src/resources/messages/messages.ts">ToolResultBlockParam</a></code> |
| 59 | +- <code><a href="./src/resources/messages/messages.ts">ToolUseBlock</a></code> |
| 60 | +- <code><a href="./src/resources/messages/messages.ts">ToolUseBlockParam</a></code> |
| 61 | +- <code><a href="./src/resources/messages/messages.ts">Usage</a></code> |
42 | 62 |
|
43 | 63 | Methods:
|
44 | 64 |
|
45 |
| -- <code title="post /v1/messages">client.messages.<a href="./src/resources/messages.ts">create</a>({ ...params }) -> Message</code> |
| 65 | +- <code title="post /v1/messages">client.messages.<a href="./src/resources/messages/messages.ts">create</a>({ ...params }) -> Message</code> |
| 66 | +- <code title="post /v1/messages/count_tokens">client.messages.<a href="./src/resources/messages/messages.ts">countTokens</a>({ ...params }) -> MessageTokensCount</code> |
46 | 67 | - <code>client.messages.<a href="./src/resources/messages.ts">stream</a>(body, options?) -> MessageStream</code>
|
47 | 68 |
|
| 69 | +## Batches |
| 70 | + |
| 71 | +Types: |
| 72 | + |
| 73 | +- <code><a href="./src/resources/messages/batches.ts">MessageBatch</a></code> |
| 74 | +- <code><a href="./src/resources/messages/batches.ts">MessageBatchCanceledResult</a></code> |
| 75 | +- <code><a href="./src/resources/messages/batches.ts">MessageBatchErroredResult</a></code> |
| 76 | +- <code><a href="./src/resources/messages/batches.ts">MessageBatchExpiredResult</a></code> |
| 77 | +- <code><a href="./src/resources/messages/batches.ts">MessageBatchIndividualResponse</a></code> |
| 78 | +- <code><a href="./src/resources/messages/batches.ts">MessageBatchRequestCounts</a></code> |
| 79 | +- <code><a href="./src/resources/messages/batches.ts">MessageBatchResult</a></code> |
| 80 | +- <code><a href="./src/resources/messages/batches.ts">MessageBatchSucceededResult</a></code> |
| 81 | + |
| 82 | +Methods: |
| 83 | + |
| 84 | +- <code title="post /v1/messages/batches">client.messages.batches.<a href="./src/resources/messages/batches.ts">create</a>({ ...params }) -> MessageBatch</code> |
| 85 | +- <code title="get /v1/messages/batches/{message_batch_id}">client.messages.batches.<a href="./src/resources/messages/batches.ts">retrieve</a>(messageBatchId) -> MessageBatch</code> |
| 86 | +- <code title="get /v1/messages/batches">client.messages.batches.<a href="./src/resources/messages/batches.ts">list</a>({ ...params }) -> MessageBatchesPage</code> |
| 87 | +- <code title="post /v1/messages/batches/{message_batch_id}/cancel">client.messages.batches.<a href="./src/resources/messages/batches.ts">cancel</a>(messageBatchId) -> MessageBatch</code> |
| 88 | +- <code title="get /v1/messages/batches/{message_batch_id}/results">client.messages.batches.<a href="./src/resources/messages/batches.ts">results</a>(messageBatchId) -> Response</code> |
| 89 | + |
| 90 | +# Models |
| 91 | + |
| 92 | +Types: |
| 93 | + |
| 94 | +- <code><a href="./src/resources/models.ts">ModelInfo</a></code> |
| 95 | + |
| 96 | +Methods: |
| 97 | + |
| 98 | +- <code title="get /v1/models/{model_id}">client.models.<a href="./src/resources/models.ts">retrieve</a>(modelId) -> ModelInfo</code> |
| 99 | +- <code title="get /v1/models">client.models.<a href="./src/resources/models.ts">list</a>({ ...params }) -> ModelInfosPage</code> |
| 100 | + |
48 | 101 | # Beta
|
49 | 102 |
|
50 | 103 | Types:
|
51 | 104 |
|
52 | 105 | - <code><a href="./src/resources/beta/beta.ts">AnthropicBeta</a></code>
|
53 | 106 | - <code><a href="./src/resources/beta/beta.ts">BetaAPIError</a></code>
|
54 | 107 | - <code><a href="./src/resources/beta/beta.ts">BetaAuthenticationError</a></code>
|
| 108 | +- <code><a href="./src/resources/beta/beta.ts">BetaBillingError</a></code> |
55 | 109 | - <code><a href="./src/resources/beta/beta.ts">BetaError</a></code>
|
56 | 110 | - <code><a href="./src/resources/beta/beta.ts">BetaErrorResponse</a></code>
|
| 111 | +- <code><a href="./src/resources/beta/beta.ts">BetaGatewayTimeoutError</a></code> |
57 | 112 | - <code><a href="./src/resources/beta/beta.ts">BetaInvalidRequestError</a></code>
|
58 | 113 | - <code><a href="./src/resources/beta/beta.ts">BetaNotFoundError</a></code>
|
59 | 114 | - <code><a href="./src/resources/beta/beta.ts">BetaOverloadedError</a></code>
|
60 | 115 | - <code><a href="./src/resources/beta/beta.ts">BetaPermissionError</a></code>
|
61 | 116 | - <code><a href="./src/resources/beta/beta.ts">BetaRateLimitError</a></code>
|
62 | 117 |
|
| 118 | +## Models |
| 119 | + |
| 120 | +Types: |
| 121 | + |
| 122 | +- <code><a href="./src/resources/beta/models.ts">BetaModelInfo</a></code> |
| 123 | + |
| 124 | +Methods: |
| 125 | + |
| 126 | +- <code title="get /v1/models/{model_id}?beta=true">client.beta.models.<a href="./src/resources/beta/models.ts">retrieve</a>(modelId) -> BetaModelInfo</code> |
| 127 | +- <code title="get /v1/models?beta=true">client.beta.models.<a href="./src/resources/beta/models.ts">list</a>({ ...params }) -> BetaModelInfosPage</code> |
| 128 | + |
63 | 129 | ## Messages
|
64 | 130 |
|
65 | 131 | Types:
|
@@ -125,26 +191,3 @@ Methods:
|
125 | 191 | - <code title="get /v1/messages/batches?beta=true">client.beta.messages.batches.<a href="./src/resources/beta/messages/batches.ts">list</a>({ ...params }) -> BetaMessageBatchesPage</code>
|
126 | 192 | - <code title="post /v1/messages/batches/{message_batch_id}/cancel?beta=true">client.beta.messages.batches.<a href="./src/resources/beta/messages/batches.ts">cancel</a>(messageBatchId, { ...params }) -> BetaMessageBatch</code>
|
127 | 193 | - <code title="get /v1/messages/batches/{message_batch_id}/results?beta=true">client.beta.messages.batches.<a href="./src/resources/beta/messages/batches.ts">results</a>(messageBatchId, { ...params }) -> Response</code>
|
128 |
| - |
129 |
| -## PromptCaching |
130 |
| - |
131 |
| -### Messages |
132 |
| - |
133 |
| -Types: |
134 |
| - |
135 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">PromptCachingBetaCacheControlEphemeral</a></code> |
136 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">PromptCachingBetaImageBlockParam</a></code> |
137 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">PromptCachingBetaMessage</a></code> |
138 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">PromptCachingBetaMessageParam</a></code> |
139 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">PromptCachingBetaTextBlockParam</a></code> |
140 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">PromptCachingBetaTool</a></code> |
141 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">PromptCachingBetaToolResultBlockParam</a></code> |
142 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">PromptCachingBetaToolUseBlockParam</a></code> |
143 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">PromptCachingBetaUsage</a></code> |
144 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">RawPromptCachingBetaMessageStartEvent</a></code> |
145 |
| -- <code><a href="./src/resources/beta/prompt-caching/messages.ts">RawPromptCachingBetaMessageStreamEvent</a></code> |
146 |
| - |
147 |
| -Methods: |
148 |
| - |
149 |
| -- <code title="post /v1/messages?beta=prompt_caching">client.beta.promptCaching.messages.<a href="./src/resources/beta/prompt-caching/messages.ts">create</a>({ ...params }) -> PromptCachingBetaMessage</code> |
150 |
| -- <code title="post /v1/messages?beta=prompt_caching">client.beta.promptCaching.messages.<a href="./src/resources/beta/prompt-caching/messages.ts">stream</a>({ ...params }) -> PromptCachingBetaMessageStream</code> |
|
0 commit comments