Files

List container files

FileListPage containers().files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /containers/{container_id}/files

List container files

Parameters

FileListParams params
- Optional<String> containerId
- Optional<String> after
  
  A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
- Optional<Long> limit
  
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- Optional<Order> order
  
  Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
  - ASC("asc")
  - DESC("desc")

Returns

class FileListResponse:
- String id
  
  Unique identifier for the file.
- long bytes
  
  Size of the file in bytes.
- String containerId
  
  The container this file belongs to.
- long createdAt
  
  Unix timestamp (in seconds) when the file was created.
- JsonValue; object_ "container.file"constant
  
  The type of this object (container.file).
  - CONTAINER_FILE("container.file")
- String path
  
  Path of the file in the container.
- String source
  
  Source of the file (e.g., user, assistant).

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.files.FileListPage;
import com.openai.models.containers.files.FileListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileListPage page = client.containers().files().list("container_id");
    }
}

Response

{
  "data": [
    {
      "id": "id",
      "bytes": 0,
      "container_id": "container_id",
      "created_at": 0,
      "object": "container.file",
      "path": "path",
      "source": "source"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}

Create container file

FileCreateResponse containers().files().create(FileCreateParamsparams = FileCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post /containers/{container_id}/files

Create container file

Parameters

FileCreateParams params
- Optional<String> containerId
- Optional<String> file
  
  The File object (not file name) to be uploaded.
- Optional<String> fileId
  
  Name of the file to create.

Returns

class FileCreateResponse:
- String id
  
  Unique identifier for the file.
- long bytes
  
  Size of the file in bytes.
- String containerId
  
  The container this file belongs to.
- long createdAt
  
  Unix timestamp (in seconds) when the file was created.
- JsonValue; object_ "container.file"constant
  
  The type of this object (container.file).
  - CONTAINER_FILE("container.file")
- String path
  
  Path of the file in the container.
- String source
  
  Source of the file (e.g., user, assistant).

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.files.FileCreateParams;
import com.openai.models.containers.files.FileCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileCreateResponse file = client.containers().files().create("container_id");
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "container_id": "container_id",
  "created_at": 0,
  "object": "container.file",
  "path": "path",
  "source": "source"
}

Retrieve container file

FileRetrieveResponse containers().files().retrieve(FileRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

get /containers/{container_id}/files/{file_id}

Retrieve container file

Parameters

FileRetrieveParams params
- String containerId
- Optional<String> fileId

Returns

class FileRetrieveResponse:
- String id
  
  Unique identifier for the file.
- long bytes
  
  Size of the file in bytes.
- String containerId
  
  The container this file belongs to.
- long createdAt
  
  Unix timestamp (in seconds) when the file was created.
- JsonValue; object_ "container.file"constant
  
  The type of this object (container.file).
  - CONTAINER_FILE("container.file")
- String path
  
  Path of the file in the container.
- String source
  
  Source of the file (e.g., user, assistant).

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.files.FileRetrieveParams;
import com.openai.models.containers.files.FileRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileRetrieveParams params = FileRetrieveParams.builder()
            .containerId("container_id")
            .fileId("file_id")
            .build();
        FileRetrieveResponse file = client.containers().files().retrieve(params);
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "container_id": "container_id",
  "created_at": 0,
  "object": "container.file",
  "path": "path",
  "source": "source"
}

Delete a container file

containers().files().delete(FileDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

delete /containers/{container_id}/files/{file_id}

Delete a container file

Parameters

FileDeleteParams params
- String containerId
- Optional<String> fileId

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.files.FileDeleteParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileDeleteParams params = FileDeleteParams.builder()
            .containerId("container_id")
            .fileId("file_id")
            .build();
        client.containers().files().delete(params);
    }
}

Content

Retrieve container file content

HttpResponse containers().files().content().retrieve(ContentRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

get /containers/{container_id}/files/{file_id}/content

Retrieve container file content

Parameters

ContentRetrieveParams params
- String containerId
- Optional<String> fileId

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.core.http.HttpResponse;
import com.openai.models.containers.files.content.ContentRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ContentRetrieveParams params = ContentRetrieveParams.builder()
            .containerId("container_id")
            .fileId("file_id")
            .build();
        HttpResponse content = client.containers().files().content().retrieve(params);
    }
}

