Get Brand Facts

curl --request GET \
  --url https://api.athenahq.ai/api/v1/knowledge-base/facts \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.athenahq.ai/api/v1/knowledge-base/facts', 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.athenahq.ai/api/v1/knowledge-base/facts",
  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.athenahq.ai/api/v1/knowledge-base/facts"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.athenahq.ai/api/v1/knowledge-base/facts")

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

{
  "facts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "text": "<string>",
      "status": "approved",
      "confidence": "high",
      "source_url": "<string>",
      "source_quote": "<string>",
      "source_type": "research",
      "pillar": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "created_at": "<string>"
    }
  ],
  "total": 123
}

GET

api

knowledge-base

facts

Get Brand Facts

curl --request GET \
  --url https://api.athenahq.ai/api/v1/knowledge-base/facts \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.athenahq.ai/api/v1/knowledge-base/facts', 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.athenahq.ai/api/v1/knowledge-base/facts",
  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.athenahq.ai/api/v1/knowledge-base/facts"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.athenahq.ai/api/v1/knowledge-base/facts")

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

{
  "facts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "text": "<string>",
      "status": "approved",
      "confidence": "high",
      "source_url": "<string>",
      "source_quote": "<string>",
      "source_type": "research",
      "pillar": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "created_at": "<string>"
    }
  ],
  "total": 123
}

Authorizations

x-api-key

string

header

required

API key for authentication. You can create one here.

Query Parameters

website_id

string<uuid>

required

The website whose Knowledge Base to read.

pillar_id

string<uuid>

Only facts filed under this pillar.

status

enum<string>

default:approved

Review-status bucket to list.

Available options:

approved,

pending,

rejected

source_type

enum<string>

Only facts that entered through this source.

Available options:

research,

response,

upload,

content_hub

unfiled

enum<string>

When "true", only facts not filed under any published pillar. Mutually exclusive with pillar_id.

Available options:

true,

false

include_oracle

enum<string>

When "true", facts generated by Oracle analysis are included in the listing. Defaults to "false" (excluded).

Available options:

true,

false

limit

integer

default:50

Page size.

Required range: 1 <= x <= 200

offset

integer

default:0

Rows to skip.

Required range: x >= 0

Response

Successful response with one page of facts and the uncapped total

facts

object[]

required

Show child attributes

total

integer

required

Total facts matching the filters, ignoring paging.

Overview

Integrations

Core Resources

Analytics

Content & Knowledge

Administration

Get Brand Facts

Authorizations

Query Parameters

Response