API reference / Tasks and projects
Make pictures for a task
Makes 1 to 4 pictures from words, with the image provider that the workspace connected in Settings > Apps, and attaches them to the task. The provider bills each picture to the workspace's own key. The plan of the workspace sets the pictures of a day: 20, or 60 on Ultra. The words of each picture go to the provider. Without a connected provider, the call fails with not_connected.
/api/v1/tasks/{key}/picturesOther ways to call it
troopy tasks picturestroopy_make_task_picturesIdempotency-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/jsonpictures*array<object>At most 4 items
2 properties
prompt*stringWhat the picture shows, in plain words. Ask for no words in the picture
At least 10 characters · At most 600 characters
shapeenum<string>cover and wide are 16:9. square is 1:1
coverwidesquare
Default "wide"
stylestringHow the pictures look, added to the words of each one. Without it, Troopy adds the picture style of the brand (Brain > Brand)
At least 1 characters · At most 600 characters
Response
201 · application/jsondata*object3 properties
provider*enum<string>The provider that made them
geminiopenaifalreplicate
pictures*array<object>The pictures, as files 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
failed*array<string>Why a picture was not made, one line for each