Create Prompts

curl --request POST \
  --url https://api.athenahq.ai/api/v1/prompts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "website_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompts": [
    {
      "prompt": "best project management software",
      "type": "discovery",
      "volume": "1000",
      "current_monthly_searches": 5400,
      "current_total_value": 1250,
      "topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "countries": [
        "United States",
        "France"
      ],
      "primary_country": "United States",
      "persona_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "location_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "tag_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_paused": false
    }
  ]
}
'

import requests

url = "https://api.athenahq.ai/api/v1/prompts"

payload = {
    "website_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prompts": [
        {
            "prompt": "best project management software",
            "type": "discovery",
            "volume": "1000",
            "current_monthly_searches": 5400,
            "current_total_value": 1250,
            "topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "countries": ["United States", "France"],
            "primary_country": "United States",
            "persona_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "location_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "tag_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "is_paused": False
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    website_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    prompts: [
      {
        prompt: 'best project management software',
        type: 'discovery',
        volume: '1000',
        current_monthly_searches: 5400,
        current_total_value: 1250,
        topic_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        countries: ['United States', 'France'],
        primary_country: 'United States',
        persona_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        location_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        tag_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        is_paused: false
      }
    ]
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'website_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'prompts' => [
        [
                'prompt' => 'best project management software',
                'type' => 'discovery',
                'volume' => '1000',
                'current_monthly_searches' => 5400,
                'current_total_value' => 1250,
                'topic_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'countries' => [
                                'United States',
                                'France'
                ],
                'primary_country' => 'United States',
                'persona_ids' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'location_ids' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'tag_ids' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'is_paused' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.athenahq.ai/api/v1/prompts"

	payload := strings.NewReader("{\n  \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prompts\": [\n    {\n      \"prompt\": \"best project management software\",\n      \"type\": \"discovery\",\n      \"volume\": \"1000\",\n      \"current_monthly_searches\": 5400,\n      \"current_total_value\": 1250,\n      \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"countries\": [\n        \"United States\",\n        \"France\"\n      ],\n      \"primary_country\": \"United States\",\n      \"persona_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"location_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"tag_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"is_paused\": false\n    }\n  ]\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.athenahq.ai/api/v1/prompts")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prompts\": [\n    {\n      \"prompt\": \"best project management software\",\n      \"type\": \"discovery\",\n      \"volume\": \"1000\",\n      \"current_monthly_searches\": 5400,\n      \"current_total_value\": 1250,\n      \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"countries\": [\n        \"United States\",\n        \"France\"\n      ],\n      \"primary_country\": \"United States\",\n      \"persona_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"location_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"tag_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"is_paused\": false\n    }\n  ]\n}")
  .asString();

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::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prompts\": [\n    {\n      \"prompt\": \"best project management software\",\n      \"type\": \"discovery\",\n      \"volume\": \"1000\",\n      \"current_monthly_searches\": 5400,\n      \"current_total_value\": 1250,\n      \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"countries\": [\n        \"United States\",\n        \"France\"\n      ],\n      \"primary_country\": \"United States\",\n      \"persona_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"location_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"tag_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"is_paused\": false\n    }\n  ]\n}"

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

{
  "success": true,
  "count": 1,
  "prompt_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

POST

api

prompts

Create Prompts

curl --request POST \
  --url https://api.athenahq.ai/api/v1/prompts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "website_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompts": [
    {
      "prompt": "best project management software",
      "type": "discovery",
      "volume": "1000",
      "current_monthly_searches": 5400,
      "current_total_value": 1250,
      "topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "countries": [
        "United States",
        "France"
      ],
      "primary_country": "United States",
      "persona_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "location_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "tag_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_paused": false
    }
  ]
}
'

import requests

url = "https://api.athenahq.ai/api/v1/prompts"

payload = {
    "website_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prompts": [
        {
            "prompt": "best project management software",
            "type": "discovery",
            "volume": "1000",
            "current_monthly_searches": 5400,
            "current_total_value": 1250,
            "topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "countries": ["United States", "France"],
            "primary_country": "United States",
            "persona_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "location_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "tag_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "is_paused": False
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    website_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    prompts: [
      {
        prompt: 'best project management software',
        type: 'discovery',
        volume: '1000',
        current_monthly_searches: 5400,
        current_total_value: 1250,
        topic_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        countries: ['United States', 'France'],
        primary_country: 'United States',
        persona_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        location_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        tag_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        is_paused: false
      }
    ]
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'website_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'prompts' => [
        [
                'prompt' => 'best project management software',
                'type' => 'discovery',
                'volume' => '1000',
                'current_monthly_searches' => 5400,
                'current_total_value' => 1250,
                'topic_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'countries' => [
                                'United States',
                                'France'
                ],
                'primary_country' => 'United States',
                'persona_ids' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'location_ids' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'tag_ids' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'is_paused' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.athenahq.ai/api/v1/prompts"

	payload := strings.NewReader("{\n  \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prompts\": [\n    {\n      \"prompt\": \"best project management software\",\n      \"type\": \"discovery\",\n      \"volume\": \"1000\",\n      \"current_monthly_searches\": 5400,\n      \"current_total_value\": 1250,\n      \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"countries\": [\n        \"United States\",\n        \"France\"\n      ],\n      \"primary_country\": \"United States\",\n      \"persona_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"location_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"tag_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"is_paused\": false\n    }\n  ]\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.athenahq.ai/api/v1/prompts")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prompts\": [\n    {\n      \"prompt\": \"best project management software\",\n      \"type\": \"discovery\",\n      \"volume\": \"1000\",\n      \"current_monthly_searches\": 5400,\n      \"current_total_value\": 1250,\n      \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"countries\": [\n        \"United States\",\n        \"France\"\n      ],\n      \"primary_country\": \"United States\",\n      \"persona_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"location_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"tag_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"is_paused\": false\n    }\n  ]\n}")
  .asString();

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::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prompts\": [\n    {\n      \"prompt\": \"best project management software\",\n      \"type\": \"discovery\",\n      \"volume\": \"1000\",\n      \"current_monthly_searches\": 5400,\n      \"current_total_value\": 1250,\n      \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"countries\": [\n        \"United States\",\n        \"France\"\n      ],\n      \"primary_country\": \"United States\",\n      \"persona_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"location_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"tag_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"is_paused\": false\n    }\n  ]\n}"

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

{
  "success": true,
  "count": 1,
  "prompt_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

x-api-key

string

header

required

API key for authentication. You can create one here.

Body

application/json

website_id

string<uuid>

required

Website to create the prompts on.

prompts

object[]

required

Required array length: 1 - 1000 elements

Show child attributes

source

enum<string>

Attribution source (UI server action only; ignored for API-key callers).

Available options:

manual,

ai_generated,

bulk_upload

Response

Prompts created

success

boolean

required

Example:

true

count

integer

required

Example:

1

prompt_ids

string<uuid>[]

required

Overview

Integrations

Core Resources

Analytics

Content & Knowledge

Administration

Create Prompts

Authorizations

Body

Response