Skip to main content
GET
Get an action

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

id
string
required
Example:

"6b3c1f2e-9d4a-4a7e-b2c1-5f0e8a7d3c94"

type
enum<string>
required

What kind of work this is.

Available options:
write_article,
update_article,
earn_link,
get_cited,
reply_thread,
record_video,
track_competitor,
add_prompt,
publish_article,
request_indexing,
other
Example:

"write_article"

title
string
required
Example:

"How to Start a Blog in 2024"

status
enum<string>
required

new: not started · in_progress: an executor is running · processed: finished. Same vocabulary as backlinks, citations and people-also-ask, with the extra middle state only actions can have.

Available options:
new,
in_progress,
processed
Example:

"new"

fanoutQueries
object[]
required

The fanout searches themselves, on the article types. Provenance rather than a target: they are what justified the work, not where it happens. A set, because engines phrase one intent many ways.

keywords
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
slug
string | null
Example:

"how-to-start-a-blog"

shortDescription
string | null

The one line shown under the title in a list. Null on actions created before this field existed.

Example:

"Cited in 6 ChatGPT answers — you are in none."

description
string | null

The fuller explanation, shown when the action is opened. On write_article this is the brief handed to the generator instead.

Example:

"A comprehensive guide for beginners."

additionalInstructions
string | null
Example:

"Focus on WordPress."

completedAt
string | null

When the work finished.

categoryId
string | null
Example:

"6b3c1f2e-9d4a-4a7e-b2c1-5f0e8a7d3c94"

articleId
string | null

The article this action produced (write_article) or edits (update_article).

Example:

"6b3c1f2e-9d4a-4a7e-b2c1-5f0e8a7d3c94"

citationId
string | null

The cited page or thread, on get_cited and reply_thread. Null once the citation itself is gone, which does not remove the action.

Example:

"6b3c1f2e-9d4a-4a7e-b2c1-5f0e8a7d3c94"

The referring domain to go after, on earn_link.

Example:

"6b3c1f2e-9d4a-4a7e-b2c1-5f0e8a7d3c94"

competitorId
string | null

The brand to start tracking, on track_competitor.

Example:

"6b3c1f2e-9d4a-4a7e-b2c1-5f0e8a7d3c94"

citation
object | null

The cited page itself, on get_cited and reply_thread. Carries the url to open and the citation count the reason is built from.

The referring domain itself, on earn_link. urlFrom is the page carrying the competitor link.

competitor
object | null

The brand itself, on track_competitor.