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…
Create a shareable transfer link
Creates a shareable link from one or more files or folders already in the library (upload with POST /uploads first). Plain file transfers only: no video, audio or canvas transfers, no payment, no recipient emails -- those stay app-only. access is public or password (password also needs password). The workspace's own transfer-size and monthly-transfer-count plan limits apply exactly as in the app: 413 transfer_too_large or 429 transfer_monthly_limit. Needs transfers:create.
What you provide
- Typeoptional: standard: a plain file/folder link (the rest of this schema). video/audio: a single already-uploaded file of that type, wrapped in a media player. canvas: one or more PDF/image files as a feedback board -- see TransferCreateRich for those three
- Items: At least one existing file or folder from the library (type: standard only)
- Access: public: anyone with the link; password: also needs the password
- Passwordoptional: Required when access is "password"
- Titleoptional
- Descriptionoptional
- Expires atoptional: When the link stops working. Must be in the future. Omit or null for a link that never expires
- Burn after readoptional: The link stops working after its first download
- View onlyoptional
- Download modeoptional
- Feedback deadline atoptional: type: canvas only. When board comments close. Must be in the future. Omit or null to never close
Do this with AI
I want to create a shareable transfer link. Use the Tarkle API. Read the reference for this operation and follow it exactly: https://project-03b42162.restlessdocs.com/endpoint/createtransfer.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/transferscurl --request POST \
--url https://tarkle.com/api/v1/transfers \
--header 'Authorization: Bearer $API_KEY' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Key: X-Workspace-Key' \
--data '
{
"type": "standard",
"items": [
{
"id": "id",
"type": "file"
}
],
"access": "public",
"password": "password",
"title": "title",
"description": "description",
"expires_at": "2024-01-01T00:00:00Z",
"burn_after_read": true,
"view_only": true,
"download_mode": "standard",
"feedback_deadline_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/jsonrequiredtypestringstandard: a plain file/folder link (the rest of this schema). video/audio: a single already-uploaded file of that type, wrapped in a media player. canvas: one or more PDF/image files as a feedback board -- see TransferCreateRich for those three
At least one existing file or folder from the library (type: standard only)
idstringrequiredA file id (digits) or a folder id (uuid), already in the library (upload it first with POST /uploads)
typestringrequiredaccessstringrequiredpublic: anyone with the link; password: also needs the password
passwordstringRequired when access is "password"
titlestring | nulldescriptionstring | nullexpires_atstring · date-time | nullWhen the link stops working. Must be in the future. Omit or null for a link that never expires
burn_after_readbooleanThe link stops working after its first download
view_onlybooleandownload_modestringfeedback_deadline_atstring · date-time | nulltype: canvas only. When board comments close. Must be in the future. Omit or null to never close