Recommendations

Complete, archive or restore a recommendation item

Changed on

Moves one item of a recommendation run between active, completed and archived, exactly like the complete, archive and restore buttons on the Recommendations page, and stamps status_changed_at. When archiving, an optional reason teaches later runs: not_relevant and too_complex steer the next recommendations away from similar ones, and on a PR & Citation Building item that targets a domain (metadata.domain), competitor or not_relevant stops that site from being suggested again. The reason is stored in metadata.archive_reason and dropped when the item leaves archived. A reason with another status, an unknown one, or competitor on an item without a domain returns ERR_INVALID_PARAM. Returns the item in the shape GET /recommendations/{id} lists items. Requires a read_write scope API key and, for team members, create permission on Recommendations (the permission the page uses for these buttons).

patch/recommendations/{id}/items/{item_id}

Request

  • Base URL
    https://api.llmpulse.ai/api/v1
  • URL
    https://api.llmpulse.ai/api/v1/recommendations/{id}/items/{item_id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Recommendation run id

item_idinteger required

Item id, from the items of GET /recommendations/{id}

Request body

project_idinteger required
status'active' | 'completed' | 'archived' required

completed, archived, or active to restore the item

reason'not_relevant' | 'too_complex' | 'competitor'

Optional, with status archived only. competitor only on a PR & Citation Building item that targets a domain.

Response

The updated item

project_idinteger required
request_idstring required

Changes