Skip to content

Commit 560d34a

Browse files
authored
reordered batch Inference endpoints (#1169)
* reordered batch endpts * added sub-section
1 parent 1e51da8 commit 560d34a

4 files changed

Lines changed: 20 additions & 13 deletions

File tree

specification/DigitalOcean-public.v2.yaml

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -646,6 +646,12 @@ tags:
646646
synchronous APIs, making it a cost-effective choice for non-interactive
647647
workloads.
648648
649+
- name: Additional Batch Inference Helper APIs
650+
description: |-
651+
Helper operations for managing Batch Inference jobs — list all
652+
submitted jobs and cancel a job that has not yet reached a terminal
653+
state.
654+
649655
650656
x-tagGroups:
651657
- name: Public APIs
@@ -706,6 +712,7 @@ x-tagGroups:
706712
- Inference Introduction
707713
- Agent Inference
708714
- Batch Inference
715+
- Additional Batch Inference Helper APIs
709716
- Embeddings
710717
- Serverless Inference
711718

@@ -2996,23 +3003,23 @@ paths:
29963003
$ref: 'resources/inference/inference_upload_batch_file.yml'
29973004

29983005
/v1/batches:
2999-
get:
3000-
$ref: 'resources/inference/inference_list_batches.yml'
30013006
post:
30023007
$ref: 'resources/inference/inference_create_batch.yml'
3008+
get:
3009+
$ref: 'resources/inference/inference_list_batches.yml'
30033010

30043011
/v1/batches/{batch_id}:
30053012
get:
30063013
$ref: 'resources/inference/inference_get_batch.yml'
30073014

3008-
/v1/batches/{batch_id}/cancel:
3009-
post:
3010-
$ref: 'resources/inference/inference_cancel_batch.yml'
3011-
30123015
/v1/batches/{batch_id}/results:
30133016
get:
30143017
$ref: 'resources/inference/inference_get_batch_results.yml'
30153018

3019+
/v1/batches/{batch_id}/cancel:
3020+
post:
3021+
$ref: 'resources/inference/inference_cancel_batch.yml'
3022+
30163023
components:
30173024
securitySchemes:
30183025
bearer_auth:

specification/resources/inference/inference_cancel_batch.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: >
1313
Partial results produced before cancellation remain available via
1414
`GET /v1/batches/{batch_id}/results`.
1515
tags:
16-
- Batch Inference
16+
- Additional Batch Inference Helper APIs
1717
servers:
1818
- url: "https://inference.do-ai.run"
1919
description: production

specification/resources/inference/inference_list_batches.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: >
55
`limit` to control page size and `after` to page forward using the
66
`last_id` from the previous response.
77
tags:
8-
- Batch Inference
8+
- Additional Batch Inference Helper APIs
99
servers:
1010
- url: "https://inference.do-ai.run"
1111
description: production

specification/resources/inference/models/batch.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,17 +110,17 @@ properties:
110110
type: string
111111
format: date-time
112112
nullable: true
113-
example: null
113+
example: "2026-04-24T19:20:05Z"
114114
finalizing_at:
115115
type: string
116116
format: date-time
117117
nullable: true
118-
example: null
118+
example: "2026-04-24T20:10:42Z"
119119
completed_at:
120120
type: string
121121
format: date-time
122122
nullable: true
123-
example: null
123+
example: "2026-04-24T20:15:30Z"
124124
expires_at:
125125
type: string
126126
format: date-time
@@ -131,9 +131,9 @@ properties:
131131
type: string
132132
format: date-time
133133
nullable: true
134-
example: null
134+
example: "2026-04-24T19:45:11Z"
135135
failed_at:
136136
type: string
137137
format: date-time
138138
nullable: true
139-
example: null
139+
example: "2026-04-24T19:50:00Z"

0 commit comments

Comments
 (0)