Skip to content

Commit e923aa1

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent 4877181 commit e923aa1

File tree

1 file changed

+110
-92
lines changed

1 file changed

+110
-92
lines changed

‎api.md

Lines changed: 110 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -48,104 +48,122 @@ Methods:
4848
- <code title="get /v1/files/{file_id}?beta=true">client.beta.files.<a href="./src/resources/beta/files.ts">retrieveMetadata</a>(fileID, { ...params }) -> FileMetadata</code>
4949
- <code title="post /v1/files?beta=true">client.beta.files.<a href="./src/resources/beta/files.ts">upload</a>({ ...params }) -> FileMetadata</code>
5050

51-
# Messages
51+
## Messages
5252

5353
Types:
5454

55-
- <code><a href="./src/resources/messages/messages.ts">Base64ImageSource</a></code>
56-
- <code><a href="./src/resources/messages/messages.ts">Base64PDFSource</a></code>
57-
- <code><a href="./src/resources/messages/messages.ts">CacheControlEphemeral</a></code>
58-
- <code><a href="./src/resources/messages/messages.ts">CitationCharLocation</a></code>
59-
- <code><a href="./src/resources/messages/messages.ts">CitationCharLocationParam</a></code>
60-
- <code><a href="./src/resources/messages/messages.ts">CitationContentBlockLocation</a></code>
61-
- <code><a href="./src/resources/messages/messages.ts">CitationContentBlockLocationParam</a></code>
62-
- <code><a href="./src/resources/messages/messages.ts">CitationPageLocation</a></code>
63-
- <code><a href="./src/resources/messages/messages.ts">CitationPageLocationParam</a></code>
64-
- <code><a href="./src/resources/messages/messages.ts">CitationWebSearchResultLocationParam</a></code>
65-
- <code><a href="./src/resources/messages/messages.ts">CitationsConfigParam</a></code>
66-
- <code><a href="./src/resources/messages/messages.ts">CitationsDelta</a></code>
67-
- <code><a href="./src/resources/messages/messages.ts">CitationsWebSearchResultLocation</a></code>
68-
- <code><a href="./src/resources/messages/messages.ts">ContentBlock</a></code>
69-
- <code><a href="./src/resources/messages/messages.ts">ContentBlockParam</a></code>
70-
- <code><a href="./src/resources/messages/messages.ts">ContentBlockSource</a></code>
71-
- <code><a href="./src/resources/messages/messages.ts">ContentBlockSourceContent</a></code>
72-
- <code><a href="./src/resources/messages/messages.ts">ContentBlockStartEvent</a></code>
73-
- <code><a href="./src/resources/messages/messages.ts">ContentBlockStopEvent</a></code>
74-
- <code><a href="./src/resources/messages/messages.ts">DocumentBlockParam</a></code>
75-
- <code><a href="./src/resources/messages/messages.ts">ImageBlockParam</a></code>
76-
- <code><a href="./src/resources/messages/messages.ts">InputJSONDelta</a></code>
77-
- <code><a href="./src/resources/messages/messages.ts">Message</a></code>
78-
- <code><a href="./src/resources/messages/messages.ts">MessageCountTokensTool</a></code>
79-
- <code><a href="./src/resources/messages/messages.ts">MessageDeltaEvent</a></code>
80-
- <code><a href="./src/resources/messages/messages.ts">MessageDeltaUsage</a></code>
81-
- <code><a href="./src/resources/messages/messages.ts">MessageParam</a></code>
82-
- <code><a href="./src/resources/messages/messages.ts">MessageTokensCount</a></code>
83-
- <code><a href="./src/resources/messages/messages.ts">Metadata</a></code>
84-
- <code><a href="./src/resources/messages/messages.ts">Model</a></code>
85-
- <code><a href="./src/resources/messages/messages.ts">PlainTextSource</a></code>
86-
- <code><a href="./src/resources/messages/messages.ts">RawContentBlockDelta</a></code>
87-
- <code><a href="./src/resources/messages/messages.ts">RawContentBlockDeltaEvent</a></code>
88-
- <code><a href="./src/resources/messages/messages.ts">RawContentBlockStartEvent</a></code>
89-
- <code><a href="./src/resources/messages/messages.ts">RawContentBlockStopEvent</a></code>
90-
- <code><a href="./src/resources/messages/messages.ts">RawMessageDeltaEvent</a></code>
91-
- <code><a href="./src/resources/messages/messages.ts">RawMessageStartEvent</a></code>
92-
- <code><a href="./src/resources/messages/messages.ts">RawMessageStopEvent</a></code>
93-
- <code><a href="./src/resources/messages/messages.ts">RawMessageStreamEvent</a></code>
94-
- <code><a href="./src/resources/messages/messages.ts">RedactedThinkingBlock</a></code>
95-
- <code><a href="./src/resources/messages/messages.ts">RedactedThinkingBlockParam</a></code>
96-
- <code><a href="./src/resources/messages/messages.ts">ServerToolUsage</a></code>
97-
- <code><a href="./src/resources/messages/messages.ts">ServerToolUseBlock</a></code>
98-
- <code><a href="./src/resources/messages/messages.ts">ServerToolUseBlockParam</a></code>
99-
- <code><a href="./src/resources/messages/messages.ts">SignatureDelta</a></code>
100-
- <code><a href="./src/resources/messages/messages.ts">StopReason</a></code>
101-
- <code><a href="./src/resources/messages/messages.ts">TextBlock</a></code>
102-
- <code><a href="./src/resources/messages/messages.ts">TextBlockParam</a></code>
103-
- <code><a href="./src/resources/messages/messages.ts">TextCitation</a></code>
104-
- <code><a href="./src/resources/messages/messages.ts">TextCitationParam</a></code>
105-
- <code><a href="./src/resources/messages/messages.ts">TextDelta</a></code>
106-
- <code><a href="./src/resources/messages/messages.ts">ThinkingBlock</a></code>
107-
- <code><a href="./src/resources/messages/messages.ts">ThinkingBlockParam</a></code>
108-
- <code><a href="./src/resources/messages/messages.ts">ThinkingConfigDisabled</a></code>
109-
- <code><a href="./src/resources/messages/messages.ts">ThinkingConfigEnabled</a></code>
110-
- <code><a href="./src/resources/messages/messages.ts">ThinkingConfigParam</a></code>
111-
- <code><a href="./src/resources/messages/messages.ts">ThinkingDelta</a></code>
112-
- <code><a href="./src/resources/messages/messages.ts">Tool</a></code>
113-
- <code><a href="./src/resources/messages/messages.ts">ToolBash20250124</a></code>
114-
- <code><a href="./src/resources/messages/messages.ts">ToolChoice</a></code>
115-
- <code><a href="./src/resources/messages/messages.ts">ToolChoiceAny</a></code>
116-
- <code><a href="./src/resources/messages/messages.ts">ToolChoiceAuto</a></code>
117-
- <code><a href="./src/resources/messages/messages.ts">ToolChoiceNone</a></code>
118-
- <code><a href="./src/resources/messages/messages.ts">ToolChoiceTool</a></code>
119-
- <code><a href="./src/resources/messages/messages.ts">ToolResultBlockParam</a></code>
120-
- <code><a href="./src/resources/messages/messages.ts">ToolTextEditor20250124</a></code>
121-
- <code><a href="./src/resources/messages/messages.ts">ToolUnion</a></code>
122-
- <code><a href="./src/resources/messages/messages.ts">ToolUseBlock</a></code>
123-
- <code><a href="./src/resources/messages/messages.ts">ToolUseBlockParam</a></code>
124-
- <code><a href="./src/resources/messages/messages.ts">URLImageSource</a></code>
125-
- <code><a href="./src/resources/messages/messages.ts">URLPDFSource</a></code>
126-
- <code><a href="./src/resources/messages/messages.ts">Usage</a></code>
127-
- <code><a href="./src/resources/messages/messages.ts">WebSearchResultBlock</a></code>
128-
- <code><a href="./src/resources/messages/messages.ts">WebSearchResultBlockParam</a></code>
129-
- <code><a href="./src/resources/messages/messages.ts">WebSearchTool20250305</a></code>
130-
- <code><a href="./src/resources/messages/messages.ts">WebSearchToolRequestError</a></code>
131-
- <code><a href="./src/resources/messages/messages.ts">WebSearchToolResultBlock</a></code>
132-
- <code><a href="./src/resources/messages/messages.ts">WebSearchToolResultBlockContent</a></code>
133-
- <code><a href="./src/resources/messages/messages.ts">WebSearchToolResultBlockParam</a></code>
134-
- <code><a href="./src/resources/messages/messages.ts">WebSearchToolResultBlockParamContent</a></code>
135-
- <code><a href="./src/resources/messages/messages.ts">WebSearchToolResultError</a></code>
136-
- <code><a href="./src/resources/messages/messages.ts">MessageStreamEvent</a></code>
137-
- <code><a href="./src/resources/messages/messages.ts">MessageStartEvent</a></code>
138-
- <code><a href="./src/resources/messages/messages.ts">MessageDeltaEvent</a></code>
139-
- <code><a href="./src/resources/messages/messages.ts">MessageStopEvent</a></code>
140-
- <code><a href="./src/resources/messages/messages.ts">ContentBlockStartEvent</a></code>
141-
- <code><a href="./src/resources/messages/messages.ts">ContentBlockDeltaEvent</a></code>
142-
- <code><a href="./src/resources/messages/messages.ts">ContentBlockStopEvent</a></code>
55+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaBase64ImageSource</a></code>
56+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaBase64PDFSource</a></code>
57+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCacheControlEphemeral</a></code>
58+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCacheCreation</a></code>
59+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationCharLocation</a></code>
60+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationCharLocationParam</a></code>
61+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationContentBlockLocation</a></code>
62+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationContentBlockLocationParam</a></code>
63+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationPageLocation</a></code>
64+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationPageLocationParam</a></code>
65+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationWebSearchResultLocationParam</a></code>
66+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationsConfigParam</a></code>
67+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationsDelta</a></code>
68+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationsWebSearchResultLocation</a></code>
69+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionOutputBlock</a></code>
70+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionOutputBlockParam</a></code>
71+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionResultBlock</a></code>
72+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionResultBlockParam</a></code>
73+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionTool20250522</a></code>
74+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionToolResultBlock</a></code>
75+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionToolResultBlockContent</a></code>
76+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionToolResultBlockParam</a></code>
77+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionToolResultBlockParamContent</a></code>
78+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionToolResultError</a></code>
79+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionToolResultErrorCode</a></code>
80+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaCodeExecutionToolResultErrorParam</a></code>
81+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaContainer</a></code>
82+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaContainerUploadBlock</a></code>
83+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaContainerUploadBlockParam</a></code>
84+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaContentBlock</a></code>
85+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaContentBlockParam</a></code>
86+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaContentBlockSource</a></code>
87+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaContentBlockSourceContent</a></code>
88+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaFileDocumentSource</a></code>
89+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaFileImageSource</a></code>
90+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaImageBlockParam</a></code>
91+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaInputJSONDelta</a></code>
92+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaMCPToolResultBlock</a></code>
93+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaMCPToolUseBlock</a></code>
94+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaMCPToolUseBlockParam</a></code>
95+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaMessage</a></code>
96+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaMessageDeltaUsage</a></code>
97+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaMessageParam</a></code>
98+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaMessageTokensCount</a></code>
99+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaMetadata</a></code>
100+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaPlainTextSource</a></code>
101+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRawContentBlockDelta</a></code>
102+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRawContentBlockDeltaEvent</a></code>
103+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRawContentBlockStartEvent</a></code>
104+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRawContentBlockStopEvent</a></code>
105+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRawMessageDeltaEvent</a></code>
106+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRawMessageStartEvent</a></code>
107+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRawMessageStopEvent</a></code>
108+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRawMessageStreamEvent</a></code>
109+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRedactedThinkingBlock</a></code>
110+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRedactedThinkingBlockParam</a></code>
111+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRequestDocumentBlock</a></code>
112+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRequestMCPServerToolConfiguration</a></code>
113+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRequestMCPServerURLDefinition</a></code>
114+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaRequestMCPToolResultBlockParam</a></code>
115+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaServerToolUsage</a></code>
116+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaServerToolUseBlock</a></code>
117+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaServerToolUseBlockParam</a></code>
118+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaSignatureDelta</a></code>
119+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaStopReason</a></code>
120+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaTextBlock</a></code>
121+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaTextBlockParam</a></code>
122+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaTextCitation</a></code>
123+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaTextCitationParam</a></code>
124+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaTextDelta</a></code>
125+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaThinkingBlock</a></code>
126+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaThinkingBlockParam</a></code>
127+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaThinkingConfigDisabled</a></code>
128+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaThinkingConfigEnabled</a></code>
129+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaThinkingConfigParam</a></code>
130+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaThinkingDelta</a></code>
131+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaTool</a></code>
132+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolBash20241022</a></code>
133+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolBash20250124</a></code>
134+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolChoice</a></code>
135+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolChoiceAny</a></code>
136+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolChoiceAuto</a></code>
137+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolChoiceNone</a></code>
138+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolChoiceTool</a></code>
139+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolComputerUse20241022</a></code>
140+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolComputerUse20250124</a></code>
141+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolResultBlockParam</a></code>
142+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolTextEditor20241022</a></code>
143+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolTextEditor20250124</a></code>
144+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolTextEditor20250429</a></code>
145+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolUnion</a></code>
146+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolUseBlock</a></code>
147+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaToolUseBlockParam</a></code>
148+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaURLImageSource</a></code>
149+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaURLPDFSource</a></code>
150+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaUsage</a></code>
151+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaWebSearchResultBlock</a></code>
152+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaWebSearchResultBlockParam</a></code>
153+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaWebSearchTool20250305</a></code>
154+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaWebSearchToolRequestError</a></code>
155+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaWebSearchToolResultBlock</a></code>
156+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaWebSearchToolResultBlockContent</a></code>
157+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaWebSearchToolResultBlockParam</a></code>
158+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaWebSearchToolResultBlockParamContent</a></code>
159+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaWebSearchToolResultError</a></code>
160+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaWebSearchToolResultErrorCode</a></code>
161+
- <code><a href="./src/resources/beta/messages/messages.ts">BetaBase64PDFBlock</a></code>
143162

144163
Methods:
145164

146-
- <code title="post /v1/messages">client.messages.<a href="./src/resources/messages/messages.ts">create</a>({ ...params }) -> Message</code>
147-
- <code title="post /v1/messages/count_tokens">client.messages.<a href="./src/resources/messages/messages.ts">countTokens</a>({ ...params }) -> MessageTokensCount</code>
148-
- <code>client.messages.<a href="./src/resources/messages.ts">stream</a>(body, options?) -> MessageStream</code>
165+
- <code title="post /v1/messages?beta=true">client.beta.messages.<a href="./src/resources/beta/messages/messages.ts">create</a>({ ...params }) -> BetaMessage</code>
166+
- <code title="post /v1/messages/count_tokens?beta=true">client.beta.messages.<a href="./src/resources/beta/messages/messages.ts">countTokens</a>({ ...params }) -> BetaMessageTokensCount</code>
149167

150168
### Batches
151169

0 commit comments

Comments
 (0)