Delete a Message Batch - Open Managed Agents

DELETE

/

v1

/

messages

/

batches

/

{message_batch_id}

Delete a Message Batch

curl --request DELETE \
  --url http://localhost:38080/v1/messages/batches/{message_batch_id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'anthropic-beta: <anthropic-beta>'

import requests

url = "http://localhost:38080/v1/messages/batches/{message_batch_id}"

headers = {
    "anthropic-beta": "<anthropic-beta>",
    "X-Api-Key": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'anthropic-beta': '<anthropic-beta>', 'X-Api-Key': '<api-key>'}
};

fetch('http://localhost:38080/v1/messages/batches/{message_batch_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:38080/v1/messages/batches/{message_batch_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("anthropic-beta", "<anthropic-beta>")
	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

Use ?beta=true with anthropic-beta: message-batches-2024-09-24 for the beta request and response shapes shown here.

Authorizations

X-Api-Key

string

header

default:sk-ant-local-default

required

OMA workspace API key.

Headers

anthropic-beta

string

required

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

anthropic-version

string

The version of the OMA API you want to use.

Read more about versioning and our version history here.

Path Parameters

message_batch_id

string

required

ID of the Message Batch.

Query Parameters

beta

enum<boolean>

required

Selects the beta API contract for this endpoint. Must be true.

Available options:

true

Response

Successful Response

id

string

required

ID of the Message Batch.

Example:

"msgbatch_013Zva2CMHLNnXjNJJKqJ2EF"

type

string

default:message_batch_deleted

required

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

Allowed value: "message_batch_deleted"

Delete a Message Batch

curl --request DELETE \
  --url http://localhost:38080/v1/messages/batches/{message_batch_id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'anthropic-beta: <anthropic-beta>'

import requests

url = "http://localhost:38080/v1/messages/batches/{message_batch_id}"

headers = {
    "anthropic-beta": "<anthropic-beta>",
    "X-Api-Key": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'anthropic-beta': '<anthropic-beta>', 'X-Api-Key': '<api-key>'}
};

fetch('http://localhost:38080/v1/messages/batches/{message_batch_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:38080/v1/messages/batches/{message_batch_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("anthropic-beta", "<anthropic-beta>")
	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}