v1

latestOpenAPI 3.1.02026-07-26125062.1 KB
Research

/research/:id

The GET /research/:id method, with research task identifier, retrieves a specific research task information.

get/v1/research/{id}

Path parameters

idstring required

Response

Research task details.

createdAtstring date-time required

The date and time when the task was created.

errorstring nullable required

The error message if the task failed.

idstring required

The unique identifier of the task.

status'completed' | 'failed' | 'pending' | 'processing' required

The current status of the task.

updatedAtstring date-time required

The date and time when the task status was last updated.

type'research' required

Example response

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "id": "01234-abcd-56789",
  "status": "completed",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "input": {
    "excludeDomains": [
      "wikipedia.org"
    ],
    "fromDate": "2025-01-01",
    "includeDomains": [
      "microsoft.com",
      "agolution.com"
    ],
    "q": "What is Microsoft's 2024 revenue?",
    "toDate": "2025-01-01"
  },
  "output": {
    "answer": "Microsoft's revenue for fiscal year 2024 was $245.1 billion, reflecting a 16% increase from the previous year.",
    "sources": [
      {
        "name": "Microsoft 2024 Annual Report",
        "snippet": "Highlights from fiscal year 2024 compared with fiscal year 2023 included: Microsoft Cloud revenue increased 23% to $137.4 billion.",
        "url": "https://www.microsoft.com/investor/reports/ar24/index.html"
      }
    ]
  }
}