Checkpoints

Permissions

List checkpoint permissions

PermissionRetrieveResponse fineTuning().checkpoints().permissions().retrieve(PermissionRetrieveParamsparams = PermissionRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

List checkpoint permissions

Parameters

PermissionRetrieveParams params
- Optional<String> fineTunedModelCheckpoint
- Optional<String> after
  
  Identifier for the last permission ID from the previous pagination request.
- Optional<Long> limit
  
  Number of permissions to retrieve.
- Optional<Order> order
  
  The order in which to retrieve permissions.
  - ASCENDING("ascending")
  - DESCENDING("descending")
- Optional<String> projectId
  
  The ID of the project to get permissions for.

Returns

class PermissionRetrieveResponse:
- List<Data> data
  - String id
    
    The permission identifier, which can be referenced in the API endpoints.
  - long createdAt
    
    The Unix timestamp (in seconds) for when the permission was created.
  - JsonValue; object_ "checkpoint.permission"constant
    
    The object type, which is always "checkpoint.permission".
    - CHECKPOINT_PERMISSION("checkpoint.permission")
  - String projectId
    
    The project identifier that the permission is for.
- boolean hasMore
- JsonValue; object_ "list"constant
  - LIST("list")
- Optional<String> firstId
- Optional<String> lastId

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveParams;
import com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveResponse;

public final class Main {
    private Main() {}

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

        PermissionRetrieveResponse permission = client.fineTuning().checkpoints().permissions().retrieve("ft-AF1WoRqd3aJAHsqc9NY7iL8F");
    }
}

Response

{
  "data": [
    {
      "id": "id",
      "created_at": 0,
      "object": "checkpoint.permission",
      "project_id": "project_id"
    }
  ],
  "has_more": true,
  "object": "list",
  "first_id": "first_id",
  "last_id": "last_id"
}

List checkpoint permissions

PermissionListPage fineTuning().checkpoints().permissions().list(PermissionListParamsparams = PermissionListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

List checkpoint permissions

Parameters

PermissionListParams params
- Optional<String> fineTunedModelCheckpoint
- Optional<String> after
  
  Identifier for the last permission ID from the previous pagination request.
- Optional<Long> limit
  
  Number of permissions to retrieve.
- Optional<Order> order
  
  The order in which to retrieve permissions.
  - ASCENDING("ascending")
  - DESCENDING("descending")
- Optional<String> projectId
  
  The ID of the project to get permissions for.

Returns

class PermissionListResponse:

The checkpoint.permission object represents a permission for a fine-tuned model checkpoint.
- String id
  
  The permission identifier, which can be referenced in the API endpoints.
- long createdAt
  
  The Unix timestamp (in seconds) for when the permission was created.
- JsonValue; object_ "checkpoint.permission"constant
  
  The object type, which is always "checkpoint.permission".
  - CHECKPOINT_PERMISSION("checkpoint.permission")
- String projectId
  
  The project identifier that the permission is for.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.finetuning.checkpoints.permissions.PermissionListPage;
import com.openai.models.finetuning.checkpoints.permissions.PermissionListParams;

public final class Main {
    private Main() {}

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

        PermissionListPage page = client.fineTuning().checkpoints().permissions().list("ft-AF1WoRqd3aJAHsqc9NY7iL8F");
    }
}

Response

{
  "data": [
    {
      "id": "id",
      "created_at": 0,
      "object": "checkpoint.permission",
      "project_id": "project_id"
    }
  ],
  "has_more": true,
  "object": "list",
  "first_id": "first_id",
  "last_id": "last_id"
}

Create checkpoint permissions

PermissionCreatePage fineTuning().checkpoints().permissions().create(PermissionCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

Create checkpoint permissions

Parameters

PermissionCreateParams params
- Optional<String> fineTunedModelCheckpoint
- List<String> projectIds
  
  The project identifiers to grant access to.

Returns

class PermissionCreateResponse:

The checkpoint.permission object represents a permission for a fine-tuned model checkpoint.
- String id
  
  The permission identifier, which can be referenced in the API endpoints.
- long createdAt
  
  The Unix timestamp (in seconds) for when the permission was created.
- JsonValue; object_ "checkpoint.permission"constant
  
  The object type, which is always "checkpoint.permission".
  - CHECKPOINT_PERMISSION("checkpoint.permission")
- String projectId
  
  The project identifier that the permission is for.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.finetuning.checkpoints.permissions.PermissionCreatePage;
import com.openai.models.finetuning.checkpoints.permissions.PermissionCreateParams;

public final class Main {
    private Main() {}

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

        PermissionCreateParams params = PermissionCreateParams.builder()
            .fineTunedModelCheckpoint("ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd")
            .addProjectId("string")
            .build();
        PermissionCreatePage page = client.fineTuning().checkpoints().permissions().create(params);
    }
}

Response

{
  "data": [
    {
      "id": "id",
      "created_at": 0,
      "object": "checkpoint.permission",
      "project_id": "project_id"
    }
  ],
  "has_more": true,
  "object": "list",
  "first_id": "first_id",
  "last_id": "last_id"
}

