API reference / Tasks and projects
Put a picture of the brand on a task
Copies a picture of the brand onto a task, as asset-N, or as screen-N for a screenshot. A teammate then puts it in a doc, or on the cover of an article. A screenshot shows words, so it never goes on a cover. A task holds 20 files.
post
/api/v1/tasks/{key}/assetsOther ways to call it
CLI
troopy tasks assetMCP tool
troopy_use_brand_assetRate limit60 calls in 60 seconds, for each key
RetriesSend an
Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Path parameters
key*stringA task's key (VIR-12), its number (12) or its id
At least 1 characters · At most 40 characters
Body
application/jsonasset*stringThe id of the picture, from the pictures of the brand
Response
201 · application/jsondata*object2 properties
file*objectThe copy, as a file of the task
7 properties
id*stringA 24-character id
name*stringcontentType*stringAs Troopy serves it; a type a browser could run is served as plain bytes
size*integerIn bytes
by*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
url*stringDownloads it: send your API key, or be signed in
title*stringWhat the picture shows
Errors
400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.