Create auth token

Verifies an API key and returns a short-lived bearer token.

POST /api/v1/auth/token

Create JWT from API key

cURL

curl --request POST \
  --url http://127.0.0.1:4000/api/v1/auth/token \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiKey": "<string>",
  "agentId": "<string>"
}
'

import requests

url = "http://127.0.0.1:4000/api/v1/auth/token"

payload = {
    "apiKey": "<string>",
    "agentId": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({apiKey: '<string>', agentId: '<string>'})
};

fetch('http://127.0.0.1:4000/api/v1/auth/token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4000",
  CURLOPT_URL => "http://127.0.0.1:4000/api/v1/auth/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'apiKey' => '<string>',
    'agentId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://127.0.0.1:4000/api/v1/auth/token"

	payload := strings.NewReader("{\n  \"apiKey\": \"<string>\",\n  \"agentId\": \"<string>\"\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://127.0.0.1:4000/api/v1/auth/token")
  .header("Content-Type", "application/json")
  .body("{\n  \"apiKey\": \"<string>\",\n  \"agentId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:4000/api/v1/auth/token")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"apiKey\": \"<string>\",\n  \"agentId\": \"<string>\"\n}"

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

200

{
  "token": "<string>",
  "tokenType": "Bearer",
  "apiKeyId": "<string>"
}

{
  "statusCode": 123,
  "code": "<string>",
  "message": "<string>"
}

Body

application/json

apiKey · string · required

Minimum string length: 1

agentId · string

Minimum string length: 1

Response

200

application/json

Token created

token · string · required

tokenType · enum<string> · required

Available options: Bearer

apiKeyId · string · required

level · enum<string> · required

Available options: L0, L1, L2