NAV Navbar
Logo
shell

Introduction

Unfurld is a microservice that unfurls links, like Slack. It exposes a single endpoint.

Authentication

Unfurld is intended to be deployed behind a firewall, and hence does not support authentication as of now.

Unfurl links

curl -XPOST "http://unfurld.herokuapp.com/api/v1/unfurl.json"

The above command returns JSON structured like this:

{"status": 200}

This endpoint extracts links from the provided content and unfurls them.

HTTP Request

POST http://unfurld.herokuapp.com/api/v1/unfurl.json

Request Body

Parameter Mandatory Description
content true The content to extract links from

Errors

The Kittn API uses the following error codes:

Error Code Meaning
400 Bad Request. The JSON response will contain an errors parameter explaining the reason
404 An endpoint matching the specified URL could not be found
405 The endpoint doesn’t support the HTTP method used
429 You’ve hit rate limits, increase or try again later.