Overview

Here is an overview of what you need to know to begin working with the SlickText API. As always, if you have questions, feel free to contact us.

Base URL
Versioning
Authorization
Content Type
Rate Limiting
The Response

Base URL

The base URL for all SlickText API calls is:

https://dev.slicktext.com/v1/

Versioning

We currently have 2 versions of our API. If your account is with our legacy system, the API documentation lives here.

To determine if you have a legacy account:

Log into your account.
If the URL is “https://www.slicktext.com/dashboard/” then you have a legacy account.

We do our best to make sure any changes or additions won't break applications you’re currently using. If this is a possibility, we'll release a new version, and you can continue using V1.

Authorization

In order to authenticate, you'll need the API keys from your SlickText account. If you haven't used them before, they may need to be generated. Click the ellipsis beside your name on the bottom left of your dashboard. Select the Settings menu item. Once on the Settings page, select API & Webhooks and then select API Keys. Finally, click Create API Key to get your key.

Screenshot of the SlickText dashboard showing the API & Webhooks settings page.

The key should be in the request Authorization header, used as a Bearer token.

Authorization: Bearer {your_key_here}

Content Type

The Content-Type header for the request should be set to application/json, and the request body should be formatted as JSON.

Rate Limiting

By default, requests to our API are limited to 4 per second or 240 per minute. This is measured over a 60-second window to allow for short bursts. All responses to authenticated requests will include three specific headers that give you the current status of your limit.

HEADER NAME	DESCRIPTION
x-RateLimit	The maximum number of requests you can make per window
x-RateLimit-Remaining	The number of requests remaining in the current rate limit window.
x-RateLimit-Reset	The number of seconds until the current rate limit window resets

These limits can be adjusted. If your account/use case requires additional throughput, please reach out to our support team to discuss increasing your rate limits.

The Response

A successful response will result in an HTTP status code of 200, and the response body will be a JSON string representing the results.

Example Successful Response:


            
                
            
            {
            "brand_id": 1234567890,
            "name": "SlickText",
            "website": "http://www.slicktext.com",
            "industry": "retailEcommerce",
            "prohibited_content": "0",
            "use_case": "mixed",
            "address": "301 E 2nd St #304",
            "city": "Jamestown",
            "state": "NY",
            "zip": "14701",
            "country": "US",
            "contact_first_name": "Johnny",
            "contact_last_name": "SlickText",
            "contact_email": "johnny@slicktext.com",
            "contact_phone": "+17165551212",
            "_account_id": "987654321",
            "created": "2024-01-17 20:25:52",
            "last_updated": "2024-01-17 20:25:53"
            }

A failure will result in a non-200 status code. The response body, in this case, will contain a message that will hopefully give you some insight into what happened.

ERROR CODE	ERROR REASON
400	Bad Request - There was an error in your request
403	Forbidden - Your account doesn’t have access to that resource
404	Not Found - That resource doesn’t exist
500	Internal Server Error - Oops. We did something wrong (hopefully just a typo)

Example responses will be included in the documentation for our specific resources.