Skip to main content
POST
/
api
/
agent
/
shorts
/
avatar
Generate shorts avatar
curl --request POST \
  --url https://www.citedy.com/api/agent/shorts/avatar \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gender": "male",
  "origin": "european",
  "age_range": "26-35",
  "type": "tech_founder",
  "location": "coffee_shop"
}
'
{
  "avatar_url": "<string>",
  "r2_key": "<string>",
  "credits_charged": 1,
  "prompt_used": "<string>",
  "prompt_meta": {
    "age_years": 34,
    "variation_tags": [
      "<string>"
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.citedy.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
​
gender
enum<string>
required
Available options:
male,
female
​
origin
enum<string>
required
Available options:
european,
asian,
african,
latin,
middle_eastern,
south_asian
​
age_range
enum<string>
default:26-35
Available options:
18-25,
26-35,
36-50
​
type
enum<string>
default:tech_founder
Available options:
tech_founder,
vibe_coder,
student,
executive
​
location
enum<string>
default:coffee_shop
Available options:
coffee_shop,
dev_cave,
street,
car,
home_office,
podcast_studio,
glass_office,
rooftop,
bedroom,
park,
gym

Response

Avatar generated

​
avatar_url
string<uri>
required
​
r2_key
string
required
​
credits_charged
integer
required
Required range: x >= 0
​
prompt_used
string
required

Full image prompt used for this generation (same input params can yield different prompts for diversity).

​
prompt_meta
object
required