Skip to main content
GET
https://app.firmware.ai
/
api
/
v1
/
research
/
{id}
Get deep research
curl --request GET \
  --url https://app.firmware.ai/api/v1/research/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "title": "Researching...",
  "topic": "What are the latest advancements in quantum computing?",
  "report": ""
}
Check the status of a deep research job and get the final report when it’s ready. Poll this endpoint every few seconds until status is succeeded or failed. Deep research typically takes 2-5 minutes.

​
Authenticate

Use an API key in the Authorization header. 
curl https://app.firmware.ai/api/v1/research/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer $FIRMWARE_API_KEY"

​
Path parameters

​
id
string
required
The research ID returned from the create endpoint.

​
Response

​
id
string
Unique identifier for the research job.
​
status
string
Current status of the research job.
StatusDescription
queuedJob is waiting to be processed
runningResearch is in progress
succeededResearch completed successfully
failedResearch encountered an error
​
title
string
Title of the research report. Available once research completes.
​
topic
string
The original topic that was researched.
​
report
string
The full markdown research report with sources. Empty string until research completes.
​
error
string
Error message if status is failed. Only present on failure.

​
Examples

curl https://app.firmware.ai/api/v1/research/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer $FIRMWARE_API_KEY"

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "title": "Researching...",
  "topic": "What are the latest advancements in quantum computing?",
  "report": ""
}