Skip to content
Primary navigation

List checkpoint permissions

Deprecated
fine_tuning.checkpoints.permissions.retrieve(strfine_tuned_model_checkpoint, PermissionRetrieveParams**kwargs) -> PermissionRetrieveResponse
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
fine_tuned_model_checkpoint: str
after: Optional[str]

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

limit: Optional[int]

Number of permissions to retrieve.

order: Optional[Literal["ascending", "descending"]]

The order in which to retrieve permissions.

Accepts one of the following:
"ascending"
"descending"
project_id: Optional[str]

The ID of the project to get permissions for.

ReturnsExpand Collapse
class PermissionRetrieveResponse: …
data: List[Data]
id: str

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

created_at: int

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

object: Literal["checkpoint.permission"]

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

project_id: str

The project identifier that the permission is for.

has_more: bool
object: Literal["list"]
first_id: Optional[str]
last_id: Optional[str]

List checkpoint permissions

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
permission = client.fine_tuning.checkpoints.permissions.retrieve(
    fine_tuned_model_checkpoint="ft-AF1WoRqd3aJAHsqc9NY7iL8F",
)
print(permission.first_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
}