API Documentation

Send a request

  • The API URL is: https://api.copymatic.ai
  • All requests must be sent as POST and from a valid website. Requests coming from local hosts are not allowed.
  • Always include your API key in HTTPHEADER or your requests will fail.
  • Data parameters such as audience, tone, etc... must be sent as JSON and with the correct key (keys can be found in the list below).

Request example

$api_key = 'xxxxxxxxxxxxxxxxx';

$req_body = array( 'model' => "blog-ideas", 'tone' => "friendly", 'creativity' => "regular", 'topic' => "A blog article about an AI article generator.", 'language'=> "English (US)" );

$postfields = json_encode($req_body);

$curl = curl_init();

curl_setopt_array($curl, [ CURLOPT_URL => "https://api.copymatic.ai", CURLOPT_RETURNTRANSFER => true, CURLOPT_FOLLOWLOCATION => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => $postfields, CURLOPT_AUTOREFERER => true, CURLOPT_HTTPHEADER => [ 'Content-Type: application/json', 'Authorization: Bearer '.$api_key ] ]);

$r = curl_exec($curl);

$err = curl_error($curl);

curl_close($curl);

Parameter list

  • model Values: see the list of ids below
  • tone Values: professional, friendly, luxury, childish, confident
  • creativity Values: regular or high
  • language English (US), English (UK), French, Spanish, German, Italian, Dutch, Portuguese, Portuguese (BR), Swedish, Norwegian, Danish, Finnish, Romanian, Czech, Slovak, Slovenian, Hungarian, Croatian, Polish, Greek, Turkish, Russian, Hindi, Thai, Japanese, Chinese (Simplified), Korean, Indonesian
  • n Controls the number of outputs you want (max 10)

The other parameters such as audience, topic, or any other parameter are free inputs, set by yourself.

List of models and their parameters

