Citera home
Browse documentation

Recommendations

Recommendations

List and inspect content recommendations.

Summarize with AIChatGPTClaudePerplexity

GET /v1/brands/{brand_id}/recommendations

Union of content topics (action_recommendations) and legacy page optimizations (cms_page_recommendations), newest first.

Query

Values

type

content_topic | page_optimization

status

lowercase token, e.g. pending, completed

priority

high | medium | low

limit, cursor

keyset

The current Website engine's versioned change sets are a different resource (/website/changes).

GET /v1/brands/{brand_id}/recommendations/{recommendation_id}

Adds topic (category, article type, generation status, target/gap query) or page (field, label, current text, suggested text, reasoning).

Request examples

Choose a language for each endpoint. Set your assigned HTTPS API origin and environment variables, then replace the <placeholders>. These examples do not run requests in your browser.

GET/v1/brands/{brand_id}/recommendations

Required scope: recommendations:read · Response: 200

: "${CITERA_API_BASE_URL:?Set CITERA_API_BASE_URL}"
: "${CITERA_API_KEY:?Set CITERA_API_KEY}"
: "${BRAND_ID:?Set BRAND_ID}"
curl --fail-with-body --connect-timeout 10 --max-time 30 -X GET "${CITERA_API_BASE_URL%/}/v1/brands/${BRAND_ID}/recommendations" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${CITERA_API_KEY}"
GET/v1/brands/{brand_id}/recommendations/{recommendation_id}

Required scope: recommendations:read · Response: 200

: "${CITERA_API_BASE_URL:?Set CITERA_API_BASE_URL}"
: "${CITERA_API_KEY:?Set CITERA_API_KEY}"
: "${BRAND_ID:?Set BRAND_ID}"
: "${RECOMMENDATION_ID:?Set RECOMMENDATION_ID}"
curl --fail-with-body --connect-timeout 10 --max-time 30 -X GET "${CITERA_API_BASE_URL%/}/v1/brands/${BRAND_ID}/recommendations/${RECOMMENDATION_ID}" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${CITERA_API_KEY}"