Read prompts

GET /prompts/. Required scopes: prompts:read.

GET /api/public/v1/prompts/{resource_id}

Read prompts

cURL

curl --request GET \
  --url https://wisepim.com/api/public/v1/prompts/{resource_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "title": "<string>",
  "description": "<string>",
  "prompt_type": "<string>",
  "enrich_type": "<string>",
  "prompt_text": "<string>",
  "tone_of_voice": "<string>",
  "custom_tone": "<string>",
  "purpose": "<string>",
  "industry": "<string>",
  "point_of_view": "<string>",
  "include_spec_table": true,
  "title_max_length": 123,
  "title_variants": 123,
  "title_include_brand": true,
  "target_size": "<string>",
  "target_word_count": 123,
  "faq_types": "<unknown>",
  "faq_max_questions": 123,
  "faq_use_web_research": true,
  "target_attribute_codes": "<unknown>",
  "share_with_project": true,
  "id": 123
}

Authorizations

Authorization · string · header · required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Path Parameters

resource_id · integer · required

Response

200

application/json

OK

title · string · required

Maximum string length: 255

description · string · required

Brief description of what this prompt does

prompt_type · string · required

Maximum string length: 50

enrich_type · string | null · required

Maximum string length: 100

prompt_text · string · required

tone_of_voice · string | null · required

Maximum string length: 50

custom_tone · string | null · required

Maximum string length: 255

purpose · string | null · required

Maximum string length: 50

industry · string | null · required

Maximum string length: 50

point_of_view · string | null · required

Maximum string length: 50

include_spec_table · boolean · required

title_max_length · integer · required

Max character length for generated titles (titles enrichment only).

title_variants · integer · required

How many distinct title variants to generate per product (titles enrichment only).

title_include_brand · boolean · required

Include the brand name in generated titles when known (titles enrichment only).

target_size · string · required

Length preset for description / short_description enrichment.

Maximum string length: 20

target_word_count · integer | null · required

Explicit word target, used when target_size is 'custom'.

faq_types · any · required

FAQ type keys (products/services/faq_types.py); empty uses the industry defaults.

faq_max_questions · integer | null · required

Maximum FAQ items per product, 1 to 20 (faq enrichment only).

faq_use_web_research · boolean | null · required

Ground FAQ answers in the latest web research (faq enrichment only).

target_attribute_codes · any · required

Attribute codes a product_attributes prompt fills; empty fills every AI-enrichable attribute.

share_with_project · boolean · required

When true, other members of the prompt's project can see and use this prompt.

id · integer · required