Get Task

Use this endpoint to fetch a Task after creating it. The status property of the Task object indicates whether or not output is present.

Retrieve a task

Call this endpoint to retrieve a task.

GET/v1/tasks/:id

Path parameters

Name
id
Type
string
Description
The ID of the task you are retrieving.

Request

GET/v1/tasks/:id

curl --request GET \
    --url https://api.goneural.ai/v1/image-to-3d/:task \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <token>' \

Response body parameters

This endpoint returns the task object.

Name
id
Type
string
Description
Unique identifier for the task.
Name
status
Type
TaskStatus
Description
The status of the task.
Name
type
Type
TaskType
Description
The type of task.
Name
seed
Type
integer
Description
The seed used to create the task.
Name
input
Type
Record<string, string>
Description
The input used to create the task.
Name
output
Type
Record<string, string>
Description
The version of the model used to create the task.
Name
creditUsed
Type
integer
Description
The amount of credits used by creating this task.
Name
refunded
Type
boolean
Description
Whether the task was refunded.
Name
userId
Type
integer
Description
The ID of the user who created the task.
Name
finishedAt
Type
string<date-time> | null
Description
The timestamp of when the task finished processing.
Name
createdAt
Type
string<date-time> | null
Description
The timestamp of when the task was created.
Name
asset
Type
Object
Description
The asset associated with the task.
Name
permissions
Type
array[string]
Description
The permissions associated with the task.
Name
assetId
Type
string | null
Description
The ID of the asset associated with the task.
Name
meta
Type
object | null
Description
The metadata associated with the task.

Response

{
  "id": "string",
  "status": "queued",
  "type": "inpainting",
  "seed": 0,
  "input": [
    "string"
  ],
  "output": [
    "string"
  ],
  "creditUsed": 0,
  "refunded": true,
  "userId": 0,
  "finishedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "asset": {
    "id": "string",
    "type": "model",
    "userId": 0,
    "user": {
      "id": 0,
      "name": "string"
    },
    "name": "string",
    "description": "string",
    "isPublic": true,
    "likes": "string",
    "tags": [
      "string"
    ],
    "permissions": [
      "string"
    ],
    "tasks": "string",
    "latestCollections": "string"
  },
  "permissions": [
    "string"
  ],
  "assetId": "string",
  "meta": [
    "string"
  ]
}