Documents

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET
https://app.allinwriter.com/api/v1/documents

Request example:

curl --location --request GET 'https://app.allinwriter.com/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
search
optional string
The search query.
search_by
optional string
Search by. Possible values are: name for Name, result for Result. Defaults to: name.
template_id
optional integer
Filter by template ID. Possible values are: 1 for Freestyle, 2 for Facebook Post, 3 for Instagram Post, 4 for Linkedin Post, 5 for Twitter - Tweet, 6 for Blog outline, 7 for Blog outro, 8 for Blog paragraph, 9 for Blog post, 10 for Blog section, 11 for Blog talking points, 12 for Blog title, 13 for Call to action, 14 for Content rewrite, 15 for Content summary, 16 for FAQ, 17 for Hashtags, 18 for Headline, 19 for How it works, 20 for Meta description, 21 for Meta keywords, 22 for Mission statement, 23 for Newsletter -old, 24 for Pain-Agitate-Solution, 25 for Paragraph, 26 for Press release, 27 for Social post, 28 for Social post caption, 29 for Startup ideas, 30 for Startup names, 31 for Subheadline, 32 for Testimonial, 33 for Tweet, 34 for Twitter thread, 35 for Value proposition, 36 for Video description, 37 for Video script old, 38 for Video tags, 39 for Video title, 40 for Vision statement, 41 for Recipe, 45 for Translator, 46 for Povesti pentru copii, 48 for Code converter, 49 for Articol mare, 51 for Articol SEO - hibrid(in lucru), 55 for Articol SEO - GPT-4(in lucru), 56 for Articol SEO - GPT-3(in lucru), 57 for Articol mare - hibrid, 58 for Outreach Message, 59 for Impact discurs, 60 for Discurs, 61 for Product sheet, 62 for Google advertisement, 63 for Facebook advertisement, 64 for Welcome email, 65 for Push notification, 66 for Blog listicle, 67 for Content grammar, 68 for Blog tags, 69 for Pros and cons, 70 for Job description, 71 for Review, 72 for Feature section, 73 for Google ads - BETA, 75 for Facebook Ads, 76 for Facebook Post - Product, 77 for Facebook Post+, 78 for Facebook Ads - UGC, 79 for Facebook Post - UGC, 80 for Code Writer, 81 for Advertorial, 82 for SEO Article, 83 for Article, 84 for Sentences, 85 for Text to Audio, 86 for Facebook Ads ( BETA ), 87 for Cover Letter, 88 for Interview - FAQs, 89 for Podcast, 90 for Youtube - video podcast, 91 for Podcast - Long, 92 for Video title & description, 93 for eBook, 94 for Video script, 95 for Conversion Rate+, 96 for Sales Pitch Message, 97 for Replier, 98 for Freelancer, 99 for Business Plan, 100 for Investor Message, 101 for Market research, 102 for Marketing plan, 103 for SWOT Analysis, 104 for Operations Plan, 105 for Growth strategies, 106 for Risk Assessment, 107 for Investment Terms, 108 for Call Script, 109 for Course, 114 for Call Script - B2C, 115 for Sales Pitch Message - B2C, 117 for Professional Images, 118 for Images - Custom Style, 121 for Images, 122 for Medium Article, 124 for Long Article, 126 for Linkedin Post+, 127 for Linkedin Post - UGC, 128 for Linkedin Post - Product, 129 for Twitter Tweet+, 130 for Instagram Post+, 131 for Instagram Post - UGC, 132 for Instagram Post - Product, 133 for Blog intro, 134 for Short Article 2, 136 for Advertisement, 137 for About us, 138 for Retete, 139 for Retete zilnice, 140 for Product description, 141 for Product description, 142 for Product description+, 143 for Product description+ - Long, 144 for Service description, 145 for Service description, 146 for Service description+, 147 for Service description+ - Long, 518 for Ideal buyer, 519 for Article - Clone (Adrian V1), 521 for News, 522 for Rewrite News, 523 for News+, 524 for Article - Clone (Adrian V2) - Clone, 525 for Article - Clone (Adrian V3) - Clone - Clone, 526 for Article V3 - Tradus, 528 for Short Article - BKP, 529 for Whatsapp message - B2B, 530 for WhatsApp message, 533 for Article - Personalizat Cazino/Pariuri, 534 for Medium Article - Clone, 540 for Article - EL, 541 for Advertorial - Clone, 542 for Article Plus - Fast, 543 for Retete in stil Trio, 545 for Reteta in stil Trio - Meniuri zilnice, 546 for Article Plus - BKP, 548 for Reteta dupa denumire, 549 for Reteta dupa denumire cu buget, 550 for Reteta dupa denumire cu anotimp, 551 for Facebook Post+ Test, 552 for Facebook Post+ with Call To Action, 553 for Linkedin Post+ - with Call to Action, 554 for Instagram Post+ with Call to Action, 556 for Article Plus - V2, 557 for Article Plus - OLD, 561 for Article Plus - Adrian, 562 for Article Plus - Adrian (not parallel), 563 for Article Plus - Adrian (not parallel) - Structure, 564 for Article Plus - V5, 565 for Article Plus - V5 - Clone (ADRIAN), 566 for Crowdfunding Campaign, 567 for Newsletter - Mail 1, 569 for Newsletter - Mail 1, 570 for Newsletter, 571 for Newsletter - Mail 2, 572 for Newsletter - Mail 3, 573 for Newsletter - Mail 4, 574 for Newsletter - Mail 5, 575 for Newsletter - Mail 6. Defaults to: freestyle.
favorite
optional boolean
Filter by favorite.
sort_by
optional string
Sort by. Possible values are: id for Date created, name for Name. Defaults to: id.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional int
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

API endpoint:

GET
https://app.allinwriter.com/api/v1/documents/{id}

Request example:

curl --location --request GET 'https://app.allinwriter.com/api/v1/documents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST
https://app.allinwriter.com/api/v1/documents

Request example:

curl --location --request POST 'https://app.allinwriter.com/api/v1/documents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'prompt={prompt}'
Parameter
Type
Description
name
required string
The template name.
prompt
required string
The instructions for the AI.
creativity
required float
The creative level of the result. Possible values are: 0 for Repetitive, 0.25 for Deterministic, 0.5 for Original, 0.75 for Creative, 1 for Imaginative. Defaults to: 0.5.
Update

API endpoint:

PUT PATCH
https://app.allinwriter.com/api/v1/documents/{id}

Request example:

curl --location --request PUT 'https://app.allinwriter.com/api/v1/documents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
name
optional string
The template name.
result
optional string
The document result.
favorite
optional boolean
Whether the document is favorite or not.
Delete

API endpoint:

DELETE
https://app.allinwriter.com/api/v1/documents/{id}

Request example:

curl --location --request DELETE 'https://app.allinwriter.com/api/v1/documents/{id}' \
--header 'Authorization: Bearer {api_key}'