ContainersAPI extension
───────────────────────────────────────────────────────────────────────── API surface ─────────────────────────────────────────────────────────────────────────
- on
Methods
-
createContainer(
{required String name, ContainerExpiresAfter? expiresAfter, List< String> ? fileIds}) → Future<Container> -
Available on OpenAIClient, provided by the ContainersAPI extension
Create a container. -
createContainerFile(
{required String containerId, Uint8List? bytes, String? filename, String? fileId}) → Future< ContainerFile> -
Available on OpenAIClient, provided by the ContainersAPI extension
Create a container file either by uploading raw bytes (multipart) or by referencing an existing OpenAI File withfileId
. -
deleteContainer(
String containerId) → Future< ContainerDeleted> -
Available on OpenAIClient, provided by the ContainersAPI extension
Delete a container by ID. -
deleteContainerFile(
String containerId, String fileId) → Future< ContainerFileDeleted> -
Available on OpenAIClient, provided by the ContainersAPI extension
Delete a container file by ID. -
listContainerFiles(
String containerId, {String? after, int? limit, String? order}) → Future< ContainerFileList> -
Available on OpenAIClient, provided by the ContainersAPI extension
List files inside a container (paginated). -
listContainers(
{String? after, int? limit, String? order}) → Future< ContainerList> -
Available on OpenAIClient, provided by the ContainersAPI extension
List containers (paginated). -
retrieveContainer(
String containerId) → Future< Container> -
Available on OpenAIClient, provided by the ContainersAPI extension
Retrieve a single container by ID. -
retrieveContainerFile(
String containerId, String fileId) → Future< ContainerFile> -
Available on OpenAIClient, provided by the ContainersAPI extension
Retrieve a single container file’s metadata. -
retrieveContainerFileContent(
String containerId, String fileId) → Future< Uint8List> -
Available on OpenAIClient, provided by the ContainersAPI extension
Download the container file content as bytes. -
streamContainerFileContent(
String containerId, String fileId) → Stream< Uint8List> -
Available on OpenAIClient, provided by the ContainersAPI extension
Stream the container file content as chunks (useful for large files).