Get a research request

A research request's progress: whether its data check is still running or waits on the user's answers to its questions (status needs_answer), its report (what Ploti already has, with each dataset's id, what is missing, how much of the question the data covers), the data requests filed for the missing pieces and how far each has got, and once it is answered, the answer. When the data the question needs is in Ploti, run the analysis yourself with find_data and execute_python on those datasets, then record your answer with answer_research_request.

get/v1/research-requests/{id}

Request

  • Base URL: https://api.ploti.ai
  • URL: https://api.ploti.ai/v1/research-requests/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The research request, by the id create_research_request gave.

Response

Done

checkRunningboolean required
questionsTitlestring nullable required
answerstring nullable required
answeredBystring nullable required

The assistant that answered it; null when Ploti's own research run did.

completedAtstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.