Prompts

Create, list, retrieve, update, and delete Visibility prompts from the Sapient CLI.

Prompt commands cover the public Visibility prompt workflows exposed by the Sapient CLI. Use them to create prompt batches, retrieve prompt configuration, and manage individual prompts.

Use Topics to manage prompt topics. Use Actions to list prompt actionables, cited pages, and opportunities.

Commands

Command	Description
sapient prompts list	List Visibility prompts.
sapient prompts create	Create one or more Visibility prompts.
sapient prompts config retrieve	Retrieve available topics, platforms, languages, regions, and defaults.
sapient prompts retrieve --prompt-id <prompt_id>	Retrieve one prompt.
sapient prompts update --prompt-id <prompt_id>	Update one prompt.
sapient prompts delete --prompt-id <prompt_id>	Delete one prompt.

Retrieve prompt config

Retrieve the current prompt setup values:

sapient prompts config retrieve

The response includes topics, platforms, languages, regions, and defaults. Use these IDs when creating prompts.

List prompts

sapient prompts list --output-format table

Filter by topic, status, or active state:

sapient prompts list \
  --topic-id topic_123 \
  --status active \
  --is-active true

Include archived prompts:

sapient prompts list --include-archived

Create prompts

Create multiple Visibility prompts in one request:

sapient prompts create \
  --prompts '[{"text":"What is the best API for crawling websites?","topic_id":"topic_123","platform_ids":["chatgpt"]},{"text":"Which API should I use to extract structured data from a webpage?","topic_id":"topic_123","platform_ids":["chatgpt"]}]'

The --prompts value is a JSON array. Each prompt object requires text and topic_id. Include platform_ids to choose tracked AI platforms.

Example response:

{
  "created": [
    {
      "id": "prompt_123",
      "topic_id": "topic_123",
      "text": "What is the best API for crawling websites?",
      "is_active": true,
      "status": "active"
    }
  ],
  "count": 1,
  "errors": []
}

Retrieve, update, and delete prompts

Retrieve one prompt:

sapient prompts retrieve --prompt-id prompt_123

Update prompt text, topic, platforms, or active state:

sapient prompts update --prompt-id prompt_123 \
  --text '"What is the best web crawling API for Node.js?"' \
  --is-active true

Delete one prompt:

sapient prompts delete --prompt-id prompt_123