A research run's state, report, and result list
A research run's full state. Poll it until status is completed, failed or cancelled (in-flight statuses: queued, planning, plan_review, running, generating_csv, uploading). prompt is the text the run was started with; spend shows the credits reserved, settled and the cap effort set; reportMarkdown is the markdown report (null until the run writes it); resultListId is the list holding the people or companies the research surfaced (null when none was created), readable with GET /business/lists/{listId}; errorCode explains a failed run and cancelRequestedAt is set once a cancel has been accepted. Rate limit: 30 requests per minute, 1000 per day.
Errors:
- 404 RESEARCH_RUN_NOT_FOUND — No research run with that id belongs to the token owner.
- 422 VALIDATION_FAILED — runId is not a 24-character hex id.
- 429 RATE_LIMITED — Per-user quota for this endpoint family exceeded (30 per minute, 1000 per day); retry after the Retry-After / RateLimit-Reset seconds.
Requires one of the following token scopes: research.
Request
- Base URL: https://api.tryfuse.ai/api/v1
- URL: https://api.tryfuse.ai/api/v1/business/research/runs/{runId}
- Auth: HTTP basic
Path parameters
The research run id (24-character hex), as returned in run.runId by POST /business/research/runs.
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.