Health Check

curl --request GET \
  --url https://api.buena.ai/api/v2/health \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.buena.ai/api/v2/health"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.buena.ai/api/v2/health', 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.buena.ai/api/v2/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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.buena.ai/api/v2/health"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.buena.ai/api/v2/health")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.buena.ai/api/v2/health")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "version": "2.0",
  "status": "healthy",
  "authentication": "user",
  "user": {
    "id": "user_abc123",
    "email": "john@company.com",
    "role": "Premium"
  },
  "apiKey": {
    "name": "My Integration Key",
    "permissions": [
      "linkedin:schedule",
      "linkedin:upload",
      "leads:read",
      "leads:write"
    ],
    "usageCount": 150
  },
  "timestamp": "2024-01-20T15:30:00Z"
}

GET

api

health

Health Check

curl --request GET \
  --url https://api.buena.ai/api/v2/health \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.buena.ai/api/v2/health"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.buena.ai/api/v2/health', 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.buena.ai/api/v2/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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.buena.ai/api/v2/health"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.buena.ai/api/v2/health")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.buena.ai/api/v2/health")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "version": "2.0",
  "status": "healthy",
  "authentication": "user",
  "user": {
    "id": "user_abc123",
    "email": "john@company.com",
    "role": "Premium"
  },
  "apiKey": {
    "name": "My Integration Key",
    "permissions": [
      "linkedin:schedule",
      "linkedin:upload",
      "leads:read",
      "leads:write"
    ],
    "usageCount": 150
  },
  "timestamp": "2024-01-20T15:30:00Z"
}

The health endpoint provides a quick way to verify that:

The API is operational
Your API key is valid
Your authentication is working properly

This is typically the first endpoint you should test when integrating with the Buena.ai API.

This endpoint does not require any specific permissions and does not count heavily against rate limits.

Request

x-api-key

string

required

Your API key for authentication

curl -X GET "https://api.buena.ai/api/v2/health" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch("https://api.buena.ai/api/v2/health", {
  headers: {
    "x-api-key": "YOUR_API_KEY",
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    'https://api.buena.ai/api/v2/health',
    headers={'x-api-key': 'YOUR_API_KEY'}
)

data = response.json()
print(data)

<?php
$response = file_get_contents('https://api.buena.ai/api/v2/health', false, stream_context_create([
    'http' => [
        'method' => 'GET',
        'header' => 'x-api-key: YOUR_API_KEY'
    ]
]));

$data = json_decode($response, true);
print_r($data);
?>

Response

version

string

Current API version (e.g., “2.0”)

status

string

API health status (“healthy” or “degraded”)

authentication

string

Authentication type (“user” for valid API key)

user

object

Information about the authenticated user

Show User Properties

string

Unique user identifier

string

User’s email address

role

string

User’s subscription role (e.g., “Premium”, “Basic”)

apiKey

object

Information about the API key used

Show API Key Properties

name

string

Human-readable name of the API key

permissions

array

List of permissions granted to this API key

usageCount

number

Total number of requests made with this key

timestamp

string

ISO 8601 timestamp of the response

{
  "version": "2.0",
  "status": "healthy",
  "authentication": "user",
  "user": {
    "id": "user_abc123",
    "email": "john@company.com",
    "role": "Premium"
  },
  "apiKey": {
    "name": "My Integration Key",
    "permissions": [
      "linkedin:schedule",
      "linkedin:upload",
      "leads:read",
      "leads:write"
    ],
    "usageCount": 150
  },
  "timestamp": "2024-01-20T15:30:00Z"
}

Use Cases

1. Integration Testing

Use the health endpoint to verify your integration setup:

async function verifySetup() {
  try {
    const response = await fetch("https://api.buena.ai/api/v2/health", {
      headers: { "x-api-key": process.env.BUENA_API_KEY },
    });

    if (response.ok) {
      const data = await response.json();
      console.log("✅ API integration working");
      console.log("📝 Permissions:", data.apiKey.permissions);
      return true;
    } else {
      console.error("❌ API integration failed");
      return false;
    }
  } catch (error) {
    console.error("❌ Connection failed:", error.message);
    return false;
  }
}

2. Permission Verification

Check if your API key has the required permissions:

def check_permissions(required_permissions):
    response = requests.get(
        'https://api.buena.ai/api/v2/health',
        headers={'x-api-key': os.getenv('BUENA_API_KEY')}
    )

    if response.status_code == 200:
        data = response.json()
        available = set(data['apiKey']['permissions'])
        required = set(required_permissions)

        if required.issubset(available):
            print("✅ All required permissions available")
            return True
        else:
            missing = required - available
            print(f"❌ Missing permissions: {missing}")
            return False
    else:
        print("❌ Health check failed")
        return False

# Example usage
check_permissions(['linkedin:schedule', 'leads:write'])

3. Monitoring and Alerting

Use for uptime monitoring and health checks:

#!/bin/bash
# health-check.sh - Simple monitoring script

RESPONSE=$(curl -s -w "%{http_code}" -H "x-api-key: $BUENA_API_KEY" \
  https://api.buena.ai/api/v2/health)

HTTP_CODE="${RESPONSE: -3}"
BODY="${RESPONSE%???}"

if [ "$HTTP_CODE" -eq 200 ]; then
  STATUS=$(echo "$BODY" | jq -r '.status')
  if [ "$STATUS" = "healthy" ]; then
    echo "✅ API is healthy"
    exit 0
  else
    echo "⚠️ API status: $STATUS"
    exit 1
  fi
else
  echo "❌ API health check failed: HTTP $HTTP_CODE"
  exit 2
fi

Error Responses

Invalid API Key (401)

{
  "error": true,
  "code": "UNAUTHORIZED",
  "message": "Invalid API key",
  "version": "2.0",
  "timestamp": "2024-01-20T15:30:00Z"
}

Rate Limited (429)

{
  "error": true,
  "code": "RATE_LIMIT_EXCEEDED",
  "message": "Rate limit exceeded. Try again in 30 seconds.",
  "version": "2.0",
  "timestamp": "2024-01-20T15:30:00Z",
  "retryAfter": 30
}

Service Issues (5xx)

{
  "error": true,
  "code": "SERVICE_UNAVAILABLE",
  "message": "Service temporarily unavailable",
  "version": "2.0",
  "timestamp": "2024-01-20T15:30:00Z"
}

Status Indicators

The status field in the response can be:

Status	Description	Action
`healthy`	All systems operational	Continue normal operations
`degraded`	Partial functionality	Monitor closely, some features may be slower
`maintenance`	Scheduled maintenance	Retry after maintenance window

Pro Tip: Set up automated health checks in your monitoring system to detect API issues early. We recommend checking every 5-10 minutes for production applications.

Next Steps

Once your health check passes:

Create API Keys

Generate additional API keys for your team

Schedule LinkedIn Actions

Start automating LinkedIn outreach

Manage Leads

Work with your lead database

Check Rate Limits

Understand API usage limits

API Reference Create API Key

​Request

​Response

​Use Cases

​1. Integration Testing

​2. Permission Verification

​3. Monitoring and Alerting

​Error Responses

​Invalid API Key (401)

​Rate Limited (429)

​Service Issues (5xx)

​Status Indicators

​Next Steps

Create API Keys

Schedule LinkedIn Actions

Manage Leads

Check Rate Limits

Request

Response

Use Cases

1. Integration Testing

2. Permission Verification

3. Monitoring and Alerting

Error Responses

Invalid API Key (401)

Rate Limited (429)

Service Issues (5xx)

Status Indicators

Next Steps