Every request must be authenticated with your subscription key. This must be sent as an HTTP header:
Subscription-Key: YOUR_KEY_HERE
All requests must be sent with a JSON body and with a JSON content type header:
Content-Type: application/json
When a request to a path not in the API is made, you will get the following error message:
{
"message": "Not Found"
}
Returns recommendations of documents from the corpus that are similar to the given text.
| Name | Example | Description |
|---|---|---|
text(string, required)
|
The text to get recommendations for |
200
The recommendations, truncated
[
{
"id": "0000362a0b589c908fe01fd7bb302b6a",
"meta": {
"url": "http://en.wikipedia.org/wiki?curid=12566618",
"date": "2013-10-20",
"title": "Arc International",
"document_id": "wikipedia-12566618"
},
"similarity": 1
},
{
"id": "46951eff438212c9df72c303a27cff6b",
"meta": {
"url": "http://en.wikipedia.org/wiki?curid=3546083",
"date": "2013-10-20",
"title": "World Kitchen",
"document_id": "wikipedia-3546083"
},
"similarity": 0.8403602838999999
},
...
]
Returns recommendations of documents from the corpus that are similar to the given id.
200
The recommendations, truncated
[
{
"id": "0000362a0b589c908fe01fd7bb302b6a",
"meta": {
"url": "http://en.wikipedia.org/wiki?curid=12566618",
"date": "2013-10-20",
"title": "Arc International",
"document_id": "wikipedia-12566618"
},
"similarity": 1
},
{
"id": "46951eff438212c9df72c303a27cff6b",
"meta": {
"url": "http://en.wikipedia.org/wiki?curid=3546083",
"date": "2013-10-20",
"title": "World Kitchen",
"document_id": "wikipedia-3546083"
},
"similarity": 0.8403602838999999
},
...
]
404
Returned if the id is not found.
{ "message":"Couldn't find Document" }
Simply enter your details below and we'll email your API key to you!