上传文件 - Open Managed Agents

POST

/

v1

/

files

上传文件

curl --request POST \
  --url http://localhost:38080/v1/files \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Api-Key: <api-key>' \
  --header 'anthropic-beta: <anthropic-beta>' \
  --form file='@example-file'

import requests

url = "http://localhost:38080/v1/files"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {
    "anthropic-beta": "<anthropic-beta>",
    "X-Api-Key": "<api-key>"
}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

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

options.body = form;

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

package main

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

func main() {

	url := "http://localhost:38080/v1/files"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	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))

}

{
  "created_at": "2025-04-15T18:37:24.100435Z",
  "filename": "document.pdf",
  "id": "file_011CNha8iCJcU1wXNR6q4V8w",
  "mime_type": "application/pdf",
  "size_bytes": 102400,
  "type": "file",
  "downloadable": false,
  "scope": {
    "id": "<string>",
    "type": "session"
  }
}

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

每个请求都必须发送 anthropic-beta: files-api-2025-04-14。

授权

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

请求体

multipart/form-data

file

file

必填

要上传的文件

响应

成功的响应

created_at

string<date-time>

必填

表示文件创建时间的 RFC 3339 日期时间字符串。

示例:

"2025-04-15T18:37:24.100435Z"

filename

string

必填

上传文件的原始文件名。

Required string length: 1 - 500

示例:

"document.pdf"

id

string

必填

唯一的对象标识符。

ID 的格式和长度可能会随时间变化。

示例:

"file_011CNha8iCJcU1wXNR6q4V8w"

mime_type

string

必填

文件的 MIME 类型。

Required string length: 1 - 255

示例:

"application/pdf"

size_bytes

integer

必填

文件大小，以字节为单位。

必填范围: x >= 0

示例:

102400

type

string

必填

对象类型。

对于文件，此值始终为 "file"。

Allowed value: "file"

downloadable

boolean

默认值:false

该文件是否可下载。

示例:

false

scope

FileScope · object | null

此文件的作用域，表示其创建时所处的上下文（例如某个会话）。

Show child attributes

上传文件

curl --request POST \
  --url http://localhost:38080/v1/files \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Api-Key: <api-key>' \
  --header 'anthropic-beta: <anthropic-beta>' \
  --form file='@example-file'

import requests

url = "http://localhost:38080/v1/files"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {
    "anthropic-beta": "<anthropic-beta>",
    "X-Api-Key": "<api-key>"
}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

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

options.body = form;

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

package main

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

func main() {

	url := "http://localhost:38080/v1/files"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	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))

}

{
  "created_at": "2025-04-15T18:37:24.100435Z",
  "filename": "document.pdf",
  "id": "file_011CNha8iCJcU1wXNR6q4V8w",
  "mime_type": "application/pdf",
  "size_bytes": 102400,
  "type": "file",
  "downloadable": false,
  "scope": {
    "id": "<string>",
    "type": "session"
  }
}

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