Generate attachment upload URL

POST https://api.light.inc/v1/attachments/upload-url

Generates a secure upload URL for attachment files

Authorization

Send one of these on every request. See Authentication for how to get credentials.

API key
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Bearer token

Request body

application/json;charset=UTF-8

resourceId string · uuid
fileName string
contentType string

Response

uploadUrl string · url
key string
metadata object

curl -X POST "https://api.light.inc/v1/attachments/upload-url" \
  -H "Authorization: Basic YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fileName": "string",
  "contentType": "string"
}'

const res = await fetch("https://api.light.inc/v1/attachments/upload-url", {
  method: "POST",
  headers: {
    Authorization: `Basic ${process.env.LIGHT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fileName": "string",
    "contentType": "string"
  }),
});
const data = await res.json();

import os, requests

res = requests.post(
    "https://api.light.inc/v1/attachments/upload-url",
    headers={"Authorization": f"Basic {os.environ['LIGHT_API_KEY']}"},
    json={
        "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "fileName": "string",
        "contentType": "string"
    },
)
data = res.json()

Example response

{
  "uploadUrl": "https://example.com",
  "key": "string",
  "metadata": null
}

Generated from the schema — shapes and types are real, values are placeholders.