Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/create-releases.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,3 @@ jobs:
if: ${{ steps.release.outputs.releases_created }}
run: |
bash ./bin/publish-jsr

1 change: 0 additions & 1 deletion .github/workflows/release-doctor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ jobs:
env:
STAINLESS_API_KEY: ${{ secrets.STAINLESS_API_KEY }}
NPM_TOKEN: ${{ secrets.OPENAI_NPM_TOKEN || secrets.NPM_TOKEN }}

2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "6.1.0"
".": "6.2.0"
}
8 changes: 4 additions & 4 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 122
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-fadefdc7c7e30df47c09df323669b242ff90ee08e51f304175ace5274e0aab49.yml
openapi_spec_hash: 6d20f639d9ff8a097a34962da6218231
config_hash: 902654e60f5d659f2bfcfd903e17c46d
configured_endpoints: 135
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-d64cf80d2ebddf175c5578f68226a3d5bbd3f7fd8d62ccac2205f3fc05a355ee.yml
openapi_spec_hash: d51e0d60d0c536f210b597a211bc5af0
config_hash: e7c42016df9c6bd7bd6ff15101b9bc9b
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Changelog

## 6.2.0 (2025-10-06)

Full Changelog: [v6.1.0...v6.2.0](https://github.com/openai/openai-node/compare/v6.1.0...v6.2.0)

### Features

* **api:** dev day 2025 launches ([f2816db](https://github.com/openai/openai-node/commit/f2816dbc6ae162d39017e7bafb0d23d0b51dd585))


### Chores

* **internal:** codegen related update ([b6f64b7](https://github.com/openai/openai-node/commit/b6f64b70ea681b174695d930f957aa49194553ed))
* **jsdoc:** fix [@link](https://github.com/link) annotations to refer only to parts of the package‘s public interface ([73e465d](https://github.com/openai/openai-node/commit/73e465d382a45389ab47a0a92575e4415e8d3276))

## 6.1.0 (2025-10-02)

Full Changelog: [v6.0.1...v6.1.0](https://github.com/openai/openai-node/compare/v6.0.1...v6.1.0)
Expand Down
4 changes: 4 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ client.example.list(undefined, { headers: { ... } });
- `client.fineTuning.checkpoints.permissions.retrieve()`
- `client.vectorStores.list()`
- `client.vectorStores.files.list()`
- `client.beta.chatkit.threads.list()`
- `client.beta.chatkit.threads.listItems()`
- `client.beta.assistants.list()`
- `client.beta.threads.create()`
- `client.beta.threads.runs.list()`
Expand All @@ -140,6 +142,8 @@ client.example.list(undefined, { headers: { ... } });
- `client.evals.runs.list()`
- `client.containers.list()`
- `client.containers.files.list()`
- `client.videos.list()`
- `client.videos.downloadContent()`

### HTTP method naming

Expand Down
70 changes: 70 additions & 0 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,56 @@ Types:
Methods:

- <code title="post /realtime/transcription_sessions">client.beta.realtime.transcriptionSessions.<a href="./src/resources/beta/realtime/transcription-sessions.ts">create</a>({ ...params }) -> TranscriptionSession</code>
## ChatKit

Types:

- <code><a href="./src/resources/beta/chatkit/chatkit.ts">ChatKitWorkflow</a></code>
- <code><a href="./src/resources/beta/chatkit/chatkit.ts">FilePart</a></code>
- <code><a href="./src/resources/beta/chatkit/chatkit.ts">ImagePart</a></code>
- <code><a href="./src/resources/beta/chatkit/chatkit.ts">ChatKitUploadFileResponse</a></code>

Methods:

- <code title="post /chatkit/files">client.beta.chatkit.<a href="./src/resources/beta/chatkit/chatkit.ts">uploadFile</a>({ ...params }) -> ChatKitUploadFileResponse</code>

### Sessions

Methods:

- <code title="post /chatkit/sessions">client.beta.chatkit.sessions.<a href="./src/resources/beta/chatkit/sessions.ts">create</a>({ ...params }) -> ChatSession</code>
- <code title="post /chatkit/sessions/{session_id}/cancel">client.beta.chatkit.sessions.<a href="./src/resources/beta/chatkit/sessions.ts">cancel</a>(sessionID) -> ChatSession</code>

### Threads

Types:

- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSession</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSessionAutomaticThreadTitling</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSessionChatKitConfiguration</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSessionChatKitConfigurationParam</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSessionExpiresAfterParam</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSessionFileUpload</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSessionHistory</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSessionRateLimits</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSessionRateLimitsParam</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSessionStatus</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatSessionWorkflowParam</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatKitAttachment</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatKitResponseOutputText</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatKitThread</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatKitThreadAssistantMessageItem</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatKitThreadItemList</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatKitThreadUserMessageItem</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ChatKitWidgetItem</a></code>
- <code><a href="./src/resources/beta/chatkit/threads.ts">ThreadDeleteResponse</a></code>

Methods:

- <code title="get /chatkit/threads/{thread_id}">client.beta.chatkit.threads.<a href="./src/resources/beta/chatkit/threads.ts">retrieve</a>(threadID) -> ChatKitThread</code>
- <code title="get /chatkit/threads">client.beta.chatkit.threads.<a href="./src/resources/beta/chatkit/threads.ts">list</a>({ ...params }) -> ChatKitThreadsPage</code>
- <code title="delete /chatkit/threads/{thread_id}">client.beta.chatkit.threads.<a href="./src/resources/beta/chatkit/threads.ts">delete</a>(threadID) -> ThreadDeleteResponse</code>
- <code title="get /chatkit/threads/{thread_id}/items">client.beta.chatkit.threads.<a href="./src/resources/beta/chatkit/threads.ts">listItems</a>(threadID, { ...params }) -> ChatKitThreadItemListDataPage</code>

## Assistants

Expand Down Expand Up @@ -1032,3 +1082,23 @@ Methods:
Methods:

- <code title="get /containers/{container_id}/files/{file_id}/content">client.containers.files.content.<a href="./src/resources/containers/files/content.ts">retrieve</a>(fileID, { ...params }) -> Response</code>

# Videos

Types:

- <code><a href="./src/resources/videos.ts">Video</a></code>
- <code><a href="./src/resources/videos.ts">VideoCreateError</a></code>
- <code><a href="./src/resources/videos.ts">VideoModel</a></code>
- <code><a href="./src/resources/videos.ts">VideoSeconds</a></code>
- <code><a href="./src/resources/videos.ts">VideoSize</a></code>
- <code><a href="./src/resources/videos.ts">VideoDeleteResponse</a></code>

Methods:

- <code title="post /videos">client.videos.<a href="./src/resources/videos.ts">create</a>({ ...params }) -> Video</code>
- <code title="get /videos/{video_id}">client.videos.<a href="./src/resources/videos.ts">retrieve</a>(videoID) -> Video</code>
- <code title="get /videos">client.videos.<a href="./src/resources/videos.ts">list</a>({ ...params }) -> VideosPage</code>
- <code title="delete /videos/{video_id}">client.videos.<a href="./src/resources/videos.ts">delete</a>(videoID) -> VideoDeleteResponse</code>
- <code title="get /videos/{video_id}/content">client.videos.<a href="./src/resources/videos.ts">downloadContent</a>(videoID, { ...params }) -> Response</code>
- <code title="post /videos/{video_id}/remix">client.videos.<a href="./src/resources/videos.ts">remix</a>(videoID, { ...params }) -> Video</code>
6 changes: 3 additions & 3 deletions bin/cli
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ const commands = {
if (result.status !== 0) {
process.exit(result.status);
}
}
}
}
},
},
};

function exitWithHelp() {
console.log(`Usage: openai <subcommand>`);
Expand Down
2 changes: 1 addition & 1 deletion jsr.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@openai/openai",
"version": "6.1.0",
"version": "6.2.0",
"exports": {
".": "./index.ts",
"./helpers/zod": "./helpers/zod.ts",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "openai",
"version": "6.1.0",
"version": "6.2.0",
"description": "The official TypeScript library for the OpenAI API",
"author": "OpenAI <[email protected]>",
"types": "dist/index.d.ts",
Expand Down
4 changes: 4 additions & 0 deletions scripts/detect-breaking-changes
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ TEST_PATHS=(
tests/api-resources/beta/realtime/realtime.test.ts
tests/api-resources/beta/realtime/sessions.test.ts
tests/api-resources/beta/realtime/transcription-sessions.test.ts
tests/api-resources/beta/chatkit/chatkit.test.ts
tests/api-resources/beta/chatkit/sessions.test.ts
tests/api-resources/beta/chatkit/threads.test.ts
tests/api-resources/beta/assistants.test.ts
tests/api-resources/beta/threads/threads.test.ts
tests/api-resources/beta/threads/runs/runs.test.ts
Expand All @@ -55,6 +58,7 @@ TEST_PATHS=(
tests/api-resources/containers/containers.test.ts
tests/api-resources/containers/files/files.test.ts
tests/api-resources/containers/files/content.test.ts
tests/api-resources/videos.test.ts
tests/index.test.ts
)

Expand Down
31 changes: 31 additions & 0 deletions src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,20 @@ import {
ModerationTextInput,
Moderations,
} from './resources/moderations';
import {
Video,
VideoCreateError,
VideoCreateParams,
VideoDeleteResponse,
VideoDownloadContentParams,
VideoListParams,
VideoModel,
VideoRemixParams,
VideoSeconds,
VideoSize,
Videos,
VideosPage,
} from './resources/videos';
import { Webhooks } from './resources/webhooks';
import { Audio, AudioModel, AudioResponseFormat } from './resources/audio/audio';
import { Beta } from './resources/beta/beta';
Expand Down Expand Up @@ -1004,6 +1018,7 @@ export class OpenAI {
conversations: API.Conversations = new API.Conversations(this);
evals: API.Evals = new API.Evals(this);
containers: API.Containers = new API.Containers(this);
videos: API.Videos = new API.Videos(this);
}

OpenAI.Completions = Completions;
Expand All @@ -1026,6 +1041,7 @@ OpenAI.Realtime = Realtime;
OpenAI.Conversations = Conversations;
OpenAI.Evals = Evals;
OpenAI.Containers = Containers;
OpenAI.Videos = Videos;

export declare namespace OpenAI {
export type RequestOptions = Opts.RequestOptions;
Expand Down Expand Up @@ -1235,6 +1251,21 @@ export declare namespace OpenAI {
type ContainerListParams as ContainerListParams,
};

export {
Videos as Videos,
type Video as Video,
type VideoCreateError as VideoCreateError,
type VideoModel as VideoModel,
type VideoSeconds as VideoSeconds,
type VideoSize as VideoSize,
type VideoDeleteResponse as VideoDeleteResponse,
type VideosPage as VideosPage,
type VideoCreateParams as VideoCreateParams,
type VideoListParams as VideoListParams,
type VideoDownloadContentParams as VideoDownloadContentParams,
type VideoRemixParams as VideoRemixParams,
};

export type AllModels = API.AllModels;
export type ChatModel = API.ChatModel;
export type ComparisonFilter = API.ComparisonFilter;
Expand Down
2 changes: 1 addition & 1 deletion src/internal/to-file.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ export type ToFileInput =

/**
* Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
* @param value the raw content of the file. Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
* @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
* @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
* @param {Object=} options additional properties
* @param {string=} options.type the MIME type of the content
Expand Down
17 changes: 17 additions & 0 deletions src/resources/beta/beta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,15 @@ import {
TranscriptionSessionUpdate,
TranscriptionSessionUpdatedEvent,
} from './realtime/realtime';
import * as ChatKitAPI from './chatkit/chatkit';
import {
ChatKit,
ChatKitUploadFileParams,
ChatKitUploadFileResponse,
ChatKitWorkflow,
FilePart,
ImagePart,
} from './chatkit/chatkit';
import * as ThreadsAPI from './threads/threads';
import {
AssistantResponseFormatOption,
Expand All @@ -93,11 +102,13 @@ import {

export class Beta extends APIResource {
realtime: RealtimeAPI.Realtime = new RealtimeAPI.Realtime(this._client);
chatkit: ChatKitAPI.ChatKit = new ChatKitAPI.ChatKit(this._client);
assistants: AssistantsAPI.Assistants = new AssistantsAPI.Assistants(this._client);
threads: ThreadsAPI.Threads = new ThreadsAPI.Threads(this._client);
}

Beta.Realtime = Realtime;
Beta.ChatKit = ChatKit;
Beta.Assistants = Assistants;
Beta.Threads = Threads;

Expand Down Expand Up @@ -153,6 +164,12 @@ export declare namespace Beta {
type SessionUpdatedEvent as SessionUpdatedEvent,
type TranscriptionSessionUpdate as TranscriptionSessionUpdate,
type TranscriptionSessionUpdatedEvent as TranscriptionSessionUpdatedEvent,
ChatKit as ChatKit,
type ChatKitWorkflow as ChatKitWorkflow,
type FilePart as FilePart,
type ImagePart as ImagePart,
type ChatKitUploadFileResponse as ChatKitUploadFileResponse,
type ChatKitUploadFileParams as ChatKitUploadFileParams,
};

export {
Expand Down
3 changes: 3 additions & 0 deletions src/resources/beta/chatkit.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

export * from './chatkit/index';
Loading