Natural language query refinement by topic
POST/query/refine/:topicId
Refine the query of an existing saved search using a natural language prompt. The saved search is identified by its topic ID. A preview of up to 25 mentions matching the refined query is also included.
Request
Responses
- 200
- 400
- 401
- 405
- 415
- 500
- 502
- 504
The refined query and a preview of mentions that match it. The preview list will contain at most 25 mentions; if none are found expect an empty list.
The request failed validation and was not processed.
The credentials provided were invalid. This likely indicates an issue with the API key.
The HTTP method used is not supported for this endpoint.
The request Content-Type is not supported by this endpoint.
Response Headers
Media types accepted by this endpoint.
An internal server error occurred. This is a general case error. If this persists, please contact support.
An internal error occurred due to downstream calls. Failures from the query refinement agent are reported here with the QUERY_GENERATION_FAILED code.
A timeout occurred while processing the request