Skip to main content
GET
/
v1
/
tasks
/
upload
/
{upload_task_id}
Check Upload Status
curl --request GET \
  --url https://api.lobstr.io/v1/tasks/upload/{upload_task_id} \
  --header 'Authorization: <authorization>'
{
  "id": "<string>",
  "object": "<string>",
  "state": "<string>",
  "meta.duplicates": 123,
  "meta.inserted": 123,
  "meta.invalid": 123,
  "meta.valid": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint checks the status of a task upload operation using the upload task ID returned from the Upload Tasks endpoint.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY

​
Query Parameters

​
upload_task_id
string
required
The upload task ID returned from Upload Tasks endpoint. Example: 427a7bfc54cf4ce483d83ba23425164b

​
Response Field Explanations

​
id
string
Upload task identifier. Example: "427a7bfc54cf4ce483d83ba23425164b"
​
object
string
Always “task_upload”. Example: "task_upload"
​
state
string
Current upload state (PENDING, PROGRESS, SUCCESS, FAILURE). Example: "SUCCESS"
​
meta.duplicates
integer
Number of duplicate tasks skipped. Example: 0
​
meta.inserted
integer
Number of tasks successfully inserted. Example: 8
​
meta.invalid
integer
Number of invalid rows in the file. Example: 0
​
meta.valid
integer
Number of valid rows processed. Example: 8

​
State Values

StateDescription
PENDINGUpload task is queued and waiting to start
PROGRESSFile is being processed
SUCCESSUpload completed successfully
FAILUREUpload failed due to an error
Poll this endpoint periodically until state is SUCCESS or FAILURE before running your squid.
Check meta.invalid to identify how many rows had issues. Review your CSV format if this number is high.
Don’t start a squid run until the upload state is SUCCESS, or you may miss tasks.

​
Code Examples

curl -X GET "https://api.lobstr.io/v1/tasks/upload/427a7bfc54cf4ce483d83ba23425164b" \
  -H "Authorization: Token YOUR_API_KEY"

​
Response

200
{
  "id": "427a7bfc54cf4ce483d83ba23425164b",
  "object": "task_upload",
  "state": "SUCCESS",
  "meta": {
    "duplicates": 0,
    "inserted": 8,
    "invalid": 0,
    "valid": 8
  }
}
202
{
  "id": "427a7bfc54cf4ce483d83ba23425164b",
  "object": "task_upload",
  "state": "PROGRESS",
  "meta": null
}
404
{
  "error": {
    "message": "Upload task not found",
    "type": "not_found_error",
    "param": "upload_task_id"
  }
}