1. Docs
2. /
3. Tool reference
4. /
5. Studio Apps
6. /
7. draftArticle

Studio Apps

draftArticle

Draft Article

Draft an article for The Journal on the platform site.

write

Arguments

• appIdstringrequiredThe platform site's Studio app id
• titlestringrequiredThe article headline
• descriptionstringrequiredOne sentence. Becomes the meta description and the card copy.
• kindstringrequiredArticle kind: field-note, guide, discovery. A field note is what we saw while building, a guide is how to do a thing end to end, a discovery is a result worth knowing.
• topicsstring[]optionalUp to 4 topics. Each becomes a topic hub at /journal/t/<topic>.
• slugstringoptionalURL slug. Derived from the title when omitted.
• markdownstringoptionalThe article body in markdown. Include a `## FAQ` section.
• pageIdstringoptionalExisting article page to re-draft instead of creating one.
• ogImagePathstringoptionalPath to a published site asset to use as the OG image.

Returns

The registry does not declare a return shape.

Ask for it

The Cloud routes these requests to this verb.

• draft an article about X
• start a field note on Y
• write a guide for Z

Pair it with

The verbs that finish the job.

• publishArticle
• listArticles