Delete checkpoint permission

PermissionDeleteResponse fineTuning().checkpoints().permissions().delete(PermissionDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

delete /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}

Delete checkpoint permission

Parameters

PermissionDeleteParams params
- String fineTunedModelCheckpoint
- Optional<String> permissionId

Returns

class PermissionDeleteResponse:
- String id
  
  The ID of the fine-tuned model checkpoint permission that was deleted.
- boolean deleted
  
  Whether the fine-tuned model checkpoint permission was successfully deleted.
- JsonValue; object_ "checkpoint.permission"constant
  
  The object type, which is always "checkpoint.permission".
  - CHECKPOINT_PERMISSION("checkpoint.permission")

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.finetuning.checkpoints.permissions.PermissionDeleteParams;
import com.openai.models.finetuning.checkpoints.permissions.PermissionDeleteResponse;

public final class Main {
    private Main() {}

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

        PermissionDeleteParams params = PermissionDeleteParams.builder()
            .fineTunedModelCheckpoint("ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd")
            .permissionId("cp_zc4Q7MP6XxulcVzj4MZdwsAB")
            .build();
        PermissionDeleteResponse permission = client.fineTuning().checkpoints().permissions().delete(params);
    }
}

Response

{
  "id": "id",
  "deleted": true,
  "object": "checkpoint.permission"
}

java/resources/fine_tuning/subresources/checkpoints/index.md +364 −0 created

1# Checkpoints

3# Permissions

5## List checkpoint permissions

7`PermissionRetrieveResponse fineTuning().checkpoints().permissions().retrieve(PermissionRetrieveParamsparams = PermissionRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

9**get** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions`

11List checkpoint permissions

13### Parameters

15- `PermissionRetrieveParams params`

17 - `Optional<String> fineTunedModelCheckpoint`

19 - `Optional<String> after`

21 Identifier for the last permission ID from the previous pagination request.

23 - `Optional<Long> limit`

25 Number of permissions to retrieve.

27 - `Optional<Order> order`

29 The order in which to retrieve permissions.

31 - `ASCENDING("ascending")`

33 - `DESCENDING("descending")`

35 - `Optional<String> projectId`

37 The ID of the project to get permissions for.

39### Returns

41- `class PermissionRetrieveResponse:`

43 - `List<Data> data`

45 - `String id`

47 The permission identifier, which can be referenced in the API endpoints.

49 - `long createdAt`

51 The Unix timestamp (in seconds) for when the permission was created.

53 - `JsonValue; object_ "checkpoint.permission"constant`

55 The object type, which is always "checkpoint.permission".

57 - `CHECKPOINT_PERMISSION("checkpoint.permission")`

59 - `String projectId`

61 The project identifier that the permission is for.

63 - `boolean hasMore`

65 - `JsonValue; object_ "list"constant`

67 - `LIST("list")`

69 - `Optional<String> firstId`

71 - `Optional<String> lastId`

73### Example

75```java

76package com.openai.example;

78import com.openai.client.OpenAIClient;

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

80import com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveParams;

81import com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveResponse;

83public final class Main {

84 private Main() {}

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

87 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

89 PermissionRetrieveResponse permission = client.fineTuning().checkpoints().permissions().retrieve("ft-AF1WoRqd3aJAHsqc9NY7iL8F");

90 }

91}

92```

94#### Response

96```json

97{

98 "data": [

99 {

100 "id": "id",

101 "created_at": 0,

102 "object": "checkpoint.permission",

103 "project_id": "project_id"

104 }

105 ],

106 "has_more": true,

107 "object": "list",

108 "first_id": "first_id",

109 "last_id": "last_id"

110}

111```

112

113## List checkpoint permissions

114

115`PermissionListPage fineTuning().checkpoints().permissions().list(PermissionListParamsparams = PermissionListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

116

117**get** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions`

118

119List checkpoint permissions

120

121### Parameters

122

123- `PermissionListParams params`

124

125 - `Optional<String> fineTunedModelCheckpoint`

126

127 - `Optional<String> after`

128

129 Identifier for the last permission ID from the previous pagination request.

130

131 - `Optional<Long> limit`

132

133 Number of permissions to retrieve.

134

135 - `Optional<Order> order`

136

137 The order in which to retrieve permissions.

138

139 - `ASCENDING("ascending")`

140

141 - `DESCENDING("descending")`

142

143 - `Optional<String> projectId`

144

145 The ID of the project to get permissions for.

146

147### Returns

148

149- `class PermissionListResponse:`

150

151 The `checkpoint.permission` object represents a permission for a fine-tuned model checkpoint.

152

153 - `String id`

154

155 The permission identifier, which can be referenced in the API endpoints.

156

157 - `long createdAt`

158

159 The Unix timestamp (in seconds) for when the permission was created.

160

161 - `JsonValue; object_ "checkpoint.permission"constant`

162

163 The object type, which is always "checkpoint.permission".

164

165 - `CHECKPOINT_PERMISSION("checkpoint.permission")`

