Issue scoped API key
curl --request POST \
--url https://api.foreverbetter.xyz/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"user_id": "<string>",
"organization_id": "<string>",
"tier": "free",
"intended_use": "personal_agent",
"scopes": [],
"enabled_endpoints": [
"<string>"
],
"expires_in_days": 365
}
'import requests
url = "https://api.foreverbetter.xyz/api-keys"
payload = {
"name": "<string>",
"user_id": "<string>",
"organization_id": "<string>",
"tier": "free",
"intended_use": "personal_agent",
"scopes": [],
"enabled_endpoints": ["<string>"],
"expires_in_days": 365
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
user_id: '<string>',
organization_id: '<string>',
tier: 'free',
intended_use: 'personal_agent',
scopes: [],
enabled_endpoints: ['<string>'],
expires_in_days: 365
})
};
fetch('https://api.foreverbetter.xyz/api-keys', 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.foreverbetter.xyz/api-keys",
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([
'name' => '<string>',
'user_id' => '<string>',
'organization_id' => '<string>',
'tier' => 'free',
'intended_use' => 'personal_agent',
'scopes' => [
],
'enabled_endpoints' => [
'<string>'
],
'expires_in_days' => 365
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://api.foreverbetter.xyz/api-keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tier\": \"free\",\n \"intended_use\": \"personal_agent\",\n \"scopes\": [],\n \"enabled_endpoints\": [\n \"<string>\"\n ],\n \"expires_in_days\": 365\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("https://api.foreverbetter.xyz/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tier\": \"free\",\n \"intended_use\": \"personal_agent\",\n \"scopes\": [],\n \"enabled_endpoints\": [\n \"<string>\"\n ],\n \"expires_in_days\": 365\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.foreverbetter.xyz/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tier\": \"free\",\n \"intended_use\": \"personal_agent\",\n \"scopes\": [],\n \"enabled_endpoints\": [\n \"<string>\"\n ],\n \"expires_in_days\": 365\n}"
response = http.request(request)
puts response.read_bodyAPI Reference
Issue scoped API key
Issue a scoped bearer API key for an authenticated user or organization.
POST
/
api-keys
Issue scoped API key
curl --request POST \
--url https://api.foreverbetter.xyz/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"user_id": "<string>",
"organization_id": "<string>",
"tier": "free",
"intended_use": "personal_agent",
"scopes": [],
"enabled_endpoints": [
"<string>"
],
"expires_in_days": 365
}
'import requests
url = "https://api.foreverbetter.xyz/api-keys"
payload = {
"name": "<string>",
"user_id": "<string>",
"organization_id": "<string>",
"tier": "free",
"intended_use": "personal_agent",
"scopes": [],
"enabled_endpoints": ["<string>"],
"expires_in_days": 365
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
user_id: '<string>',
organization_id: '<string>',
tier: 'free',
intended_use: 'personal_agent',
scopes: [],
enabled_endpoints: ['<string>'],
expires_in_days: 365
})
};
fetch('https://api.foreverbetter.xyz/api-keys', 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.foreverbetter.xyz/api-keys",
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([
'name' => '<string>',
'user_id' => '<string>',
'organization_id' => '<string>',
'tier' => 'free',
'intended_use' => 'personal_agent',
'scopes' => [
],
'enabled_endpoints' => [
'<string>'
],
'expires_in_days' => 365
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://api.foreverbetter.xyz/api-keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tier\": \"free\",\n \"intended_use\": \"personal_agent\",\n \"scopes\": [],\n \"enabled_endpoints\": [\n \"<string>\"\n ],\n \"expires_in_days\": 365\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("https://api.foreverbetter.xyz/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tier\": \"free\",\n \"intended_use\": \"personal_agent\",\n \"scopes\": [],\n \"enabled_endpoints\": [\n \"<string>\"\n ],\n \"expires_in_days\": 365\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.foreverbetter.xyz/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"user_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tier\": \"free\",\n \"intended_use\": \"personal_agent\",\n \"scopes\": [],\n \"enabled_endpoints\": [\n \"<string>\"\n ],\n \"expires_in_days\": 365\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Display name for the key.
Minimum string length:
1Minimum string length:
1free is self-serve for personal use. Paid tiers require an admin token.
Available options:
free, builder, growth, enterprise personal_agent keys act for one person. Products serving other users need app_platform_service on the builder tier or higher.
Available options:
personal_agent, app_platform_service Defaults to the standard personal grant set when omitted.
Available options:
health:data:read, health:data:write, health:connections:write, health:labs:read, health:admin Defaults to the standard personal endpoint grants when omitted.
Required range:
1 <= x <= 730Response
Created
⌘I