Search

POST

Returns metadata about videos that match a given a query.

Request

This endpoint expects an object.

queryobjectRequired

sortOptionsobjectRequired

pageSizeintegerOptional

Defaults to 100. Will throw if larger than 1_000.

tokenstringOptional

archivedStatusesset of "ARCHIVED" or "NOT_ARCHIVED"Optional

Allowed values: ARCHIVEDNOT_ARCHIVED

Default search status is NOT_ARCHIVED if none are provided. Allows for including archived videos in search.

Response

This endpoint returns an object.

resultslist of objects

nextPageTokenstringOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/video/v1/videos/search \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "query": {
6     "type": "searchText",
7     "searchText": "query"
8   },
9   "sortOptions": {
10     "isDescending": true,
11     "field": "CREATED_AT"
12   }
13 }'

200Successful

1 {
2   "results": [
3     {
4       "rid": "rid",
5       "title": "title",
6       "labels": [
7         "labels"
8       ],
9       "properties": {
10         "properties": "properties"
11       },
12       "createdBy": "createdBy",
13       "createdAt": "2024-01-15T09:30:00Z",
14       "originMetadata": {
15         "videoSources": [
16           {
17             "type": "s3",
18             "s3": "videoSources"
19           },
20           {
21             "type": "s3",
22             "s3": "videoSources"
23           }
24         ],
25         "timestampManifest": {
26           "type": "mcap",
27           "mcap": {
28             "mcapChannelLocator": {
29               "type": "topic",
30               "topic": "mcapChannelLocator"
31             }
32           }
33         },
34         "videoSourcesOriginalHandles": [
35           {
36             "type": "s3",
37             "s3": "videoSourcesOriginalHandles"
38           },
39           {
40             "type": "s3",
41             "s3": "videoSourcesOriginalHandles"
42           }
43         ]
44       },
45       "description": "description",
46       "allSegmentsMetadata": {
47         "rid": "rid",
48         "numFrames": 1,
49         "numSegments": 1,
50         "scaleFactor": 1.1,
51         "minAbsoluteTimestamp": {
52           "seconds": 1000000,
53           "nanos": 1000000,
54           "picos": 1
55         },
56         "maxAbsoluteTimestamp": {
57           "seconds": 1000000,
58           "nanos": 1000000,
59           "picos": 1
60         },
61         "mediaDurationSeconds": 1.1,
62         "mediaFrameRate": 1.1,
63         "minTimestamp": {
64           "seconds": 1000000,
65           "nanos": 1000000,
66           "picos": 1
67         },
68         "maxTimestamp": {
69           "seconds": 1000000,
70           "nanos": 1000000,
71           "picos": 1
72         },
73         "durationSeconds": 1.1,
74         "frameRate": 1.1
75       }
76     },
77     {
78       "rid": "rid",
79       "title": "title",
80       "labels": [
81         "labels"
82       ],
83       "properties": {
84         "properties": "properties"
85       },
86       "createdBy": "createdBy",
87       "createdAt": "2024-01-15T09:30:00Z",
88       "originMetadata": {
89         "videoSources": [
90           {
91             "type": "s3",
92             "s3": "videoSources"
93           },
94           {
95             "type": "s3",
96             "s3": "videoSources"
97           }
98         ],
99         "timestampManifest": {
100           "type": "mcap",
101           "mcap": {
102             "mcapChannelLocator": {
103               "type": "topic",
104               "topic": "mcapChannelLocator"
105             }
106           }
107         },
108         "videoSourcesOriginalHandles": [
109           {
110             "type": "s3",
111             "s3": "videoSourcesOriginalHandles"
112           },
113           {
114             "type": "s3",
115             "s3": "videoSourcesOriginalHandles"
116           }
117         ]
118       },
119       "description": "description",
120       "allSegmentsMetadata": {
121         "rid": "rid",
122         "numFrames": 1,
123         "numSegments": 1,
124         "scaleFactor": 1.1,
125         "minAbsoluteTimestamp": {
126           "seconds": 1000000,
127           "nanos": 1000000,
128           "picos": 1
129         },
130         "maxAbsoluteTimestamp": {
131           "seconds": 1000000,
132           "nanos": 1000000,
133           "picos": 1
134         },
135         "mediaDurationSeconds": 1.1,
136         "mediaFrameRate": 1.1,
137         "minTimestamp": {
138           "seconds": 1000000,
139           "nanos": 1000000,
140           "picos": 1
141         },
142         "maxTimestamp": {
143           "seconds": 1000000,
144           "nanos": 1000000,
145           "picos": 1
146         },
147         "durationSeconds": 1.1,
148         "frameRate": 1.1
149       }
150     }
151   ],
152   "nextPageToken": "nextPageToken"
153 }

