API

GET /v1/text

Request

There are no request parameters for this endpoint.

Response

A JSON object with a random message of love and encouragement, advertising things that people likely already possess.

PropertyDescription
textThe text content of the message.
attribution(Optional) The attribution of the text, if any.
Example
$ curl https://api.kindspeech.org/v1/text

{
  "text": "Some people believe holding on and hanging in there are signs of great strength. However, there are times when it takes much more strength to know when to let go and then do it.",
  "attribution": "Ann Landers"
}

GET /v1/badge

Request

There are no request parameters for this endpoint.

Response

A badge (SVG image) displaying the Kind Speech logo and a random, short message of love and encouragement:

Many thanks to the excellent shields.io badge service on top of which this is built.

HTML USAGE
<img src="https://api.kindspeech.org/v1/badge" />
Markdown USAGE
![](https://api.kindspeech.org/v1/badge)

Errors

Response

If a request fails then a JSON error message will be returned.

PropertyDescription
statusThe HTTP status code.
errorA short description of the error.
Example
$ curl https://api.kindspeech.org/invalid

{
  "status": 404,
  "error": "Not Found"
}