Skip to main content
GET
/
v1
/
research
/
{id}
/research/:id
curl --request GET \
  --url https://api.linkup.so/v1/research/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "01234-abcd-56789",
  "status": "completed",
  "input": {},
  "output": {},
  "error": "<string>",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

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

Research task details.

​
id
string
required

The unique identifier of the research task.

Example:

"01234-abcd-56789"

​
status
enum<string>
required

The current status of the research task.

Available options:
completed,
failed,
pending,
processing
Example:

"completed"

​
input
object
required

The input parameters used to create the research task.

​
output
object
required

The output of the research task if the research task is completed.

​
error
string | null
required

The error message if the research task failed.

​
createdAt
string<date-time>
required

The date and time when the research task was created.

Example:

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

​
updatedAt
string<date-time>
required

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

Example:

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