java/resources/containers/subresources/files/index.md +371 −0 created

1# Files

3## List container files

5`FileListPage containers().files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

7**get** `/containers/{container_id}/files`

9List container files

11### Parameters

13- `FileListParams params`

15 - `Optional<String> containerId`

17 - `Optional<String> after`

19 A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

21 - `Optional<Long> limit`

23 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

25 - `Optional<Order> order`

27 Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

29 - `ASC("asc")`

31 - `DESC("desc")`

33### Returns

35- `class FileListResponse:`

37 - `String id`

39 Unique identifier for the file.

41 - `long bytes`

43 Size of the file in bytes.

45 - `String containerId`

47 The container this file belongs to.

49 - `long createdAt`

51 Unix timestamp (in seconds) when the file was created.

53 - `JsonValue; object_ "container.file"constant`

55 The type of this object (`container.file`).

57 - `CONTAINER_FILE("container.file")`

59 - `String path`

61 Path of the file in the container.

63 - `String source`

65 Source of the file (e.g., `user`, `assistant`).

67### Example

69```java

70package com.openai.example;

72import com.openai.client.OpenAIClient;

73import com.openai.client.okhttp.OpenAIOkHttpClient;

74import com.openai.models.containers.files.FileListPage;

75import com.openai.models.containers.files.FileListParams;

77public final class Main {

78 private Main() {}

80 public static void main(String[] args) {

81 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

83 FileListPage page = client.containers().files().list("container_id");

84 }

85}

86```

88#### Response

90```json

91{

92 "data": [

93 {

94 "id": "id",

95 "bytes": 0,

96 "container_id": "container_id",

97 "created_at": 0,

98 "object": "container.file",

99 "path": "path",

100 "source": "source"

101 }

102 ],

103 "first_id": "first_id",

104 "has_more": true,

105 "last_id": "last_id",

106 "object": "list"

107}