Model name Model id Parameters
Social Media Post (Business) social-media-post-business language
creativity
tone
company_name
business_description (max characters: 200)
topic_social
Social Media Post (Personal) social-media-post-personal language
tone
topic (max characters: 400)
Instagram Captions instagram-captions language
tone
topic (max characters: 400)
Instagram Hashtags Generator instagram-hashtag-generator instagram_keyword
Facebook Primary Text facebook-primary language
creativity
tone
audience
productname
description (max characters: 400)
Facebook Headlines facebook-headlines language
creativity
tone
audience
productname
description (max characters: 400)
Google Ads Headlines google-headlines language
creativity
tone
audience
productname
description (max characters: 400)
Google Ads Description google-descriptions language
creativity
tone
audience
productname
description (max characters: 400)
Video Titles youtube-titles language
creativity
video_description (max characters: 200)
Video Descriptions youtube-descriptions language
creativity
video_title (max characters: 100)
Quora Answers quora-answers language
creativity
quora_question (max characters: 200)
Personal Bio personal-bio language
creativity
full_name (max characters: 100)
current_position (max characters: 100)
current_industry (max characters: 100)
current_city (max characters: 100)
childhood (max characters: 200)
hobbies (max characters: 200)
interests (max characters: 200)
skills (max characters: 200)
character_traits (max characters: 200)
point_of_view
Website Headlines website-headlines language
creativity
tone
audience
productname
description (max characters: 400)
Website Subheaders website-subheadlines language
creativity
tone
audience
productname
description (max characters: 400)
Product Descriptions product-descriptions language
creativity
productname
audience
description (max characters: 400)
Value Proposition value-proposition language
creativity
tone
audience
productname
description (max characters: 400)
Feature To Benefit feature-to-benefit language
creativity
tone
audience
productname
description (max characters: 400)
Meta Titles (URL) meta-titles creativity
website_name
website_url
keywords
Meta Descriptions meta-descriptions language
creativity
page_type
website_name
business_description (max characters: 200)
keyword
Meta Descriptions (URL) meta-descriptions-url creativity
website_name
website_url
keywords
FAQs faq language
creativity
productname
audience
description (max characters: 400)
FAQ Answers faq-answers language
creativity
productname
audience
description (max characters: 400)
question
Paragraph Writer subheading-paragraph language
creativity
blog_title
subheading (max characters: 200)
Blog Section blog-sections language
creativity
blog_title
subheading (max characters: 200)
Blog Titles blog-titles language
creativity
topic (max characters: 200)
Blog Ideas blog-ideas language
creativity
topic (max characters: 200)
Blog Titles (Listicles) blog-titles-listicles language
creativity
topic (max characters: 200)
Blog Intros blog-intros language
creativity
blog_title
blog_description (max characters: 200)
Blog Intros New blog-intros-new language
creativity
blog_title
Write More write-more language
creativity
blog_title
Pricing Features pricing-features description (max characters: 400)
Blog Outlines blog-outline language
creativity
blog_title
blog_description (max characters: 200)
Blog Conclusions blog-conclusions language
creativity
article_title
Talking Points talking-points language
creativity
article_title
subhead
Pros & Cons pros-cons language
creativity
productname
description (max characters: 400)
Ecommerce Product Descriptions ecommerce-product-descriptions language
creativity
tone
audience
productname
description (max characters: 400)
Ecommerce Category Descriptions ecommerce-category-descriptions language
creativity
business_name
audience
business_description (max characters: 200)
category_name
keyword
Ecommerce Product Names ecommerce-product-names creativity
tone
audience
description (max characters: 400)
Sentence Rewriter sentence-rewriter language
creativity
sentence (max characters: 600)
Rewrite With Keyword rewrite-with-keyword language
creativity
keyword
text_to_rewrite (max characters: 600)
Sentence Expander sentence-expander language
creativity
sentence (max characters: 1000)
Text Summarizer (TL;DR) tldr creativity
text_to_summarize
Startup Name Generator startup-name-generator creativity
seedwords
description (max characters: 400)
Mission Statement mission-statement language
creativity
company_name
business_description (max characters: 200)
Vision Statement vision-statement language
creativity
company_name
business_description (max characters: 200)
Review Responder review-responder language
creativity
company_name
reviewer_name
rating
tone
customer_review (max characters: 600)
Grammar Rewriter grammar-rewriter sentence (max characters: 600)
Essay Intros essay-intros creativity
topic (max characters: 200)
Essay Outlines essay-outlines creativity
topic (max characters: 200)
Project Text Proposal project-text-proposal language
creativity
project_title
project_description (max characters: 600)
required_skills
Write for me write-for-me creativity
content (max characters: 200)
Pain-Agitate-Solution pain-agitate-solution language
creativity
productname
audience
description (max characters: 400)
AIDA Formula attention-interest-desire-action language
creativity
productname
audience
description (max characters: 400)
QUEST Formula quest language
creativity
productname
audience
description (max characters: 400)
Testimonials / Reviews testimonials language
creativity
productname
description (max characters: 400)
How It Works how-it-works language
creativity
productname
audience
description (max characters: 400)
About Us about-us language
creativity
tone
productname
audience
description (max characters: 400)
Call To Action cta language
creativity
productname
audience
description (max characters: 400)
Press Releases press-releases language
creativity
tone
company_name
business_description (max characters: 200)
announcement (max characters: 400)
Video Script Intros video-script-intros language
creativity
tone
audience
video_description (max characters: 200)
Video Script Outlines video-script-outlines language
creativity
tone
audience
video_description (max characters: 200)
Video Script Section video-script-section language
creativity
tone
audience
video_section_title
video_description (max characters: 200)
Cold Email cold-email language
creativity
tone
email_goal
sender_name
recipient_name
sender_information
recipient_information
Follow-Up Email follow-up-email language
creativity
tone
audience
following_up_after (max characters: 100)
productname
description (max characters: 400)
Welcome Email welcome-email language
creativity
tone
audience
productname
description (max characters: 400)
Cancellation Email cancellation-email language
creativity
tone
audience
productname
description (max characters: 400)
Confirmation Email confirmation-email language
creativity
tone
audience
confirmation_of (max characters: 100)
productname
description (max characters: 400)
Email Subject Lines email-subject-lines language
creativity
tone
audience
productname
description (max characters: 400)
Ecommerce Product Description Bullet Points ecommerce-product-features language
creativity
description (max characters: 400)
Amazon Product Descriptions amazon-product-descriptions creativity
amazon_product_url