> ## 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. # Generate shorts avatar ## OpenAPI ````yaml post /api/agent/shorts/avatar openapi: 3.1.0 info: title: Citedy Agent API version: 1.0.0 description: >- Public contract for Citedy agent integrations. This contract reflects the current /api/agent surface without changing runtime behavior. contact: name: Citedy Support url: https://www.citedy.com license: name: Proprietary url: https://www.citedy.com servers: - url: https://www.citedy.com security: [] tags: - name: Health description: Platform and dependency health - name: Registration description: Agent onboarding and approval - name: Agent description: Agent identity and key lifecycle - name: Scout description: Trend scouting endpoints - name: Gaps description: Content gap analysis - name: Autopilot description: Article generation and retrieval - name: Articles description: Queued article generation job polling - name: Adaptations description: Social adaptation generation - name: Sessions description: Autopilot recurring sessions - name: Lead Magnets description: Lead magnet generation and state - name: Warm Leads description: Warm-lead report generation and export - name: Ingest description: Content ingestion jobs - name: Competitors description: Competitor discovery and analysis - name: Personas description: Writing persona catalog - name: Webhooks description: Webhook endpoint registration and delivery logs - name: Publishing description: Social publishing, scheduling and cancellation - name: Schedule description: Content schedule timeline and gap analysis - name: Settings description: Agent preferences and configuration - name: Scan description: Experimental trend scanning (xAI Grok) - name: Status description: Operational readiness and actionable onboarding status - name: Products description: Product knowledge base document management - name: Shorts description: Short-form video generation and polling - name: SEO Tools description: Agent-authenticated SEO diagnostics tools exposed via MCP seo.* namespace. - name: GSC description: Google Search Console integration and reporting paths: /api/agent/shorts/avatar: post: tags: - Shorts summary: Generate shorts avatar operationId: generateShortsAvatar requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ShortsAvatarRequest' responses: '200': description: Avatar generated content: application/json: schema: $ref: '#/components/schemas/ShortsAvatarResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' security: - AgentApiKey: [] components: schemas: ShortsAvatarRequest: type: object required: - gender - origin properties: gender: type: string enum: - male - female origin: type: string enum: - european - asian - african - latin - middle_eastern - south_asian age_range: type: string enum: - 18-25 - 26-35 - 36-50 default: 26-35 type: type: string enum: - tech_founder - vibe_coder - student - executive default: tech_founder location: type: string enum: - coffee_shop - dev_cave - street - car - home_office - podcast_studio - glass_office - rooftop - bedroom - park - gym default: coffee_shop additionalProperties: false ShortsAvatarResponse: type: object required: - avatar_url - r2_key - credits_charged - prompt_used - prompt_meta properties: avatar_url: type: string format: uri r2_key: type: string credits_charged: type: integer minimum: 0 prompt_used: type: string description: >- Full image prompt used for this generation (same input params can yield different prompts for diversity). prompt_meta: $ref: '#/components/schemas/ShortsAvatarPromptMeta' ShortsAvatarPromptMeta: type: object required: - age_years - variation_tags properties: age_years: type: integer minimum: 18 maximum: 50 variation_tags: type: array items: type: string description: >- Server-sampled appearance and location tags for debugging and diversity checks. ErrorResponse: type: object properties: error: type: string message: type: string required: - error additionalProperties: true PaymentRequiredResponse: allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object properties: credits_required: type: number breakdown: type: object additionalProperties: type: number topup: type: object description: Recommended credit top-up package with billing URL properties: recommended_package_credits: type: integer description: Credits in the recommended package recommended_package_price_usd: type: number description: Price of the recommended package in USD topup_url: type: string format: uri description: URL to billing page with package pre-selected required: - recommended_package_credits - recommended_package_price_usd - topup_url required: - credits_required - topup additionalProperties: true RateLimitErrorResponse: allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object properties: retry_after: type: integer required: - retry_after responses: BadRequest: description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' PaymentRequired: description: Insufficient credits content: application/json: schema: $ref: '#/components/schemas/PaymentRequiredResponse' TooManyRequests: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' InternalError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: AgentApiKey: type: http scheme: bearer description: Bearer citedy_agent_* key ````