Moonborn — API · portraits

List portraits for a persona (canonical + variants + edits)

Returns generated/approved portraits with signed URLs (1h). Failed/rejected/pending rows are not surfaced.

GET/v1/personas/{id}/portraitsscope · Bearer (API key or session JWT)

Path parameters

Field	Type	Description
idreq	string	Persona id (uuid).

Responses

200OK

Body

Field	Type	Description
canonicalIdreq	string
activeIdreq	string
itemsreq	object[]
featureConfiguredreq	boolean

404Persona not found

Body

Field	Type	Description
errorreq	string
message	string
used	number
limit	number
pii	string[]
term	string
scores	object
provider	string

Examples

cURL

curl -X GET https://api.moonborn.co/v1/personas/<id>/portraits \
  -H "Authorization: Bearer $MOONBORN_API_KEY"

TypeScript

import Moonborn from '@moonborn/sdk';

const client = new Moonborn({ apiKey: process.env.MOONBORN_API_KEY });

const result = await client.portraits.listPersonaPortraits({
  id: '<id>',
});

Python

import os
from moonborn import Moonborn

client = Moonborn(api_key=os.environ["MOONBORN_API_KEY"])

result = client.portraits.list_persona_portraits(
    id="<id>",
)