Upload File - Open Managed Agents

POST

/

v1

/

files

Upload File

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"
}

Every request requires anthropic-beta: files-api-2025-04-14.

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.

Query Parameters

beta

enum<boolean>

required

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

Available options:

true

Body

multipart/form-data

file

file

required

The file to upload

Response

Successful Response

created_at

string<date-time>

required

RFC 3339 datetime string representing when the file was created.

Example:

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

filename

string

required

Original filename of the uploaded file.

Required string length: 1 - 500

Example:

"document.pdf"

id

string

required

Unique object identifier.

The format and length of IDs may change over time.

Example:

"file_011CNha8iCJcU1wXNR6q4V8w"

mime_type

string

required

MIME type of the file.

Required string length: 1 - 255

Example:

"application/pdf"

size_bytes

integer

required

Size of the file in bytes.

Required range: x >= 0

Example:

102400

type

string

required

Object type.

For files, this is always "file".

Allowed value: "file"

downloadable

boolean

default:false

Whether the file can be downloaded.

Example:

false

scope

FileScope · object | null

The scope of this file, indicating the context in which it was created (e.g., a session).

Show child attributes

Upload File

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"
}