Validate API Key

Verify that an Outlit API key can authenticate Platform API requests

POST /api/validate-api-key

Validate API Key

cURL

curl --request POST \
  --url https://api.example.com/api/validate-api-key \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.example.com/api/validate-api-key"

headers = {"Authorization": "<authorization>"}

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

print(response.text)

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

fetch('https://api.example.com/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://api.example.com/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: <authorization>"
  ],
]);

$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://api.example.com/api/validate-api-key"

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

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/validate-api-key")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/validate-api-key")

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

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

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

200

{
  "valid": true,
  "organizationId": "<string>",
  "createdById": {}
}

Endpoint

POST https://app.outlit.ai/api/validate-api-key

Authentication

Authorization · string · required

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

Request Body

No request body is required when validating the API key from the Authorization header.

Example

curl -X POST https://app.outlit.ai/api/validate-api-key \
  -H "Authorization: Bearer ok_your_api_key"

Success Response

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

valid · boolean

Whether the supplied API key is active and accepted.

organizationId · string

Organization associated with the API key.

createdById · string | null

User that created the API key, when available.

Error Responses

Invalid or disabled keys return 401:

{
  "valid": false,
  "error": "Invalid credentials"
}

Malformed validation requests return 400. Server-side validation failures return 500.