Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Brain

Add a picture to the brand

Adds a picture of the business, for teammates to put in its articles and posts: a PNG, JPEG or WebP image of at most 8 MB, base64-encoded. A workspace keeps 200 pictures. From the CLI, pass --content @./logo.png to read a file.

post/api/v1/brand/assets

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy brand asset-add
MCP toolNone. Call it over REST or with the CLI.
Rate limit30 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.

Body

application/json
title*string

What the picture shows, like: The dashboard on a laptop

At least 1 characters · At most 120 characters

kind*enum<string>

logo, screenshot, photo or graphic

logoscreenshotphotographic

content*string

The picture, base64-encoded

At most 11200000 characters · base64

Response

201 · application/json
data*object
11 properties
id*string

A 24-character id

title*string

What the picture shows, in a few words

kind*enum<string>

logoscreenshotphotographic

url*string

The picture: be signed in, or send a key with brain:read

contentType*string
size*integer

In bytes

width*integer
height*integer
from*enum<string>

person: a person added it. site: Troopy took it of the website

personsite

by*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
at*string

ISO 8601 date and time

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.
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.