Skim.it API

At Skim.it our extraction and summarisation technology is an integral part of our product. Now with our API you can use our technology in your own applications.

authentication

All of our end points are secured using an API key and should be sent via the x-api-key header to https://api.skim.it/v1/{resource}

Our API keys are 40 character alphanumeric strings and are case sensitive.

Please request your free API key above by emailing us to get started.

Requests are rate limited to 5 requests per second with bursts of up to 20 requests. If your needs exceed these limits please get in contact with us.

skims

Skims are the complete end to end product of our extraction, identification and summarisation technology. Here is an example of what one looks like:

{
	"uri": "http://www.bbc.co.uk/sport/0/football/32753043"
	"content_type": "news"
	"media_type": "image"
	"media_uri": "http://news.bbcimg.co.uk/media/images/83019000/jpg/_83019688_plbottomsix.jpg"
	"title": "Newcastle cancel 'inappropriate' end-of-season awards"
	"body": "Relegation-threatened Newcastle have cancelled an end-of-season awards night because of the position they are in" // ... up to around 100 words
	"markup": [
		{
			"children": [
				"Relegation-threatened",
				{ "children": [ "Newcastle" ], "key_term": true },
				" have cancelled an end-of-season awards night because of the position they are in"
			]
		{
		// ... this can be quite long, again to a total of around 100 words
	]
	"key_terms": "["
		"football", "Newcastle FC", "Relegation", "Premier League"
	]
}

Skims can be created via the GET https://api.skim.it/v1/skims end point.

URL Parameters:

  • uri - the target uri to turn into a skim, at present this must be a publicly accessible url.
Example:
curl -H "x-api-key: ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcd" https://api.skim.it/v1/skims?uri=http%3A%2F%2Fwww.bbc.co.uk%2Fsport%2F0%2Ffootball%2F32753043

This will return a JSON formatted response containing an object with an attribute skims which will be an array containing a single skim object as outlined above.

{
	skims: [
		{ "uri": "http://www.bbc.co.uk/sport/0/football/32753043", ... } // a skim object
	]
}

other resources

We plan to open up other sections of our API in the near future, such as separate extraction and summarisation functionality. If you have a particular use case or would just like to know more please email us for further information - we'd love to hear from you.