Retrieve import status

This method retrieves the current status for each video from a specified integration and index. It returns an object containing lists of videos grouped by status. See the Task object page for details on each status.

Path parameters

integration-idstringRequired

The unique identifier of the integration for which you want to retrieve the status of your imported videos. You can retrieve it from the Integrations page.

Query parameters

index_idstringRequired

The unique identifier of the index for which you want to retrieve the status of your imported videos.

Response

The status for each video from the specified integration and index has successfully been retrieved

not_importedlist of stringsOptional

An array of filenames that haven’t yet been imported.

validatinglist of objectsOptional

An array of videos that are being validated.

pendinglist of objectsOptional

An array of videos that are pending.

queuedlist of objectsOptional

An array of videos that are queued for import.

indexinglist of objectsOptional

An array of videos that are being indexed.

readylist of objectsOptional

An array of videos that have successfully been imported.

failedlist of objectsOptional

An array of videos that failed to import.

Errors

1 curl -G https://api.twelvelabs.io/v1.3/tasks/transfers/import/6298d673f1090f1100476d4c/status \ 2 -H "x-api-key: <apiKey>" \ 3 -d index_id=6298d673f1090f1100476d4c

1 { 2 "not_imported": [ 3 "NEW_VIDEO_1.mp4", 4 "NEW_VIDEO_2.mp4" 5 ], 6 "validating": [ 7 { 8 "video_id": "66fcee250f9f7bcce21915a2", 9 "filename": "1.mp4", 10 "created_at": "2024-09-24T13:22:00Z" 11 } 12 ], 13 "pending": [ 14 { 15 "video_id": "VIDEO_ID_3", 16 "filename": "VIDEO_3.mp4", 17 "created_at": "2024-09-24T13:22:00Z" 18 } 19 ], 20 "queued": [ 21 { 22 "video_id": "66fcee250f9f7bcce21915a2", 23 "filename": "1.mp4", 24 "created_at": "2024-09-24T13:22:00Z" 25 } 26 ], 27 "indexing": [ 28 { 29 "video_id": "66fcee250f9f7bcce21915a2", 30 "filename": "1.mp4", 31 "created_at": "2024-09-24T13:22:00Z" 32 } 33 ], 34 "ready": [ 35 { 36 "video_id": "VIDEO_ID_1", 37 "filename": "VIDEO_1.mp4", 38 "created_at": "2024-09-24T13:22:00Z" 39 }, 40 { 41 "video_id": "VIDEO_ID_2", 42 "filename": "VIDEO_2.mp4", 43 "created_at": "2024-09-24T13:22:00Z" 44 } 45 ], 46 "failed": [ 47 { 48 "filename": "VIDEO_4.mp4", 49 "created_at": "2024-09-24T13:22:00Z", 50 "error_message": "The file is not a valid video file." 51 } 52 ] 53 }

1	curl -G https://api.twelvelabs.io/v1.3/tasks/transfers/import/6298d673f1090f1100476d4c/status \
2	-H "x-api-key: <apiKey>" \
3	-d index_id=6298d673f1090f1100476d4c

1	{
2	"not_imported": [
3	"NEW_VIDEO_1.mp4",
4	"NEW_VIDEO_2.mp4"
5	],
6	"validating": [
7	{
8	"video_id": "66fcee250f9f7bcce21915a2",
9	"filename": "1.mp4",
10	"created_at": "2024-09-24T13:22:00Z"
11	}
12	],
13	"pending": [
14	{
15	"video_id": "VIDEO_ID_3",
16	"filename": "VIDEO_3.mp4",
17	"created_at": "2024-09-24T13:22:00Z"
18	}
19	],
20	"queued": [
21	{
22	"video_id": "66fcee250f9f7bcce21915a2",
23	"filename": "1.mp4",
24	"created_at": "2024-09-24T13:22:00Z"
25	}
26	],
27	"indexing": [
28	{
29	"video_id": "66fcee250f9f7bcce21915a2",
30	"filename": "1.mp4",
31	"created_at": "2024-09-24T13:22:00Z"
32	}
33	],
34	"ready": [
35	{
36	"video_id": "VIDEO_ID_1",
37	"filename": "VIDEO_1.mp4",
38	"created_at": "2024-09-24T13:22:00Z"
39	},
40	{
41	"video_id": "VIDEO_ID_2",
42	"filename": "VIDEO_2.mp4",
43	"created_at": "2024-09-24T13:22:00Z"
44	}
45	],
46	"failed": [
47	{
48	"filename": "VIDEO_4.mp4",
49	"created_at": "2024-09-24T13:22:00Z",
50	"error_message": "The file is not a valid video file."
51	}
52	]
53	}