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 uploading a brand file
Step 1 of 2. Send the slot the file is for: icon, main_logo, banner, social_image, favicon (each replaces the current one), logo (an extra logo), asset (a collection file), team_photo (one team member's photo, replaces the current one) or guideline_image (adds a picture to a guideline section). Optionally send size and filename to be refused early. The answer holds a signed upload address: PUT the file bytes to upload.url (it expires after expires_in seconds), then call completeBrandFileUpload with file_id. Nothing is attached yet. The limits are the brand editor's: logos and icons PNG, JPG, WebP or SVG up to 10 MB; banners and social images PNG, JPG or WebP up to 10 MB; favicons also ICO, up to 2 MB; collection files of any type up to 100 MB. A brand can have 20 extra logos; asset needs a brand without older-editor images (409 otherwise). Needs brands:files.
What you provide
- Slot
- Sizeoptional: The file's size in bytes; refused early when over the slot's limit
- Filenameoptional: The file's name; refused early when its extension is not allowed for the slot
Do this with AI
I want to start uploading a brand file. Use the Tarkle API. Read the reference for this operation and follow it exactly: https://project-03b42162.restlessdocs.com/endpoint/startbrandfileupload.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/brands/{brand}/filescurl --request POST \
--url https://tarkle.com/api/v1/brands/brand/files \
--header 'Authorization: Bearer $API_KEY' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Key: X-Workspace-Key' \
--data '
{
"slot": "icon",
"size": 1,
"filename": "filename"
}
'Path parameters
brandstringrequiredBrand id (uuid) or slug
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/jsonrequiredslotstringrequiredsizeintegerThe file's size in bytes; refused early when over the slot's limit
filenamestringThe file's name; refused early when its extension is not allowed for the slot