Developer API and keys

Create and keep a key

Open the account menu, choose Account and find API keys. Name the key, then click Create key. Copy the key and installation prompt while they are shown. A key is shown once.

Keys belong to the workspace and let your website or tools fetch published articles from its sites. Keep the key on your server. The install prompt describes the blog integration and how your website reads the content.

The three endpoints

The key reveal lists three GET requests at https://rankyourapp.io/api/content. Send your key in the X-Api-Key header on every request. Replace the example domain and slug with your site's values. Only published articles are returned; approving or scheduling a draft does not make it available here.

Responses, paging and limits

The list returns article summaries with slug, title, excerpt, date, tags, author and image information. It takes offset and limit; limit is 1 to 100, with 100 by default. Follow next_offset while it is present. The feed returns the published slug and date inventory. One article adds rendered content_html, FAQ pairs and search metadata.

A key has a limit of 2,000 requests per UTC day. An unknown or revoked key returns 401; a request over the daily limit returns 429. A missing article returns 404. Invalid site selection or paging returns 400. A temporary content-service failure returns 503. Read the returned error before retrying, and keep the domain parameter on each request.

Install the public blog

Choose Developer · read from our API under Connections if your developer is implementing it. Use the supplied installation prompt and deploy indexable article pages at your blog address. Keep the key in server configuration or the build environment. A static build must refresh when articles change. Verify the public installation before publishing starts.

For an existing blog, merge its content source, routes and sitemap and check old URLs. The key reveal is not proof that the blog has been installed. AI builder installation · Existing blogs

Revoke a key

In Account's API keys list, Revoke opens a confirmation. Once revoked, the key stops working and cannot be restored. Anything using it needs a new key. Update your website's server configuration when replacing one. Removing a publishing connection and revoking its workspace key are separate actions.