Subscribe to Our Newsletter


RebelMouse Public API


Our REST API service uses key-based authorization that can be managed in your Account page. You can find your API key in the form of a 64-character string. But please note that we use this unique key to identify your account, so please do not share it with anyone.

All client requests are authorized using valid API keys via a specific HTTP header or query string. Query strings take priority over the HTTP header, so query strings will be considered if you send both at the same time.

Sending API Key via Query String

In order to authorize requests using the " api_key" query string, you need to send it as follows:

<HTTP-METHOD> <domain>/api/<version>/<path>?api_key=<api_key>

Sending API Key via HTTP Header

In order to authorize requests using the " X-RMAuth" HTTP header method, you need to send it as follows:

<HTTP-METHOD> <domain>/api/<version>/<path> X-RMAuth: <api_key>

Unauthorized Requests

If you send invalid API keys, you will get a response with HTTP 403 Forbidden status and the following payload:

{ "status": { "code": null, "messages": ["API key is not valid"] }, "data": null }


Author API

The author API supports creating users that can be used to create drafts.

Creating Authors

Creates an author and sets its role as guest editor.

POST /api/1.1/authors


Name Type Description
first_name String First name - Required
last_name String Last name - Required
email String User email - Required
password String User password - Required
about_html String User biography - Optional
image_id Integer ID of the uploaded image - Optional


  • image_id can be found as id in Image API response when uploading or editing images.


{ "id": <id>, "name": "paulberry", "displayname": "Paul Berry", "about_html": "This is me", "bio": "", "photo": "https://<domain>/res/avatars/default", "fb_id": null, "profile_url": "https://<domain>/community/paulberry/" }


Drafts API

The draft API supports creating drafts that can be used to publish content on your site.

Creating Drafts

Creates a draft and sets the current user as author by default.

POST /api/1.1/posts


Name Type Description
headline String Headline - Required
body String Body - Optional
subheadline String Subheadline - Optional
tags Array of strings Tags - Optional
primary_tag String Primary tag - Optional
sections Array of strings Sections - Optional
primary_section String Primary section - Optional
og_title String Social headline - Optional
og_description String Social description - Optional
image_id Integer ID of the uploaded image - Optional
manual_image_crops Object Cropping calculated when uploading image - Optional


  • primary_section and sections fields are eligible by title using insensitive case mode. "Home" can be passed if you want to set a draft in the home page.
  • image_id can be found as id in Image API response when uploading or editing images.
  • manual_image_crops can be also found as manual_image_crops in Image API response when editing images.


The response can contain several fields, but we would like to highlight some of them that were specially requested:

Name Type Description
post_url String URL of the draft when it's published
draft_url String Composited by post_url + "?draft=1", which enables users to see the draft page
slug String URL path from post_url


Image API

The Image API supports uploading and editing images that can be used for splash posts, teasers, social teasers, and even features other than posts — such as authors creation.


Every site on the RebelMouse platform has its own image-cropping settings configured. These settings are useful whenever an image is going to be resized or cropped. The settings are considered in every process related to images, and each resized or cropped image usually has a different purpose depending on page type.

For Axios, we have the following ratios configured:

Title Code Sizes
FHD 16x9
  • 960x540
  • 480x270
Wide 2x1
  • 1200x600
  • 600x300
Medium 2x1
  • 1200x600
  • 600x300
Tall 1x1
  • 600x600
Instant 9x16
  • 700x1245

Uploading Images

Upload an image, sending its content as a part of an HTTP request body or a URL as part of a JSON document.

POST /api/1.3/images


Name Type Description
image_url String An image URL location - Optional


Multiple files can be also sent as part of an HTTP request. They are used only if image_url is not used in the HTTP request.


For a single image uploaded:

{ "is_animated_gif": false, "task_id": "c3e2a367-24cb-426f-9179-457a0e0ea9ec", "height": 511, "shortcode_id": "7229TA1498262817", "iptc": { "by-line": "", "caption/abstract": "" }, "id": <id>, "shortcode_params": { "is_animated_gif": false, "crop_info": "

For multiple images uploaded:

It takes the same schema for each image uploaded, but in the form of an array.

Editing Images

Editing an image to create copies with specific dimensions.

PUT /api/1.3/images/<id>


Name Type Description
image_url String An image URL location - Required
manual_image_crops Object Crop setting for resizing an image - Optional

Manual Image Cropping

Manual image cropping depends on the ratios that have been configured for the site. It must be an object, whose keys must be the ratio codes. The values should contain the following information:

Name Type Description
top Integer Absolute top coordinate
left Integer Absolute left coordinate
height Integer Absolute height coordinate
width Integer Absolute width coordinate
imgHeight Integer Height of the original image
imgWidth Integer Width of the original image


{ "16x9": { "top": 222, "left": 0, "height": 289, "width": 512, "imgWidth": 512, "imgHeight": 511 }, "2x1": { "top": 255, "left": 0, "height": 256, "width": 512, "imgWidth": 512, "imgHeight": 511 }, "3x2": { "top": 169, "left": 0, "height": 342, "width": 512, "imgWidth": 512, "imgHeight": 511 }, "1x1": { "top": 402, "left": 0, "height": 109, "width": 109, "imgWidth": 512, "imgHeight": 511 }, "9x16": { "top": 303, "left": 0, "height": 208, "width": 117, "imgWidth": 512, "imgHeight": 511 } }


It takes the same schema from uploading images. Only one image can be edited per request.



Webhooks allow you to receive notification of certain events from the RebelMouse platform. HTTP POST requests are performed for the configured URL you provide to us. These requests are formed with the following headers:

Name Value
User-Agent RebelMouse/0.1 Mozilla/5.0 (compatible; Gecko/20100101 Firefox/7.0.1
Content-Type application/json

Published Post

You can receive a notification when a post is published. You will receive the following information:

Name Type Description
post_id Integer ID of the post
post_url String URL of the published post

Click here for more on RebelMouse Public API v1.2.

You're almost there! Fill out the form below and a Rebel will contact you within one business day.


How to Setup Google Search Console ​

Google Search Console is a free tool that helps you to understand and optimize your site's performance on Google's search results. When Google visits your website for tracking purposes, it performs what's called crawling and indexing, a process of adding webpages into its search results.

The console will allow you to add or remove certain content from Google's search results. The tool will also help you learn which keywords trigger your site to appear in Google's ranking, and which third-party sites are linking to yours. It also allows you to monitor your site's performance on search, including locating any errors on your pages. Here is a step-by-step guide for adding a Google Search Console to your RebelMouse website.

Keep reading... Show less

NEW: Important Upgrade to Facebook's Share Feature

There's an exciting new feature live on all RebelMouse sites that makes every Facebook share more customizable. This key update allows you to edit the meta information of a Facebook post before and after publish, making it easier to manage how your content appears on the platform.

Keep reading... Show less

You're almost there! Fill out the form below and a Rebel will contact you within one business day.


How to Add Google Forms to a Static Page

The easiest way to add forms to your RebelMouse site is to use Google Forms, which embeds right into the code of your page. Here's a step-by-step guide.

Keep reading... Show less

Create a Winning SEO Strategy with Related Articles

One of the staples of our Entry Editor is the ability to optimize your article for search while it's still in draft mode. You can customize the SEO headline, description, and even the URL slug of each post before it's published.

Keep reading... Show less