Check authentication

Confirms your API key is valid and returns the identity it resolves to.

GET/v1/ping

Try it

GEThttps://newsapi.insighthread.com/api/v1/ping

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Request

curl -X GET "https://newsapi.insighthread.com/api/v1/ping" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://newsapi.insighthread.com/api/v1/ping", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://newsapi.insighthread.com/api/v1/ping",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "ok": true,
  "message": "string",
  "client": {
    "id": "string",
    "label": "string",
    "prefix": "string"
  },
  "served_at": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "type": "unauthorized",
    "message": "string"
  }
}

Authorization

AuthorizationBearer token · headerrequired

An API key, e.g. `Authorization: Bearer ik_test_...` or `Authorization: Bearer ik_live_...`.

Responses

200Authenticated successfully.

okboolean

messagestring

clientobject

Show properties

idstring

labelstring

prefixstring

served_atstring<date-time>

401Missing, malformed, or revoked API key.

errorobject

Show properties

typestring

Allowed:unauthorizedinvalid_requestserver_error

messagestring