Skip to main content

Overview

The Generations API creates AI-powered content using pre-built templates with optional brand voice styling. Generate blog posts, social media content, email campaigns, product descriptions, and more. Each template has specific input_data fields—list generation apps to discover available templates and their parameters.

Typical Flow

1

List generation apps

Call GET /generation-apps to see available templates, their app_id, descriptions, and required input_data fields.
2

Create a generation

Call POST /generations with app_id, input_data (template-specific), optional brand_voice_id, and workspace_id. Some apps return immediately; others may run asynchronously (poll or use webhook if supported).
3

Read the output

Response includes output (text) and often markdown. Check usage.credits_used for cost.

Available Templates

Browse generation apps to find templates and their input structure:

Creating Content

Pass app_id (from generation apps), input_data (fields required by that template), optional brand_voice_id, and workspace_id.

Common input_data Fields

Different templates expect different fields. Typical examples: Check GET /generation-apps for the exact schema per template.

Response Format

If the generation runs asynchronously, status may be PENDING or RUNNING. Poll GET /generations/{id} until status is COMPLETED.

Polling for Completion (Async Generations)

Some templates process asynchronously. Poll until status is COMPLETED:

List Generations

Optionally filter by workspace_id, app_id, or paginate with cursor and limit.

Delete a Generation

Credit Costs

Check usage.credits_used in each response. See Credits for your plan.

Best Practices

Pass brand_voice_id from a Brand Voice profile so output matches your tone and vocabulary.
Clear topic, target_audience, and key_points produce better output than vague prompts.
Call GET /generation-apps to discover templates and required fields before building your integration.

Brand Voice

Create and use brand voice profiles

Credits

Credit allocation and tracking

API Reference

Full API specification