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

projectId
string
required

The project id.

Body

application/json
commit
object
required

The details of a commit (project version).

projectId
any
required
storageUri
string
required

The storage URI where the commit bundle is stored.

archived
boolean | null

Whether the commit is archived.

deploymentStatus
string

The deployment status associated with the commit's model.

Maximum length: 30

Response

201 - application/json
commit
object
required

The details of a commit (project version).

dateArchived
string | null
required

The commit archive date.

dateCreated
string
required

The project version (commit) creation date.

failingGoalCount
integer
required

The number of tests that are failing for the commit.

Required range: x > 0
id
string
required

The project version (commit) id.

mlModelId
string | null
required

The model id.

passingGoalCount
integer
required

The number of tests that are passing for the commit.

Required range: x > 0
projectId
any
required
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
statusMessage
string | null
required

The commit status message.

totalGoalCount
integer
required

The total number of tests for the commit.

Required range: x > 0
trainingDatasetId
string | null
required

The training dataset id.

validationDatasetId
string | null
required

The validation dataset id.

archived
boolean | null

Whether the commit is archived.

deploymentStatus
string

The deployment status associated with the commit's model.

Maximum length: 30