Skip to content

chore(api): document fine-tuning and model errors #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dpiet-oai merged 1 commit into from
Sep 25, 2026
Merged

chore(api): document fine-tuning and model errors #1087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .castiron.stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
schema_version: 1
generation_id: 0ba07069-c90b-485e-bfde-7c44a5dfb189
openapi_spec_hash: 3ddf96abb50be4415c98cc994bdcbacb
openapi_transformed_spec_hash: 038a0becffaf3a1cc0475c3f9b90254d
generation_id: 6efdb731-c7f9-436b-af28-c3de6f5e91d3
openapi_spec_hash: 28ec9bd417aeb3f776da6088a496b267
openapi_transformed_spec_hash: 2f7bcd56396c286698443b3c84ad7d07
config_hash: a7b2953a5cf16992f2efba8b0fcd15ea
codegen_sha: 380bd4efe1682ba88f4adbd4d1c745f0d2780ea6
codegen_sha: a9875e25fdb8f55cfa938273d32c93435d3b3801
codegen_hash: c00199a3281cfe28d53f4ec4ccc6de66a2e662597678739c8d7e908d782eba2e
public_codegen_sha: 05ae58f0cd3c870c191950e9f3cb2cb69d19dd18
public_codegen_sha: 55f5bff0f41b568a61c53b27f5451b53f59a62a5
228 changes: 228 additions & 0 deletions api_reference/openapi.transformed.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6738,6 +6738,18 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/RunGraderResponse'
'400':
description: The grader definition or request is invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
beta: true
group: graders
Expand Down Expand Up @@ -6969,6 +6981,18 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ValidateGraderResponse'
'400':
description: The grader definition or request is invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
beta: true
group: graders
Expand Down Expand Up @@ -7052,6 +7076,18 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ListFineTuningCheckpointPermissionResponse'
'400':
description: The query parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -7111,6 +7147,24 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ListFineTuningCheckpointPermissionResponse'
'400':
description: The request is invalid or checkpoint permissions cannot be changed for the requested projects or job state.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The checkpoint or its fine-tuning job was not found, or the checkpoint cannot be shared.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -7168,6 +7222,24 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/DeleteFineTuningCheckpointPermissionResponse'
'400':
description: The checkpoint permission cannot be removed for the requested project or job state.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The checkpoint, permission, associated project, or fine-tuning job was not found, or the checkpoint cannot be shared.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -7206,6 +7278,18 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/FineTuningJob'
'400':
description: The request is invalid or the organization does not meet the requirements to create a fine-tuning job.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: A request or fine-tuning job limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -7625,6 +7709,18 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ListPaginatedFineTuningJobsResponse'
'400':
description: The query parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -7700,6 +7796,18 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/FineTuningJob'
'404':
description: The fine-tuning job was not found or is not accessible.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -7783,6 +7891,24 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/FineTuningJob'
'400':
description: The fine-tuning job cannot be cancelled in its current state.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The fine-tuning job was not found or is not accessible.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -7856,6 +7982,24 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ListFineTuningJobCheckpointsResponse'
'400':
description: The query parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The fine-tuning job was not found or is not accessible.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -7933,6 +8077,24 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ListFineTuningJobEventsResponse'
'400':
description: The query parameters are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The fine-tuning job was not found or is not accessible.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -8011,6 +8173,24 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/FineTuningJob'
'400':
description: The fine-tuning job cannot be paused in its current state or does not support pausing.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The fine-tuning job was not found or is not accessible, or this operation is unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: The request rate limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -8071,6 +8251,24 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/FineTuningJob'
'400':
description: The fine-tuning job cannot be resumed in its current state or does not support resuming.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The fine-tuning job was not found or is not accessible, or this operation is unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: A request or fine-tuning job limit has been exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: fine-tuning
examples:
Expand Down Expand Up @@ -8688,6 +8886,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ListModelsResponse'
'403':
description: The API credential does not have permission to list models.
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionErrorResponse'
x-oaiMeta:
group: models
examples:
Expand Down Expand Up @@ -8775,6 +8979,18 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Model'
'403':
description: The API credential does not have permission to retrieve models.
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionErrorResponse'
'404':
description: The model was not found or is not accessible.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: models
examples:
Expand Down Expand Up @@ -8840,6 +9056,18 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/DeleteModelResponse'
'403':
description: Insufficient permissions to delete the model. Model deletion requires the Owner role in the organization and a credential that permits deletion.
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionErrorResponse'
'404':
description: The model was not found, is not accessible, or cannot be deleted through this endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-oaiMeta:
group: models
examples:
Expand Down
Loading