/research/:id

The GET /research/:id method, with research task identifier, retrieves a specific research task information. This endpoint is currently in beta, it might be subject to changes.

GET /v1/research/{id}

/research/:id

cURL

curl --request GET \
  --url https://api.linkup.so/v1/research/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "error": "<string>",
  "id": "01234-abcd-56789",
  "status": "completed",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "input": {
    "outputType": "sourcedAnswer",
    "q": "What is Microsoft's 2024 revenue?",
    "excludeDomains": [
      "wikipedia.org"
    ],
    "fromDate": "2025-01-01",
    "includeDomains": [
      "microsoft.com",
      "agolution.com"
    ],
    "includeImages": false,
    "structuredOutputSchema": null,
    "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"
      }
    ]
  },
  "type": "<string>"
}

Get your API key

Create a Linkup account for free to get your API key.

This endpoint only retrieves data from an existing research task. It does not create a new research task. To create a new task, use the POST /research endpoint.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Response

200

application/json

Research task details.

createdAt · string<date-time> · required

The date and time when the task was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Example:

"2026-01-01T00:00:00.000Z"

error · string | null · required

The error message if the task failed.

id · string · required

The unique identifier of the task.

Example:

"01234-abcd-56789"

status · enum<string> · required

The current status of the task.

Available options: completed, failed, pending, processing

Example:

"completed"

updatedAt · string<date-time> · required

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

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Example:

"2026-01-01T00:00:00.000Z"

input · object · required

Show child attributes

output · object · required

Option 1

Option 2

Option 3

Show child attributes

type · string · required

Allowed value: "research"