remy
remy

Ai Search Status Endpoint

Changed on

Poll one search: the reasoning steps so far, and the scored table once it is complete.

steps grows while the search runs — it is the "Show reasoning" panel, and the first step names what the brief was understood as, which is the only way to tell a misread brief from an empty roster (both render as an empty table).

candidate_count is exact up to 10,000 and capped beyond it, because an uncapped COUNT over a six-figure match set is a full scan on every search. account_health has THREE states — "unknown" means we never measured the account, not that it is dead. Pass page or size to paginate candidates; omitting both preserves the original full-list response.

get/api/v1/remy/ai-search/status/{job_id}

Request

  • Base URL
    https://api.brandbooster.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.brandbooster.ai/api/v1/remy/ai-search/status/{job_id}
  • Auth
    HTTP bearer

Path parameters

job_idstring required

Query parameters

pageinteger nullable

One-based result page; omit for the legacy full candidate list.

sizeinteger nullable

Candidates per page; defaults to 20 when page is provided.

more_offsetinteger nullable

Return the next pre-vetted batch past requested_count, from this offset.

more_sizeinteger nullable

Pre-vetted load-more batch size; defaults to 10 when more_offset is provided.

Response

Successful Response

job_idstring required
search_idstring nullable
statusstring required
stepsstring[]
errorstring nullable
started_atstring date-time nullable
finished_atstring date-time nullable
filtersobject nullable
ui_filtersobject nullable
confirm_filtersobject nullable
depthstring nullable
candidate_countinteger nullable
candidate_count_cappedboolean nullable
narrowed_countinteger nullable
requested_countinteger nullable
semantic_intentstring nullable
load_moreboolean
shortfallstring nullable
more_countinteger

Changes

    • info

      added the new optional query request parameter more_offset

    • info

      added the new optional query request parameter more_size

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status