108```

109

110## Create container file

111

112`FileCreateResponse containers().files().create(FileCreateParamsparams = FileCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

113

114**post** `/containers/{container_id}/files`

115

116Create container file

117

118### Parameters

119

120- `FileCreateParams params`

121

122 - `Optional<String> containerId`

123

124 - `Optional<String> file`

125

126 The File object (not file name) to be uploaded.

127

128 - `Optional<String> fileId`

129

130 Name of the file to create.

131

132### Returns

133

134- `class FileCreateResponse:`

135

136 - `String id`

137

138 Unique identifier for the file.

139

140 - `long bytes`

141

142 Size of the file in bytes.

143

144 - `String containerId`

145

146 The container this file belongs to.

147

148 - `long createdAt`

149

150 Unix timestamp (in seconds) when the file was created.

151

152 - `JsonValue; object_ "container.file"constant`

153

154 The type of this object (`container.file`).

155

156 - `CONTAINER_FILE("container.file")`

157

158 - `String path`

159

160 Path of the file in the container.

161

162 - `String source`

163

164 Source of the file (e.g., `user`, `assistant`).

165

166### Example

167

168```java

169package com.openai.example;

170

171import com.openai.client.OpenAIClient;

172import com.openai.client.okhttp.OpenAIOkHttpClient;

173import com.openai.models.containers.files.FileCreateParams;

174import com.openai.models.containers.files.FileCreateResponse;

175

176public final class Main {

177 private Main() {}

178

179 public static void main(String[] args) {

180 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

181

182 FileCreateResponse file = client.containers().files().create("container_id");

183 }

184}

185```

186

187#### Response

188

189```json

190{

191 "id": "id",

192 "bytes": 0,

193 "container_id": "container_id",

194 "created_at": 0,

195 "object": "container.file",

196 "path": "path",

197 "source": "source"

198}

199```

200

201## Retrieve container file

202

203`FileRetrieveResponse containers().files().retrieve(FileRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

204

205**get** `/containers/{container_id}/files/{file_id}`

206

207Retrieve container file

208

209### Parameters

210

211- `FileRetrieveParams params`

212

213 - `String containerId`

214

215 - `Optional<String> fileId`

216

217### Returns

218

219- `class FileRetrieveResponse:`

220

221 - `String id`

222

223 Unique identifier for the file.

224

225 - `long bytes`

226

227 Size of the file in bytes.

228

229 - `String containerId`

230

231 The container this file belongs to.

232

233 - `long createdAt`

234

235 Unix timestamp (in seconds) when the file was created.

236

237 - `JsonValue; object_ "container.file"constant`

238

239 The type of this object (`container.file`).

240

241 - `CONTAINER_FILE("container.file")`

242

243 - `String path`

244

245 Path of the file in the container.

246

247 - `String source`

248

249 Source of the file (e.g., `user`, `assistant`).

250

251### Example

252

253```java

254package com.openai.example;

255

256import com.openai.client.OpenAIClient;

257import com.openai.client.okhttp.OpenAIOkHttpClient;

258import com.openai.models.containers.files.FileRetrieveParams;

259import com.openai.models.containers.files.FileRetrieveResponse;

260

261public final class Main {

262 private Main() {}

263

264 public static void main(String[] args) {

265 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

266

267 FileRetrieveParams params = FileRetrieveParams.builder()

268 .containerId("container_id")

269 .fileId("file_id")

270 .build();

271 FileRetrieveResponse file = client.containers().files().retrieve(params);

272 }

273}

274```

275

276#### Response

277

278```json

279{

280 "id": "id",

281 "bytes": 0,

282 "container_id": "container_id",

283 "created_at": 0,

284 "object": "container.file",

285 "path": "path",

286 "source": "source"

287}

288```

289

290## Delete a container file

291

292`containers().files().delete(FileDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

293

294**delete** `/containers/{container_id}/files/{file_id}`

295

296Delete a container file

297

298### Parameters

299

300- `FileDeleteParams params`

301

302 - `String containerId`

303

304 - `Optional<String> fileId`

305

306### Example

307

308```java

309package com.openai.example;

310

311import com.openai.client.OpenAIClient;

312import com.openai.client.okhttp.OpenAIOkHttpClient;

313import com.openai.models.containers.files.FileDeleteParams;

314

315public final class Main {

316 private Main() {}

317

318 public static void main(String[] args) {

319 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

320

321 FileDeleteParams params = FileDeleteParams.builder()

322 .containerId("container_id")

323 .fileId("file_id")

324 .build();

325 client.containers().files().delete(params);

326 }

327}

328```

329

330# Content

331

332## Retrieve container file content

333

334`HttpResponse containers().files().content().retrieve(ContentRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

335

336**get** `/containers/{container_id}/files/{file_id}/content`

337

338Retrieve container file content

339

340### Parameters

341

342- `ContentRetrieveParams params`

343

344 - `String containerId`

345

346 - `Optional<String> fileId`

347

348### Example

349

350```java

351package com.openai.example;

352

353import com.openai.client.OpenAIClient;

354import com.openai.client.okhttp.OpenAIOkHttpClient;

355import com.openai.core.http.HttpResponse;

356import com.openai.models.containers.files.content.ContentRetrieveParams;

357

358public final class Main {

359 private Main() {}

360

361 public static void main(String[] args) {

362 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

363

364 ContentRetrieveParams params = ContentRetrieveParams.builder()

365 .containerId("container_id")

366 .fileId("file_id")

367 .build();

368 HttpResponse content = client.containers().files().content().retrieve(params);

369 }

370}

371```

java/resources/containers/subresources/files/index.md 2026-07-07 08:02 UTC to 2026-07-09 20:58 UTC

Files

List container files

Parameters

Returns

Example

Response

Create container file

Parameters

Returns

Example

Response

Retrieve container file

Parameters

Returns

Example

Response

Delete a container file

Parameters

Example

Content

Retrieve container file content

Parameters

Example