Get Prompts

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

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

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

	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/prompts")

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

{
  "prompts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "prompt": "How to optimize website performance",
      "status": "active",
      "country": "United States",
      "countries": [
        {
          "country": "United States",
          "is_primary": true
        },
        {
          "country": "Canada",
          "is_primary": false
        }
      ],
      "tags": [
        {
          "id": "223e4567-e89b-12d3-a456-426614174111",
          "name": "Caption Phones"
        }
      ],
      "topic_name": "Web Development",
      "current_monthly_searches": 5400,
      "current_total_value": 1250.5
    }
  ]
}

GET

api

prompts

Get Prompts

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

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

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

	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/prompts")

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

{
  "prompts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "prompt": "How to optimize website performance",
      "status": "active",
      "country": "United States",
      "countries": [
        {
          "country": "United States",
          "is_primary": true
        },
        {
          "country": "Canada",
          "is_primary": false
        }
      ],
      "tags": [
        {
          "id": "223e4567-e89b-12d3-a456-426614174111",
          "name": "Caption Phones"
        }
      ],
      "topic_name": "Web Development",
      "current_monthly_searches": 5400,
      "current_total_value": 1250.5
    }
  ]
}

Authorizations

x-api-key

string

header

required

API key for authentication. You can create one here.

Query Parameters

website_id

string<uuid>

required

The ID of the website to retrieve prompts for

status

enum<string>

Filter prompts by status. If omitted, returns both active and paused prompts.

Available options:

active,

paused

prompt_tags

string<uuid>[]

Filter prompts by tag. Pass one or more prompt tag IDs (UUIDs). When omitted, prompts are not filtered by tag. Combine with prompt_tags_operator to control how multiple tags are matched. All tag IDs must belong to the same website as website_id, otherwise the request is rejected with 403.

prompt_tags_operator

enum<string>

How to combine the prompt_tags filter. is_any_of (default) returns prompts carrying at least one of the given tags; has_all_of returns only prompts carrying every given tag. Ignored when prompt_tags is omitted.

Available options:

is_any_of,

has_all_of

Response

Successful response with list of prompts

prompts

object[]

required

Show child attributes

Overview

Integrations

Core Resources

Analytics

Content & Knowledge

Administration

Get Prompts

Authorizations

Query Parameters

Response