Skip to main content
POST
Submit a generation request

Authorizations

Authorization
string
header
required

A WriterzRoom API key.

Body

application/json
template_id
string | null

Template id, such as blog_article_generator. Required unless template is sent.

Minimum string length: 1
template
string | null

Older name for template_id.

Minimum string length: 1
style_profile_id
string | null

Style profile id, such as general_blog.

Minimum string length: 1
style_profile
string | null

Older name for style_profile_id.

Minimum string length: 1
user_input
User Input · object

The template's inputs (topic and the template's own parameters), plus optional length_preset, word_range, practice_area and reference_files.

generation_settings
Generation Settings · object

Run settings. generation_mode here is read when the top-level field is absent.

generation_mode
string | null

Tier: quick, standard or premium. Premium requires a Professional or Enterprise plan.

request_id
string | null

Your id for this run, 8-128 letters, digits, _ or -. Resending the same id returns the existing run instead of starting another.

user_id
string | null

Ignored. The caller is identified by the API key.

dynamic_parameters
Dynamic Parameters · object

Merged with user_input; user_input wins on a conflict.

vertical_id
string | null

Vertical whose rules, disclaimers and verifiers apply, such as legal or medical_ai.

brand_voice_id
string | null

One of your Brand Voice profiles.

audience_id
string | null

One of your saved audiences.

target_platform
string | null

Publishing destination the draft is shaped for, such as linkedin or wordpress.

Response

Successful Response