Skip to main content
Python
from openlayer import Openlayer

client = Openlayer()
client.commits.retrieve(project_version_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dateCreated": "2024-03-22T11:31:01.185Z",
  "status": "completed",
  "statusMessage": "Commit successfully processed.",
  "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "commit": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "authorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
    "dateCreated": "2024-03-22T11:31:01.185Z",
    "fileSize": 1024,
    "message": "Updated the prompt.",
    "mlModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "validationDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trainingDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "storageUri": "s3://...",
    "gitCommitSha": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "gitCommitRef": "main",
    "gitCommitUrl": "<string>"
  },
  "deploymentStatus": "Deployed",
  "mlModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "validationDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "trainingDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "archived": false,
  "dateArchived": "2024-03-22T11:31:01.185Z",
  "passingGoalCount": 5,
  "failingGoalCount": 1,
  "totalGoalCount": 6,
  "links": {
    "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

​
projectVersionId
string<uuid>
required

The project version (commit) id.

Response

Response OK.

​
id
string<uuid>
required

The project version (commit) id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
dateCreated
string<date-time>
required

The project version (commit) creation date.

Example:

"2024-03-22T11:31:01.185Z"

​
status
enum<string>
required

The commit status. Initially, the commit is queued, then, it switches to running. Finally, it can be paused, failed, or completed.

Available options:
queued,
running,
paused,
failed,
completed,
unknown
Example:

"completed"

​
statusMessage
string | null
required

The commit status message.

Example:

"Commit successfully processed."

​
projectId
any
required
​
commit
object
required

The details of a commit (project version).

​
mlModelId
string<uuid> | null
required

The model id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
validationDatasetId
string<uuid> | null
required

The validation dataset id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
trainingDatasetId
string<uuid> | null
required

The training dataset id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
dateArchived
string<date-time> | null
required

The commit archive date.

Example:

"2024-03-22T11:31:01.185Z"

​
passingGoalCount
integer
required

The number of tests that are passing for the commit.

Required range: x >= 0
Example:

5

​
failingGoalCount
integer
required

The number of tests that are failing for the commit.

Required range: x >= 0
Example:

1

​
totalGoalCount
integer
required

The total number of tests for the commit.

Required range: x >= 0
Example:

6

​
deploymentStatus
string

The deployment status associated with the commit's model.

Maximum length: 30
Example:

"Deployed"

​
archived
boolean | null

Whether the commit is archived.

Example:

false

​
links
object