166

167 - `String projectId`

168

169 The project identifier that the permission is for.

170

171### Example

172

173```java

174package com.openai.example;

175

176import com.openai.client.OpenAIClient;

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

178import com.openai.models.finetuning.checkpoints.permissions.PermissionListPage;

179import com.openai.models.finetuning.checkpoints.permissions.PermissionListParams;

180

181public final class Main {

182 private Main() {}

183

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

185 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

186

187 PermissionListPage page = client.fineTuning().checkpoints().permissions().list("ft-AF1WoRqd3aJAHsqc9NY7iL8F");

188 }

189}

190```

191

192#### Response

193

194```json

195{

196 "data": [

197 {

198 "id": "id",

199 "created_at": 0,

200 "object": "checkpoint.permission",

201 "project_id": "project_id"

202 }

203 ],

204 "has_more": true,

205 "object": "list",

206 "first_id": "first_id",

207 "last_id": "last_id"

208}

209```

210

211## Create checkpoint permissions

212

213`PermissionCreatePage fineTuning().checkpoints().permissions().create(PermissionCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

214

215**post** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions`

216

217Create checkpoint permissions

218

219### Parameters

220

221- `PermissionCreateParams params`

222

223 - `Optional<String> fineTunedModelCheckpoint`

224

225 - `List<String> projectIds`

226

227 The project identifiers to grant access to.

228

229### Returns

230

231- `class PermissionCreateResponse:`

232

233 The `checkpoint.permission` object represents a permission for a fine-tuned model checkpoint.

234

235 - `String id`

236

237 The permission identifier, which can be referenced in the API endpoints.

238

239 - `long createdAt`

240

241 The Unix timestamp (in seconds) for when the permission was created.

242

243 - `JsonValue; object_ "checkpoint.permission"constant`

244

245 The object type, which is always "checkpoint.permission".

246

247 - `CHECKPOINT_PERMISSION("checkpoint.permission")`

248

249 - `String projectId`

250

251 The project identifier that the permission is for.

252

253### Example

254

255```java

256package com.openai.example;

257

258import com.openai.client.OpenAIClient;

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

260import com.openai.models.finetuning.checkpoints.permissions.PermissionCreatePage;

261import com.openai.models.finetuning.checkpoints.permissions.PermissionCreateParams;

262

263public final class Main {

264 private Main() {}

265

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

267 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

268

269 PermissionCreateParams params = PermissionCreateParams.builder()

270 .fineTunedModelCheckpoint("ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd")

271 .addProjectId("string")

272 .build();

273 PermissionCreatePage page = client.fineTuning().checkpoints().permissions().create(params);

274 }

275}

276```

277

278#### Response

279

280```json

281{

282 "data": [

283 {

284 "id": "id",

285 "created_at": 0,

286 "object": "checkpoint.permission",

287 "project_id": "project_id"

288 }

289 ],

290 "has_more": true,

291 "object": "list",

292 "first_id": "first_id",

293 "last_id": "last_id"

294}

295```

296

297## Delete checkpoint permission

298

299`PermissionDeleteResponse fineTuning().checkpoints().permissions().delete(PermissionDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

300

301**delete** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}`

302

303Delete checkpoint permission

304

305### Parameters

306

307- `PermissionDeleteParams params`

308

309 - `String fineTunedModelCheckpoint`

310

311 - `Optional<String> permissionId`

312

313### Returns

314

315- `class PermissionDeleteResponse:`

316

317 - `String id`

318

319 The ID of the fine-tuned model checkpoint permission that was deleted.

320

321 - `boolean deleted`

322

323 Whether the fine-tuned model checkpoint permission was successfully deleted.

324

325 - `JsonValue; object_ "checkpoint.permission"constant`

326

327 The object type, which is always "checkpoint.permission".

328

329 - `CHECKPOINT_PERMISSION("checkpoint.permission")`

330

331### Example

332

333```java

334package com.openai.example;

335

336import com.openai.client.OpenAIClient;

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

338import com.openai.models.finetuning.checkpoints.permissions.PermissionDeleteParams;

339import com.openai.models.finetuning.checkpoints.permissions.PermissionDeleteResponse;

340

341public final class Main {

342 private Main() {}

343

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

345 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

346

347 PermissionDeleteParams params = PermissionDeleteParams.builder()

348 .fineTunedModelCheckpoint("ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd")

349 .permissionId("cp_zc4Q7MP6XxulcVzj4MZdwsAB")

350 .build();

351 PermissionDeleteResponse permission = client.fineTuning().checkpoints().permissions().delete(params);

352 }

353}

354```

355

356#### Response

357

358```json

359{

360 "id": "id",

361 "deleted": true,

362 "object": "checkpoint.permission"

363}

364```

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

Checkpoints

Permissions

List checkpoint permissions

Parameters

Returns

Example

Response

List checkpoint permissions

Parameters

Returns

Example

Response

Create checkpoint permissions

Parameters

Returns

Example

Response

Delete checkpoint permission

Parameters

Returns

Example

Response