Get Batch
Get batch by batch_id.
Args: AuthenticatedComputeAny: The authentication dependency, ensuring the user is authenticated and has the necessary permissions user (GetUserInfoWithProjects): A dependency that will fetch the user information. batch_id(UUID): requested batch id
Returns: The requested Batch.
Raises: BatchNotFound(Http status code 404) if batch_id not found or the user is not member of the batch’s project.
Parameters
Path Parameters
Responses
200
Successful Response
Represents a response with either a list of items or a single item in a single page.
Generic Parameters:
- A
(TypeVar): The type bound to this class, which can be a single BaseModel,
a list of BaseModels, or None.
Usage:
- To respond with an unpaginated list of FooResponse
items
from an API endpoint, ensure that your function
returns NonPaginatedResponse[List[FooResponse]]
.
- To respond with a single `FooResponse` item from an API endpoint,
make sure that your function returns `NonPaginatedResponse[FooResponse]`
and that Python recognizes it.
object
Response for a batch request that includes only its job ids.
This schema defines all the fields that can be publicly shared by the API.
object
An enumeration.
object
object
Values represent the queue a value will be written to, each priority represents the order of preference batches will be executed. Queue priority is processed in a descending order: CRITICAL, HIGH, MEDIUM, LOW, FREE
422
Validation Error