Skip to main content
curl --location --request GET 'https://api.safetykit.com/v1/import/import_01hexzqs3n8hx83psy4ernj2zz' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <api_key>'

{
  "import_id": "import_01hexzqs3n8hx83psy4ernj2zz",
  "import_status": "WAITING_FOR_UPLOAD",
  "s3_key": "import/53ee3a58-73c6-4b3d-9d57-e6fe277c8dba/01HEXZQW6B07FKNV1D8P2M7F4B",
  "filename": "api_upload.jsonl",
  "created_at": "2023-11-15T18:59:43.004Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.safetykit.com/llms.txt

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

​
Response

​
import_id
string
Unique ID of the import
​
import_status
string
Status of the import (“WAITING_FOR_UPLOAD”, “IN_PROGRESS”, “COMPLETE”, or “FAILED”)
​
s3_key
string (optional)
S3 key where the import file was uploaded
​
filename
string (optional)
Original filename of the uploaded import
​
created_at
string
ISO 8601 timestamp when the import was created
curl --location --request GET 'https://api.safetykit.com/v1/import/import_01hexzqs3n8hx83psy4ernj2zz' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <api_key>'

{
  "import_id": "import_01hexzqs3n8hx83psy4ernj2zz",
  "import_status": "WAITING_FOR_UPLOAD",
  "s3_key": "import/53ee3a58-73c6-4b3d-9d57-e6fe277c8dba/01HEXZQW6B07FKNV1D8P2M7F4B",
  "filename": "api_upload.jsonl",
  "created_at": "2023-11-15T18:59:43.004Z"
}

​
Import Status Lifecycle

Imports progress through the following statuses:
  1. WAITING_FOR_UPLOAD - Import created, waiting for file upload to S3
  2. IN_PROGRESS - File uploaded and being processed
  3. COMPLETE - Import processing completed successfully
  4. FAILED - Import processing failed due to an error
You can poll this endpoint to monitor the progress of your import.