curl --request POST \
--url https://api.peec.ai/customer/v1/actions/detail \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"action_id": "01a0422f-e0c4-7820-85a1-31515a321f15",
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
'import requests
url = "https://api.peec.ai/customer/v1/actions/detail"
payload = {
"action_id": "01a0422f-e0c4-7820-85a1-31515a321f15",
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
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({
action_id: '01a0422f-e0c4-7820-85a1-31515a321f15',
project_id: 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
})
};
fetch('https://api.peec.ai/customer/v1/actions/detail', 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.peec.ai/customer/v1/actions/detail",
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([
'action_id' => '01a0422f-e0c4-7820-85a1-31515a321f15',
'project_id' => 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
]),
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.peec.ai/customer/v1/actions/detail"
payload := strings.NewReader("{\n \"action_id\": \"01a0422f-e0c4-7820-85a1-31515a321f15\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\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.peec.ai/customer/v1/actions/detail")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action_id\": \"01a0422f-e0c4-7820-85a1-31515a321f15\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/actions/detail")
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 \"action_id\": \"01a0422f-e0c4-7820-85a1-31515a321f15\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "01a0422f-e0c4-7820-85a1-31515a321f15",
"type": "TEMPLATE_ACTION",
"status": "PENDING",
"title": "Add a pricing comparison table to the plans page",
"group": "OWNED",
"category": "EDITORIAL_PITCH",
"target": "owned",
"archetype": "HOMEPAGE",
"platform": "reddit.com",
"topic_id": "to_a1b2c3",
"source": "https://example.com/pricing",
"domain": "example.com",
"country_codes": [
"<string>"
],
"model_channel_ids": [
"openai-0"
],
"impact": "VERY_LOW",
"step_count": 123,
"completed_step_count": 123,
"created_at": "2026-08-20T10:12:00.000Z",
"status_updated_at": "<string>",
"created_by": "peec",
"priority": "none",
"assignee_user_id": "<string>",
"due_on": "2026-10-31",
"tag_ids": [
"<string>"
],
"description": {
"text": "<string>",
"sources": [
"<string>"
]
},
"kind": "CONTENT_OPTIMIZATION",
"notes": "<string>",
"page_url": "https://example.com/pricing",
"language_codes": [
"<string>"
],
"repeat": {
"every": 123,
"unit": "day"
},
"time_range": "7d",
"content_brief_outline": {
"title": "<string>",
"points": [
"<string>"
],
"brief": "<string>",
"summary": "<string>",
"overview": "<string>",
"h1_options": [
"<string>"
],
"meta_title": "<string>",
"meta_description": "<string>",
"usp": {
"spine": "<string>",
"proof_points": [
"<string>"
],
"never_write_terms": [
"<string>"
],
"register_lines": [
"<string>"
]
},
"brand_context": [
{
"label": "<string>",
"value": "<string>"
}
],
"language": {
"code": "de",
"name": "German"
},
"outline_points": [
{
"plan_index": 123,
"label": "<string>",
"direction": "<string>",
"angle": "<string>",
"questions": [
"<string>"
],
"bullets": [
"<string>"
],
"brand_grounding": "<string>",
"evidence": [
{
"kind": "winning_source",
"source": "<string>",
"text": "<string>"
}
]
}
]
},
"opportunity": {
"target_citation_count": 123,
"page_type": "HOMEPAGE",
"page_type_label": "<string>",
"topic_name": "<string>"
},
"steps": [
{
"id": "<string>",
"status": "PENDING",
"group_title": "<string>",
"gap_type": "community_phrases",
"options": [
{
"id": "<string>",
"label": "<string>",
"text": "<string>",
"score": 123,
"completed": true
}
]
}
],
"impacted_prompts": [
{
"prompt_id": "<string>",
"prompt_text": "<string>",
"own_coverage_score": 123,
"source_coverage_score": 123
}
],
"ngrams": [
{
"gram": "<string>",
"count": 123
}
]
}
}{
"message": "<string>"
}Get Action
One action in full: what to do, the fields the customer owns on it — notes, priority, assignee, due date, tags and repeat — the steps to work through, the content brief when there is one with its sections, the competitor demand behind it, the prompts it affects and the terms competitors use on the topic. A site audit action carries no brief and no opportunity, and its description and steps are the whole fix. An id this project has no published action for is a 404, whether it belongs to another project, to an action type this API does not publish for the project, or to nothing at all. A content optimisation carries its article, suggestions and score on the optimize content endpoint instead.
curl --request POST \
--url https://api.peec.ai/customer/v1/actions/detail \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"action_id": "01a0422f-e0c4-7820-85a1-31515a321f15",
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
'import requests
url = "https://api.peec.ai/customer/v1/actions/detail"
payload = {
"action_id": "01a0422f-e0c4-7820-85a1-31515a321f15",
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
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({
action_id: '01a0422f-e0c4-7820-85a1-31515a321f15',
project_id: 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
})
};
fetch('https://api.peec.ai/customer/v1/actions/detail', 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.peec.ai/customer/v1/actions/detail",
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([
'action_id' => '01a0422f-e0c4-7820-85a1-31515a321f15',
'project_id' => 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
]),
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.peec.ai/customer/v1/actions/detail"
payload := strings.NewReader("{\n \"action_id\": \"01a0422f-e0c4-7820-85a1-31515a321f15\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\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.peec.ai/customer/v1/actions/detail")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action_id\": \"01a0422f-e0c4-7820-85a1-31515a321f15\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/actions/detail")
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 \"action_id\": \"01a0422f-e0c4-7820-85a1-31515a321f15\",\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "01a0422f-e0c4-7820-85a1-31515a321f15",
"type": "TEMPLATE_ACTION",
"status": "PENDING",
"title": "Add a pricing comparison table to the plans page",
"group": "OWNED",
"category": "EDITORIAL_PITCH",
"target": "owned",
"archetype": "HOMEPAGE",
"platform": "reddit.com",
"topic_id": "to_a1b2c3",
"source": "https://example.com/pricing",
"domain": "example.com",
"country_codes": [
"<string>"
],
"model_channel_ids": [
"openai-0"
],
"impact": "VERY_LOW",
"step_count": 123,
"completed_step_count": 123,
"created_at": "2026-08-20T10:12:00.000Z",
"status_updated_at": "<string>",
"created_by": "peec",
"priority": "none",
"assignee_user_id": "<string>",
"due_on": "2026-10-31",
"tag_ids": [
"<string>"
],
"description": {
"text": "<string>",
"sources": [
"<string>"
]
},
"kind": "CONTENT_OPTIMIZATION",
"notes": "<string>",
"page_url": "https://example.com/pricing",
"language_codes": [
"<string>"
],
"repeat": {
"every": 123,
"unit": "day"
},
"time_range": "7d",
"content_brief_outline": {
"title": "<string>",
"points": [
"<string>"
],
"brief": "<string>",
"summary": "<string>",
"overview": "<string>",
"h1_options": [
"<string>"
],
"meta_title": "<string>",
"meta_description": "<string>",
"usp": {
"spine": "<string>",
"proof_points": [
"<string>"
],
"never_write_terms": [
"<string>"
],
"register_lines": [
"<string>"
]
},
"brand_context": [
{
"label": "<string>",
"value": "<string>"
}
],
"language": {
"code": "de",
"name": "German"
},
"outline_points": [
{
"plan_index": 123,
"label": "<string>",
"direction": "<string>",
"angle": "<string>",
"questions": [
"<string>"
],
"bullets": [
"<string>"
],
"brand_grounding": "<string>",
"evidence": [
{
"kind": "winning_source",
"source": "<string>",
"text": "<string>"
}
]
}
]
},
"opportunity": {
"target_citation_count": 123,
"page_type": "HOMEPAGE",
"page_type_label": "<string>",
"topic_name": "<string>"
},
"steps": [
{
"id": "<string>",
"status": "PENDING",
"group_title": "<string>",
"gap_type": "community_phrases",
"options": [
{
"id": "<string>",
"label": "<string>",
"text": "<string>",
"score": 123,
"completed": true
}
]
}
],
"impacted_prompts": [
{
"prompt_id": "<string>",
"prompt_text": "<string>",
"own_coverage_score": 123,
"source_coverage_score": 123
}
],
"ngrams": [
{
"gram": "<string>",
"count": 123
}
]
}
}{
"message": "<string>"
}Authorizations
Body
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"01a0422f-e0c4-7820-85a1-31515a321f15"
Required if using a company api key
"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
Response
Success
Success
Show child attributes
Show child attributes
