Retrieve a task
Get a single task’s details.
curl --request GET \
--url https://ronika-api.induced.ai/v1/tasks/{id} \
--header 'x-api-key: <api-key>'
{
"id": "<string>",
"status": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"intent": "<string>",
"title": "<string>",
"summary": "<string>",
"form": [
{
"type": "<string>",
"key": "<string>",
"value": "<string>",
"options": [
"<string>"
]
}
],
"milestones": [
{
"title": "<string>",
"description": "<string>",
"completed": true
}
],
"outputs": [
{
"id": "<string>",
"type": "<string>",
"columns": [
"<string>"
],
"prompt": "<string>",
"summary": "<string>",
"document": "<string>",
"shareUrls": {},
"downloadUrls": "<string>"
}
],
"chats": [
{
"id": "<string>",
"message": "<string>",
"role": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"files": [
{
"id": "<string>",
"name": "<string>",
"size": 123,
"mimeType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"previewUrl": "<string>"
}
],
"accounts": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"icon": "<string>",
"username": "<string>",
"additionalInfo": "<string>"
}
]
}
Authorizations
Path Parameters
The unique identifier of the task.
Response
The unique identifier of the task.
The status of the task (e.g., IN_PROGRESS, COMPLETED).
The time the task was started.
The time the task was completed. Will be null if the task is still in progress.
Your prompt for the task.
The title of the task. Automatically generated based on the intent when the task is created.
A summary of the milestones to be completed in the task.
The type of the form field. Available options are text, textarea, dropdown, multi_select and location.
The label for the form field.
The value for the form field. Can be a single string or an array of strings depending on the type of the field (applicable only if the type is dropdown or multi_select).
The options for the dropdown or multi_select field. Applicable only if the type is dropdown or multi_select.
The type of output expected. Available options are TEXT, TABLE, and DOCUMENT.
The columns expected in the output, applicable if type is TABLE.
Description on how you want the document or text to be. This is applicable if the type is DOCUMENT or TEXT.
A summary of how the output was obtained.
Markdown content of the document.
The URLs to share the document or table output(s).
The URL to download the document or table output(s) in different formats.
The name of the tool or service the account is associated with.
The URL of the tool or service.
The icon URL of the tool or service.
The username associated with the account.
Any additional information you would like to share about the account.
curl --request GET \
--url https://ronika-api.induced.ai/v1/tasks/{id} \
--header 'x-api-key: <api-key>'
{
"id": "<string>",
"status": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"intent": "<string>",
"title": "<string>",
"summary": "<string>",
"form": [
{
"type": "<string>",
"key": "<string>",
"value": "<string>",
"options": [
"<string>"
]
}
],
"milestones": [
{
"title": "<string>",
"description": "<string>",
"completed": true
}
],
"outputs": [
{
"id": "<string>",
"type": "<string>",
"columns": [
"<string>"
],
"prompt": "<string>",
"summary": "<string>",
"document": "<string>",
"shareUrls": {},
"downloadUrls": "<string>"
}
],
"chats": [
{
"id": "<string>",
"message": "<string>",
"role": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"files": [
{
"id": "<string>",
"name": "<string>",
"size": 123,
"mimeType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"previewUrl": "<string>"
}
],
"accounts": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"icon": "<string>",
"username": "<string>",
"additionalInfo": "<string>"
}
]
}