Authorization

bearerAuth

AuthorizationBearer <token>

A personal API key (psk_…) or an OAuth access token (plan_at_…). Scopes: read, write.

In: header

Path Parameters

projectSlug*string

Project slug, e.g. recipe-box.

planShortId*string

Plan handle within the project, e.g. PLAN-12.

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file?file

The document to upload. Accepts pdf, docx, doc, xlsx, pptx, csv, md, txt, html, svg, yaml, json, xml, xsd, xsl, png, jpg, gif, webp, mp4, mov, webm. Up to 4 MB in THIS request body; past that, mint an upload URL and send storage_ref instead.

Formatbinary

storage_ref?string

The reference returned by POST …/context/upload-url, after the bytes have been PUT to its signed URL. Send this INSTEAD of file for anything over 4 MB. Requires filename.

filename?string

The original file name. Required with storage_ref; ignored with file.

title?string

Defaults to the file name.

kind?string

description?string

folderPath?string

onConflict?string

Defaults to keep_both. on_conflict is accepted as an alias.

Value in

"keep_both"
"replace"
"skip"

expectedSourceId?string

Formatuuid

replaceSourceId?string

Replace THIS uploaded document with the file, whatever the file is called: its id, scope and folder are kept, its file and text are new. It must be at the scope of this route (404 otherwise, including an id from another workspace). With onConflict=replace and no id, the document with the same title in the folder is replaced; a 409 lists the ids when two share it.

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/projects/string/plans/string/context/upload"

{  "source": {    "id": "string",    "scope": "TEAM",    "kind": "string",    "sourceKind": "PASTED",    "title": "string",    "description": "string",    "tokenCount": 0,    "folderPath": "string",    "hasFile": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "degraded": true,    "skipped": true,    "replaced": true,    "keptBothAs": "string",    "pictureCount": 0,    "sizeBytes": 0,    "enrichment": {      "status": "pending",      "reason": "string"    }  }}

View as Markdown Open in Claude Open in ChatGPT

Upload a file as a Context source (on_conflict: keep_both | replace | skip)

Authorization

Path Parameters

Request Body

Response Body

201application/json

401application/json

404application/json

409application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`