列出消息批处理 - Open Managed Agents

GET

/

v1

/

messages

/

batches

列出消息批处理

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

import requests

url = "http://localhost:38080/v1/messages/batches"

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

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

print(response.text)

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

fetch('http://localhost:38080/v1/messages/batches', 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"

	req, _ := http.NewRequest("GET", 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))

}

{
  "data": [
    {
      "archived_at": "2024-08-20T18:37:24.100435Z",
      "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
      "created_at": "2024-08-20T18:37:24.100435Z",
      "ended_at": "2024-08-20T18:37:24.100435Z",
      "expires_at": "2024-08-20T18:37:24.100435Z",
      "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
      "processing_status": "in_progress",
      "request_counts": {
        "canceled": 10,
        "errored": 30,
        "expired": 10,
        "processing": 100,
        "succeeded": 50
      },
      "results_url": "https://oma.example.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
      "type": "message_batch"
    }
  ],
  "first_id": "<string>",
  "has_more": true,
  "last_id": "<string>"
}

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

要使用此处展示的 Beta 请求和响应结构，请同时发送 ?beta=true 与 anthropic-beta: message-batches-2024-09-24。

授权

X-Api-Key

string

header

默认值:sk-ant-local-default

必填

OMA 工作区 API 密钥。

请求头

anthropic-beta

string

必填

用于指定要使用的 beta 版本的可选请求头。

要使用多个 beta，请使用逗号分隔的列表（如 beta1,beta2），或为每个 beta 分别指定该请求头。

anthropic-version

string

你想使用的 OMA API 版本。

在此处阅读更多关于版本控制和我们版本历史的信息。

查询参数

beta

enum<boolean>

必填

为此接口启用 Beta API 合同，必须为 true。

可用选项:

true

before_id

string

用作分页游标的对象 ID。提供时，返回紧邻该对象之前的结果页。

after_id

string

用作分页游标的对象 ID。提供时，返回紧随该对象之后的结果页。

limit

integer

默认值:20

每页返回的条目数量。

默认为 20。取值范围为 1 到 1000。

必填范围: 1 <= x <= 1000

响应

成功的响应

data

MessageBatch · object[]

必填

Show child attributes

first_id

string | null

必填

data 列表中的第一个 ID。可用作上一页的 before_id。

has_more

boolean

必填

表示在请求的分页方向上是否还有更多结果。

last_id

string | null

必填

data 列表中的最后一个 ID。可用作下一页的 after_id。

列出消息批处理

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

import requests

url = "http://localhost:38080/v1/messages/batches"

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

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

print(response.text)

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

fetch('http://localhost:38080/v1/messages/batches', 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"

	req, _ := http.NewRequest("GET", 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))

}

{
  "data": [
    {
      "archived_at": "2024-08-20T18:37:24.100435Z",
      "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
      "created_at": "2024-08-20T18:37:24.100435Z",
      "ended_at": "2024-08-20T18:37:24.100435Z",
      "expires_at": "2024-08-20T18:37:24.100435Z",
      "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
      "processing_status": "in_progress",
      "request_counts": {
        "canceled": 10,
        "errored": 30,
        "expired": 10,
        "processing": 100,
        "succeeded": 50
      },
      "results_url": "https://oma.example.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
      "type": "message_batch"
    }
  ],
  "first_id": "<string>",
  "has_more": true,
  "last_id": "<string>"
}

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