Skip to content
Primary navigation

List checkpoint permissions

client.fineTuning.checkpoints.permissions.list(stringfineTunedModelCheckpoint, PermissionListParams { after, limit, order, project_id } query?, RequestOptionsoptions?): ConversationCursorPage<PermissionListResponse { id, created_at, object, project_id } >
GET/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

NOTE: This endpoint requires an admin API key.

Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.

ParametersExpand Collapse
fineTunedModelCheckpoint: string
query: PermissionListParams { after, limit, order, project_id }
after?: string

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

limit?: number

Number of permissions to retrieve.

order?: "ascending" | "descending"

The order in which to retrieve permissions.

One of the following:
"ascending"
"descending"
project_id?: string

The ID of the project to get permissions for.

ReturnsExpand Collapse
PermissionListResponse { id, created_at, object, project_id }

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

id: string

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

created_at: number

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

object: "checkpoint.permission"

The object type, which is always “checkpoint.permission”.

project_id: string

The project identifier that the permission is for.

List checkpoint permissions

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const permissionListResponse of client.fineTuning.checkpoints.permissions.list(
  'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
)) {
  console.log(permissionListResponse.id);
}
{
  "object": "list",
  "data": [
    {
      "object": "checkpoint.permission",
      "id": "cp_zc4Q7MP6XxulcVzj4MZdwsAB",
      "created_at": 1721764867,
      "project_id": "proj_abGMw1llN8IrBb6SvvY5A1iH"
    },
    {
      "object": "checkpoint.permission",
      "id": "cp_enQCFmOTGj3syEpYVhBRLTSy",
      "created_at": 1721764800,
      "project_id": "proj_iqGMw1llN8IrBb6SvvY5A1oF"
    },
  ],
  "first_id": "cp_zc4Q7MP6XxulcVzj4MZdwsAB",
  "last_id": "cp_enQCFmOTGj3syEpYVhBRLTSy",
  "has_more": false
}
Returns Examples
{
  "object": "list",
  "data": [
    {
      "object": "checkpoint.permission",
      "id": "cp_zc4Q7MP6XxulcVzj4MZdwsAB",
      "created_at": 1721764867,
      "project_id": "proj_abGMw1llN8IrBb6SvvY5A1iH"
    },
    {
      "object": "checkpoint.permission",
      "id": "cp_enQCFmOTGj3syEpYVhBRLTSy",
      "created_at": 1721764800,
      "project_id": "proj_iqGMw1llN8IrBb6SvvY5A1oF"
    },
  ],
  "first_id": "cp_zc4Q7MP6XxulcVzj4MZdwsAB",
  "last_id": "cp_enQCFmOTGj3syEpYVhBRLTSy",
  "has_more": false
}