Skip to main content
POST
/
v1
/
files
/
upload
Upload file
curl --request POST \
  --url https://api.shingleai.com/v1/files/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'folderId=<string>' \
  --form 'description=<string>' \
  --form 'tags=<string>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "uploadedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "filename": "<string>",
    "contentType": "<string>",
    "size": 123,
    "r2Key": "<string>",
    "description": "<string>",
    "tags": [
      "<string>"
    ],
    "agentAccessEnabled": true,
    "mcpAccessEnabled": true,
    "metadata": {},
    "folderName": "<string>"
  },
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Body

multipart/form-data
file
file

The file to upload

folderId
string

Optional folder ID to place the file in

description
string

Optional file description

tags
string

Optional JSON array of tags

Response

File uploaded successfully

data
object
required
meta
object