short

Short API Endpoint: Shorten links using Ayrshare's URL link shortener.

Please try the new link shortener endpoint. The link shortener we use for this /short endpoint is being deprecated by Google over the next 12 months. We recommend using the new /links endpoint since it has no external dependencies and greater functionality.

The /short endpoint can be used as a URL link shortener API. POST a URL, such as a website, to the endpoint and a shortened link is returned. URLs in the post body of the /post endpoint are automatically shortened and can be disabled with shortenLinks=false parameter.

A URL shortener reduces the size of a URL to make it more readable, saves characters, which is especially important for social networks such as Twitter, and allows analytics tracking of impressions and clicks. Shortened links use the ayr.app domain.

A custom URL shortener, known as a branded URL shortener, is available for Enterprise Plans.

Premium or Business Plan required.

Click the in the endpoint to view details.

Shorten a URL

POST https://app.ayrshare.com/api/short

URL Shortener. Submit a URL and get a shortened URL to save characters. This is helpful when you want to conserve your character count on Twitter. Note: in the /post endpoint you automatically shorten URLs in the post text. Note: url must begin with https:// Premium or Business Plan required.

Headers

NameTypeDescription

Authorization*

string

Format: Authorization: Bearer API_KEY. See Overview for more information.

Profile-Key

string

The Profile Key of a user profile.

Request Body

NameTypeDescription

url*

string

URL to be shortened. Must be a valid URL starting with "https://"

socialMeta

object

Please see below

{
    "status": "success",
    "shortUrl": "https://ayr.app/l/hXcC",
    "originalUrl": "https://www.google.com"
}

Request Examples

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"url": "https://www.ayrshare.com"}' \
-X POST https://app.ayrshare.com/api/shorten

When creating the shortened URL, you may also specify social media metadata for the link preview. The title, description, and image can be set. For example:

The above Tweet preview link was created with the following:

{
    "url": "https://www.ayrshare.com",
    "socialMeta": {
        "title": "Social Media with an API",
        "description": "Social done right with an API. The only way to go!",
        "mediaUrl": "https://img.ayrshare.com/012/gb.jpg"
    }
}

All fields are required or the metadata will not be set.

  • title: The preview title.

  • description: Body description of the preview.

  • mediaUrl: URL to the image used by the preview. The image should be at least 300x200 px, and less than 300 KB.

Social metadata is passed to Twitter, Facebook, Facebook Messenger, iMessage, WhatsApp, and other services.

Bitly Integration

You may use your own link shortener, such as Bit.ly, by providing us with the API key from the link shortening service. This allows you to use a custom domain when shortening the link. You may then directly call the bit.ly API to retrieve analytics. Please contact us for more information.

Available for Premium and Business Plans

pageanalytics

Last updated