Retrieves information about a specific batch job.
GET
/v1/batch/{batch_id}
Request Body
Les paramètres suivants peuvent être inclus dans le corps de la requête :
Paramètres
batch_id
string
Required
The ID of the batch job to retrieve.
Successful Response
Les champs suivants sont retournés dans une réponse réussie :
Champs de réponse
id
string
Required
A unique identifier for the batch job.
object
string
Required
The object type, which is always "batch".
status
string
Required
The status of the batch job.
created_at
integer
Required
The Unix timestamp when the batch was created.
completed_at
integer
null
The Unix timestamp when the batch was completed.
request_counts
RequestCounts
Required
Statistics about the batch requests.
Examples
Exemples de code pour utiliser cet endpoint :
typescript
import { AlphaEdge } from '@alphaedge/alphaedge';
const alphaedge = new AlphaEdge({
apiKey: process.env.ALPHAEDGE_API_KEY,
});
const batch = await alphaedge.batch.retrieve('batch-abc123');
python
from alphaedge import AlphaEdge
alphaedge = AlphaEdge(api_key="your-api-key")
batch = alphaedge.batch.retrieve('batch-abc123')
curl
curl https://api.alphaedge-ai.com/v1/batch/batch-abc123 \
-H "Authorization: Bearer $ALPHAEDGE_API_KEY"Response
Exemple de réponse de l'API :
json
{
"id": "batch-abc123",
"object": "batch",
"status": "completed",
"created_at": 1234567890,
"completed_at": 1234567900,
"request_counts": {
"total": 100,
"completed": 100,
"failed": 0
}
}