Create

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/video/v1/videos/search \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"query": {
6	"type": "searchText",
7	"searchText": "query"
8	},
9	"sortOptions": {
10	"isDescending": true,
11	"field": "CREATED_AT"
12	}
13	}'

1	{
2	"results": [
3	{
4	"rid": "rid",
5	"title": "title",
6	"labels": [
7	"labels"
8	],
9	"properties": {
10	"properties": "properties"
11	},
12	"createdBy": "createdBy",
13	"createdAt": "2024-01-15T09:30:00Z",
14	"originMetadata": {
15	"videoSources": [
16	{
17	"type": "s3",
18	"s3": "videoSources"
19	},
20	{
21	"type": "s3",
22	"s3": "videoSources"
23	}
24	],
25	"timestampManifest": {
26	"type": "mcap",
27	"mcap": {
28	"mcapChannelLocator": {
29	"type": "topic",
30	"topic": "mcapChannelLocator"
31	}
32	}
33	},
34	"videoSourcesOriginalHandles": [
35	{
36	"type": "s3",
37	"s3": "videoSourcesOriginalHandles"
38	},
39	{
40	"type": "s3",
41	"s3": "videoSourcesOriginalHandles"
42	}
43	]
44	},
45	"description": "description",
46	"allSegmentsMetadata": {
47	"rid": "rid",
48	"numFrames": 1,
49	"numSegments": 1,
50	"scaleFactor": 1.1,
51	"minAbsoluteTimestamp": {
52	"seconds": 1000000,
53	"nanos": 1000000,
54	"picos": 1
55	},
56	"maxAbsoluteTimestamp": {
57	"seconds": 1000000,
58	"nanos": 1000000,
59	"picos": 1
60	},
61	"mediaDurationSeconds": 1.1,
62	"mediaFrameRate": 1.1,
63	"minTimestamp": {
64	"seconds": 1000000,
65	"nanos": 1000000,
66	"picos": 1
67	},
68	"maxTimestamp": {
69	"seconds": 1000000,
70	"nanos": 1000000,
71	"picos": 1
72	},
73	"durationSeconds": 1.1,
74	"frameRate": 1.1
75	}
76	},
77	{
78	"rid": "rid",
79	"title": "title",
80	"labels": [
81	"labels"
82	],
83	"properties": {
84	"properties": "properties"
85	},
86	"createdBy": "createdBy",
87	"createdAt": "2024-01-15T09:30:00Z",
88	"originMetadata": {
89	"videoSources": [
90	{
91	"type": "s3",
92	"s3": "videoSources"
93	},
94	{
95	"type": "s3",
96	"s3": "videoSources"
97	}
98	],
99	"timestampManifest": {
100	"type": "mcap",
101	"mcap": {
102	"mcapChannelLocator": {
103	"type": "topic",
104	"topic": "mcapChannelLocator"
105	}
106	}
107	},
108	"videoSourcesOriginalHandles": [
109	{
110	"type": "s3",
111	"s3": "videoSourcesOriginalHandles"
112	},
113	{
114	"type": "s3",
115	"s3": "videoSourcesOriginalHandles"
116	}
117	]
118	},
119	"description": "description",
120	"allSegmentsMetadata": {
121	"rid": "rid",
122	"numFrames": 1,
123	"numSegments": 1,
124	"scaleFactor": 1.1,
125	"minAbsoluteTimestamp": {
126	"seconds": 1000000,
127	"nanos": 1000000,
128	"picos": 1
129	},
130	"maxAbsoluteTimestamp": {
131	"seconds": 1000000,
132	"nanos": 1000000,
133	"picos": 1
134	},
135	"mediaDurationSeconds": 1.1,
136	"mediaFrameRate": 1.1,
137	"minTimestamp": {
138	"seconds": 1000000,
139	"nanos": 1000000,
140	"picos": 1
141	},
142	"maxTimestamp": {
143	"seconds": 1000000,
144	"nanos": 1000000,
145	"picos": 1
146	},
147	"durationSeconds": 1.1,
148	"frameRate": 1.1
149	}
150	}
151	],
152	"nextPageToken": "nextPageToken"
153	}