Validate API key

Verify that the API key in the Authorization header can authenticate Platform API requests.

POST /api/validate-api-key

Validate API key

cURL

curl --request POST \
  --url https://app.outlit.ai/api/validate-api-key \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.outlit.ai/api/validate-api-key"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.outlit.ai/api/validate-api-key', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.outlit.ai/api/validate-api-key",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.outlit.ai/api/validate-api-key"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.outlit.ai/api/validate-api-key")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.outlit.ai/api/validate-api-key")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "valid": true,
  "organizationId": "org_123",
  "createdById": "user_123"
}

{
  "error": "Invalid request"
}

{
  "error": "Invalid credentials"
}

{
  "error": "Internal server error"
}

Authorizations

Authorization · string · header · required

Outlit API key using the Bearer ok_... format.

Response

200

application/json

The API key is valid.

valid · boolean · required

organizationId · string · required

createdById · string | null