Create Attachments

Upload a file for an image or file column and get the reference a cell holds. The project is named by the projectId query parameter; the file goes in the file multipart field, with an optional datasetId field. create the upload, send the file to the address it answers, confirm it as a stored object, then put its reference in the cell

POST /api/v1/dataset/attachments

Python

Python

import requests

url = "https://app.langwatch.ai/api/v1/dataset/attachments"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"X-Auth-Token": "<api-key>"}

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

print(response.text)

200

{
  "url": "<string>",
  "name": "<string>",
  "mediaType": "<string>",
  "sizeBytes": 123
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Query Parameters

projectId · string · required

The project the file is stored for.

Minimum string length: 1

Body

multipart/form-data

file · file · required

datasetId · string

The dataset that owns the file. Omit it while the dataset is still a draft.

Response

200

application/json

Success

url · string · required

The value to write into the cell, and the address the file is served from.

name · string · required

The file name the reference carries.

mediaType · string · required

The media type the file is stored under.

sizeBytes · number · required

The size of the stored file, in bytes.