Hey, human!
HTTP/2 200 OK content-type: text/markdown; charset=utf-8 vary: accept, user-agent x-agent: [ai_agent]
Loading the agent response…
Start an upload into a folder (body: name, size, folder_id, content_type, sha256, on_conflict); returns signed URLs, or creates an empty file directly when size is 0
Starts an upload of size bytes into folder_id (the library root by default). A small file gets one signed URL; a larger file gets mode multipart, a part_size and the first 20 signed part URLs (signUploadParts returns more). PUT the bytes to each URL, then call completeUpload. A file of size 0 is created at once (action created). When the name already exists in the folder and the app's duplicate rule would ask, the call is 409 conflict and details.choices lists your answers: send one as on_conflict (version adds a new version of the existing file, separate keeps both under a numbered name, skip uploads nothing). In other cases the same rule as the app applies: depending on the plan the existing file gets a new version or the new file gets a numbered name, and an identical file is skipped (action skip, status 200). A version upload answers with kind version and the existing file_id; the rest of the flow is the same. Needs files:write.
What you provide
- Name: The file name, at most 255 bytes
- Size: The file's size in bytes. 0 creates an empty file at once
- Folder idoptional: The folder to upload into. Omit or null for the library root
- Content typeoptional: The media type, without control characters. Default application/octet-stream
- Sha256optional: The SHA-256 of the file's bytes as 64 hexadecimal characters
- On conflictoptional: Your answer when the app's duplicate rule would ask: version, separate or skip. See startUpload
- Modified atoptional: The file's own modification time: ISO 8601 with a time zone, after 1970-01-02 and at most one day ahead
Do this with AI
I want to start an upload into a folder (body: name, size, folder_id, content_type, sha256, on_conflict); returns signed URLs, or creates an empty file directly when size is 0. Use the Tarkle API. Read the reference for this operation and follow it exactly: https://project-03b42162.restlessdocs.com/endpoint/startupload.md Authenticate with your API key as a Bearer token in the Authorization header. Then make the request for me and tell me what came back.
Paste this into Claude, Cursor, or any AI assistant and it will do it for you.
https://tarkle.com/api/v1/uploadscurl --request POST \
--url https://tarkle.com/api/v1/uploads \
--header 'Authorization: Bearer $API_KEY' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Key: X-Workspace-Key' \
--data '
{
"name": "name",
"size": 0,
"folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"content_type": "content_type",
"sha256": "sha256",
"on_conflict": "version",
"modified_at": "2024-01-01T00:00:00Z"
}
'Query parameters
workspace_keystringThe same key as the X-Workspace-Key header, for clients that cannot set headers. Send one of the two, or both with the same value (different values are 400 conflicting_workspace)
Header parameters
X-Workspace-KeystringrequiredThe 8-character key of the workspace this call acts on; GET /workspaces lists the keys a token can use. A workspace id is refused (400 workspace_key_required)
Idempotency-KeystringMakes a write safe to repeat. Send a random value (a UUID is fine) of up to 255 visible characters. A repeat of the same request gets the first answer again, with the header `Idempotent-Replayed: true`, and does nothing twice. The same key for a different request is 422 `idempotency_key_reused`; the same request while the first one is still running is 409 `idempotency_in_progress`. A 5xx or 429 is not remembered, so retrying it runs the request again. Keys last 24 hours and belong to the account that created the token.
Body
application/jsonrequirednamestringrequiredThe file name, at most 255 bytes
sizeintegerrequiredThe file's size in bytes. 0 creates an empty file at once
folder_idstring · uuid | nullThe folder to upload into. Omit or null for the library root
content_typestringThe media type, without control characters. Default application/octet-stream
sha256stringThe SHA-256 of the file's bytes as 64 hexadecimal characters
on_conflictstringYour answer when the app's duplicate rule would ask: version, separate or skip. See startUpload
modified_atstring · date-timeThe file's own modification time: ISO 8601 with a time zone, after 1970-01-02 and at most one day ahead