Cancels an in-progress batch job. Only batches with status "in_progress" can be cancelled.
POST
/v1/batch/{batch_id}/cancel
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 cancel.
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, which is "cancelled".
cancelled_at
integer
Required
The Unix timestamp when the batch was cancelled.
Examples
Exemples de code pour utiliser cet endpoint :
typescript
import { AlphaEdge } from '@alphaedge/alphaedge';
const alphaedge = new AlphaEdge({
apiKey: process.env.ALPHAEDGE_API_KEY,
});
await alphaedge.batch.cancel('batch-abc123');
python
from alphaedge import AlphaEdge
alphaedge = AlphaEdge(api_key="your-api-key")
alphaedge.batch.cancel('batch-abc123')
curl
curl -X POST https://api.alphaedge-ai.com/v1/batch/batch-abc123/cancel \
-H "Authorization: Bearer $ALPHAEDGE_API_KEY"Response
Exemple de réponse de l'API :
json
{
"id": "batch-abc123",
"object": "batch",
"status": "cancelled",
"cancelled_at": 1234567890
}