API Documentation

Spin Rewriter API technical documentation makes integration a breeze.


Every API request should be sent as an HTTP POST request.
Every API result is always returned in JSON format.


URL for API requests:


HTTP POST request specification:

POST Field Name
Note
Description
email_address
included with every request
The email address that you're using with Spin Rewriter.
api_key
included with every request
Your unique API key. Available inside your account.
action
included with every request

possible values:
api_quota
text_with_spintax
unique_variation
unique_variation_from_spintax
The action that you're requesting from the Spin Rewriter server.
api_quota: returns the number of made and remaining API calls for the 24-hour period
text_with_spintax: returns the processed spun text with spintax
unique_variation: returns a unique variation of processed given text
unique_variation_from_spintax: returns a unique variation of already spun text
text
included with all "text_with_spintax", "unique_variation" and "unique_variation_from_spintax" API requests
Your original text that you wish to rewrite or spin. This text will be analyzed by our software, its meaning will be extracted, and Spin Rewriter will rewrite it with synonyms for individual words and phrases.
protected_terms
optional parameter

default: (empty)
A list of keywords and key phrases that you do NOT want to spin. One term per line, i.e. terms are separated by the "\n" (newline) character.
auto_protected_terms
optional parameter

possible values:
» false   (default)
» true
Should Spin Rewriter automatically protect all Capitalized Words except for those in the title of your original text?
confidence_level
optional parameter

possible values:
low
medium   (default)
high
The confidence level of the One-Click Rewrite process.
low: largest number of synonyms for various words and phrases, least readable unique variations of text
medium: relatively reliable synonyms, usually well readable unique variations of text (default setting)
high: only the most reliable synonyms, perfectly readable unique variations of text
nested_spintax
optional parameter

possible values:
false   (default)
true
Should Spin Rewriter also spin single words inside already spun phrases?

If set to "true", the returned spun text might contain 2 levels of nested spinning syntax.
auto_sentences
optional parameter

possible values:
false   (default)
true
Should Spin Rewriter spin complete sentences?

If set to "true", some sentences will be replaced with a (shorter) spun variation.
auto_paragraphs
optional parameter

possible values:
false   (default)
true
Should Spin Rewriter spin entire paragraphs?

If set to "true", some paragraphs will be replaced with a (shorter) spun variation.
auto_new_paragraphs
optional parameter

possible values:
false   (default)
true
Should Spin Rewriter automatically write additional paragraphs on its own?

If set to "true", the returned spun text will contain additional paragraphs.
auto_sentence_trees
optional parameter

possible values:
false   (default)
true
Should Spin Rewriter automatically change the entire structure of phrases and sentences?

If set to "true", Spin Rewriter will change "If he is hungry, John eats." to "John eats if he is hungry." and "John eats and drinks." to "John drinks and eats."
use_only_synonyms
optional parameter with "unique_variation" and "unique_variation_from_spintax" API requests

possible values:
false   (default)
true
Should Spin Rewriter use only synonyms of the original words instead of the original words themselves?

If set to "true", Spin Rewriter will never use any of the original words of phrases if there is a synonym available. This significantly improves the uniqueness of generated spun content.
reorder_paragraphs
optional parameter with "unique_variation" and "unique_variation_from_spintax" API requests

possible values:
false   (default)
true
Should Spin Rewriter intelligently randomize the order of paragraphs and unordered lists when generating spun text?

If set to "true", Spin Rewriter will randomize the order of paragraphs and lists where possible while preserving the readability of the text. This significantly improves the uniqueness of generated spun content.
spintax_format
optional parameter with "text_with_spintax" API requests

possible values:
{|}   (default)
{~}
[|]
[spin]
#SPIN
The spintax format of the returned spun text.
{|}: the {first option|second option} spintax used (default setting)
{~}: the {first option~second option} spintax used
[|]: the [first option|second option] spintax used
[spin]: the [spin]first option|second option[/spin] spintax used
#SPIN: the {#SPIN: first option || second option #} spintax used



JSON response specification:

Field Name
Note
Description
status
included with every response
This can be either "OK" or "ERROR", depending on the success of your request.
response
included with every response
One of the following: spun version of given text, unique variation of given text, API quota description, error description.
api_requests_made
included with every successful response
The number of API requests you have made in the last 24 hours.
api_requests_available
included with every successful response
The number of remaining API requests that you can still make within the 24-hour period.
protected_terms
optional information
The list of protected keywords and key phrases that were used while processing your text.
confidence_level
optional information
The confidence level (low, medium or high) of the One-Click Rewrite process.



Spin Rewriter API Limitations:

Spin Rewriter API comes with some limitations that allow everyone to use it reliably and without unwanted delays. At the moment you can make up to 500 API requests per day.

You should also do your best to give our API servers some rest between multiple API requests from the same application. Ideally you should make sure your individual API requests are spaced at least 7 seconds apart.

You can only submit entirely new text for processing once every 7 seconds. That's because each API request relies on the meaning-based Spin Rewriter ENL Semantic Spinning technology that requires 40-100 times as much processing power as the more basic approach used by our competitors.

You can generate unique variations of already processed text every second though.


How to get started in 5 minutes?

Check out our collection of working API code samples. Once you see the code in action, you will feel right at home and you'll be ready to start integrating Spin Rewriter's ENL Semantic Spinning technology into your application in no time.