Files

List container files

client.Containers.Files.List(ctx, containerID, query) (*CursorPage[ContainerFileListResponse], error)

get /containers/{container_id}/files

List container files

Parameters

containerID string
query ContainerFileListParams
- After param.Field[string]
  
  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.
- Limit param.Field[int64]
  
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- Order param.Field[ContainerFileListParamsOrder]
  
  Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
  - const ContainerFileListParamsOrderAsc ContainerFileListParamsOrder = "asc"
  - const ContainerFileListParamsOrderDesc ContainerFileListParamsOrder = "desc"

Returns

type ContainerFileListResponse struct{…}
- ID string
  
  Unique identifier for the file.
- Bytes int64
  
  Size of the file in bytes.
- ContainerID string
  
  The container this file belongs to.
- CreatedAt int64
  
  Unix timestamp (in seconds) when the file was created.
- Object ContainerFile
  
  The type of this object (container.file).
  - const ContainerFileContainerFile ContainerFile = "container.file"
- Path string
  
  Path of the file in the container.
- Source string
  
  Source of the file (e.g., user, assistant).

Example

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Containers.Files.List(
    context.TODO(),
    "container_id",
    openai.ContainerFileListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

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

client.Containers.Files.New(ctx, containerID, body) (*ContainerFileNewResponse, error)

post /containers/{container_id}/files

Create container file

Parameters

containerID string
body ContainerFileNewParams
- File param.Field[Reader]
  
  The File object (not file name) to be uploaded.
- FileID param.Field[string]
  
  Name of the file to create.

Returns

type ContainerFileNewResponse struct{…}
- ID string
  
  Unique identifier for the file.
- Bytes int64
  
  Size of the file in bytes.
- ContainerID string
  
  The container this file belongs to.
- CreatedAt int64
  
  Unix timestamp (in seconds) when the file was created.
- Object ContainerFile
  
  The type of this object (container.file).
  - const ContainerFileContainerFile ContainerFile = "container.file"
- Path string
  
  Path of the file in the container.
- Source string
  
  Source of the file (e.g., user, assistant).

Example

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  file, err := client.Containers.Files.New(
    context.TODO(),
    "container_id",
    openai.ContainerFileNewParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", file.ID)
}

Response

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

Retrieve container file

client.Containers.Files.Get(ctx, containerID, fileID) (*ContainerFileGetResponse, error)

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

Retrieve container file

Parameters

containerID string
fileID string

Returns

type ContainerFileGetResponse struct{…}
- ID string
  
  Unique identifier for the file.
- Bytes int64
  
  Size of the file in bytes.
- ContainerID string
  
  The container this file belongs to.
- CreatedAt int64
  
  Unix timestamp (in seconds) when the file was created.
- Object ContainerFile
  
  The type of this object (container.file).
  - const ContainerFileContainerFile ContainerFile = "container.file"
- Path string
  
  Path of the file in the container.
- Source string
  
  Source of the file (e.g., user, assistant).

Example

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  file, err := client.Containers.Files.Get(
    context.TODO(),
    "container_id",
    "file_id",
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", file.ID)
}

Response

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

Delete a container file

client.Containers.Files.Delete(ctx, containerID, fileID) error

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

Delete a container file

Parameters

containerID string
fileID string

Example

package main

import (
  "context"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  err := client.Containers.Files.Delete(
    context.TODO(),
    "container_id",
    "file_id",
  )
  if err != nil {
    panic(err.Error())
  }
}

Content

Retrieve container file content

client.Containers.Files.Content.Get(ctx, containerID, fileID) (*Response, error)

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

Retrieve container file content

Parameters

containerID string
fileID string

Returns

type ContainerFileContentGetResponse interface{…}

Example

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  content, err := client.Containers.Files.Content.Get(
    context.TODO(),
    "container_id",
    "file_id",
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", content)
}

go/resources/containers/subresources/files/index.md +400 −0 created

1# Files

3## List container files

5`client.Containers.Files.List(ctx, containerID, query) (*CursorPage[ContainerFileListResponse], error)`

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

9List container files

11### Parameters

13- `containerID string`

15- `query ContainerFileListParams`

17 - `After param.Field[string]`

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 - `Limit param.Field[int64]`

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

25 - `Order param.Field[ContainerFileListParamsOrder]`

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

29 - `const ContainerFileListParamsOrderAsc ContainerFileListParamsOrder = "asc"`

31 - `const ContainerFileListParamsOrderDesc ContainerFileListParamsOrder = "desc"`

33### Returns

35- `type ContainerFileListResponse struct{…}`

37 - `ID string`

39 Unique identifier for the file.

41 - `Bytes int64`

43 Size of the file in bytes.

45 - `ContainerID string`

47 The container this file belongs to.

49 - `CreatedAt int64`

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

53 - `Object ContainerFile`

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

57 - `const ContainerFileContainerFile ContainerFile = "container.file"`

59 - `Path string`

61 Path of the file in the container.

63 - `Source string`

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

67### Example

69```go

70package main

72import (

73 "context"

74 "fmt"

76 "github.com/openai/openai-go"

77 "github.com/openai/openai-go/option"

78)

80func main() {

81 client := openai.NewClient(

82 option.WithAPIKey("My API Key"),

83 )

84 page, err := client.Containers.Files.List(

85 context.TODO(),

86 "container_id",

87 openai.ContainerFileListParams{

89 },

90 )

91 if err != nil {

92 panic(err.Error())

93 }

94 fmt.Printf("%+v\n", page)

95}

96```

98#### Response

100```json

101{

102 "data": [

103 {

104 "id": "id",

105 "bytes": 0,

106 "container_id": "container_id",

107 "created_at": 0,

108 "object": "container.file",

109 "path": "path",

110 "source": "source"

111 }

112 ],

113 "first_id": "first_id",

114 "has_more": true,

115 "last_id": "last_id",

116 "object": "list"

117}

118```

119

120## Create container file

121

122`client.Containers.Files.New(ctx, containerID, body) (*ContainerFileNewResponse, error)`

123

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

125

126Create container file

127

128### Parameters

129

130- `containerID string`

131

132- `body ContainerFileNewParams`

133

134 - `File param.Field[Reader]`

135

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

137

138 - `FileID param.Field[string]`

139

140 Name of the file to create.

141

142### Returns

143

144- `type ContainerFileNewResponse struct{…}`

145

146 - `ID string`

147

148 Unique identifier for the file.

149

150 - `Bytes int64`

151

152 Size of the file in bytes.

153

154 - `ContainerID string`

155

156 The container this file belongs to.

157

158 - `CreatedAt int64`

159

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

161

162 - `Object ContainerFile`

163

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

165

166 - `const ContainerFileContainerFile ContainerFile = "container.file"`

167

168 - `Path string`

169

170 Path of the file in the container.

171

172 - `Source string`

173

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

175

176### Example

177

178```go

179package main

180

181import (

182 "context"

183 "fmt"

184

185 "github.com/openai/openai-go"

186 "github.com/openai/openai-go/option"

187)

188

189func main() {

190 client := openai.NewClient(

191 option.WithAPIKey("My API Key"),

192 )

193 file, err := client.Containers.Files.New(

194 context.TODO(),

195 "container_id",

196 openai.ContainerFileNewParams{

197

198 },

199 )

200 if err != nil {

201 panic(err.Error())

202 }

203 fmt.Printf("%+v\n", file.ID)

204}

205```

206

207#### Response

208

209```json

210{

211 "id": "id",

212 "bytes": 0,

213 "container_id": "container_id",

214 "created_at": 0,

215 "object": "container.file",

216 "path": "path",

217 "source": "source"

218}

219```

220

221## Retrieve container file

222

223`client.Containers.Files.Get(ctx, containerID, fileID) (*ContainerFileGetResponse, error)`

224

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

226

227Retrieve container file

228

229### Parameters

230

231- `containerID string`

232

233- `fileID string`

234

235### Returns

236

237- `type ContainerFileGetResponse struct{…}`

238

239 - `ID string`

240

241 Unique identifier for the file.

242

243 - `Bytes int64`

244

245 Size of the file in bytes.

246

247 - `ContainerID string`

248

249 The container this file belongs to.

250

251 - `CreatedAt int64`

252

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

254

255 - `Object ContainerFile`

256

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

258

259 - `const ContainerFileContainerFile ContainerFile = "container.file"`

260

261 - `Path string`

262

263 Path of the file in the container.

264

265 - `Source string`

266

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

268

269### Example

270

271```go

272package main

273

274import (

275 "context"

276 "fmt"

277

278 "github.com/openai/openai-go"

279 "github.com/openai/openai-go/option"

280)

281

282func main() {

283 client := openai.NewClient(

284 option.WithAPIKey("My API Key"),

285 )

286 file, err := client.Containers.Files.Get(

287 context.TODO(),

288 "container_id",

289 "file_id",

290 )

291 if err != nil {

292 panic(err.Error())

293 }

294 fmt.Printf("%+v\n", file.ID)

295}

296```

297

298#### Response

299

300```json

301{

302 "id": "id",

303 "bytes": 0,

304 "container_id": "container_id",

305 "created_at": 0,

306 "object": "container.file",

307 "path": "path",

308 "source": "source"

309}

310```

311

312## Delete a container file

313

314`client.Containers.Files.Delete(ctx, containerID, fileID) error`

315

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

317

318Delete a container file

319

320### Parameters

321

322- `containerID string`

323

324- `fileID string`

325

326### Example

327

328```go

329package main

330

331import (

332 "context"

333

334 "github.com/openai/openai-go"

335 "github.com/openai/openai-go/option"

336)

337

338func main() {

339 client := openai.NewClient(

340 option.WithAPIKey("My API Key"),

341 )

342 err := client.Containers.Files.Delete(

343 context.TODO(),

344 "container_id",

345 "file_id",

346 )

347 if err != nil {

348 panic(err.Error())

349 }

350}

351```

352

353# Content

354

355## Retrieve container file content

356

357`client.Containers.Files.Content.Get(ctx, containerID, fileID) (*Response, error)`

358

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

360

361Retrieve container file content

362

363### Parameters

364

365- `containerID string`

366

367- `fileID string`

368

369### Returns

370

371- `type ContainerFileContentGetResponse interface{…}`

372

373### Example

374

375```go

376package main

377

378import (

379 "context"

380 "fmt"

381

382 "github.com/openai/openai-go"

383 "github.com/openai/openai-go/option"

384)

385

386func main() {

387 client := openai.NewClient(

388 option.WithAPIKey("My API Key"),

389 )

390 content, err := client.Containers.Files.Content.Get(

391 context.TODO(),

392 "container_id",

393 "file_id",

394 )

395 if err != nil {

396 panic(err.Error())

397 }

398 fmt.Printf("%+v\n", content)

399}

400```

go/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

Returns

Example