Create

POST

Creates and persists a video entity with the given metadata.

Request

This endpoint expects an object.

titlestringRequired

labelsset of stringsRequired

propertiesmap from strings to stringsRequired

originMetadataobjectRequired

descriptionstringOptional

Response

This endpoint returns an object.

ridstring

titlestring

labelsset of strings

propertiesmap from strings to strings

createdBystring

createdAtdatetime

originMetadataobject

descriptionstringOptional

allSegmentsMetadataobjectOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/video/v1/videos \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "title": "title",
6   "labels": [
7     "labels"
8   ],
9   "properties": {
10     "properties": "properties"
11   },
12   "originMetadata": {
13     "videoSources": [
14       {
15         "type": "s3",
16         "s3": "videoSources"
17       },
18       {
19         "type": "s3",
20         "s3": "videoSources"
21       }
22     ],
23     "timestampManifest": {
24       "type": "mcap",
25       "mcap": {
26         "mcapChannelLocator": {
27           "type": "topic",
28           "topic": "mcapChannelLocator"
29         }
30       }
31     }
32   }
33 }'

200Successful

1 {
2   "rid": "rid",
3   "title": "title",
4   "labels": [
5     "labels"
6   ],
7   "properties": {
8     "properties": "properties"
9   },
10   "createdBy": "createdBy",
11   "createdAt": "2024-01-15T09:30:00Z",
12   "originMetadata": {
13     "videoSources": [
14       {
15         "type": "s3",
16         "s3": "videoSources"
17       },
18       {
19         "type": "s3",
20         "s3": "videoSources"
21       }
22     ],
23     "timestampManifest": {
24       "type": "mcap",
25       "mcap": {
26         "mcapChannelLocator": {
27           "type": "topic",
28           "topic": "mcapChannelLocator"
29         }
30       }
31     },
32     "videoSourcesOriginalHandles": [
33       {
34         "type": "s3",
35         "s3": "videoSourcesOriginalHandles"
36       },
37       {
38         "type": "s3",
39         "s3": "videoSourcesOriginalHandles"
40       }
41     ]
42   },
43   "description": "description",
44   "allSegmentsMetadata": {
45     "rid": "rid",
46     "numFrames": 1,
47     "numSegments": 1,
48     "scaleFactor": 1.1,
49     "minAbsoluteTimestamp": {
50       "seconds": 1000000,
51       "nanos": 1000000,
52       "picos": 1
53     },
54     "maxAbsoluteTimestamp": {
55       "seconds": 1000000,
56       "nanos": 1000000,
57       "picos": 1
58     },
59     "mediaDurationSeconds": 1.1,
60     "mediaFrameRate": 1.1,
61     "minTimestamp": {
62       "seconds": 1000000,
63       "nanos": 1000000,
64       "picos": 1
65     },
66     "maxTimestamp": {
67       "seconds": 1000000,
68       "nanos": 1000000,
69       "picos": 1
70     },
71     "durationSeconds": 1.1,
72     "frameRate": 1.1
73   }
74 }

Update Metadata

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/video/v1/videos \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"title": "title",
6	"labels": [
7	"labels"
8	],
9	"properties": {
10	"properties": "properties"
11	},
12	"originMetadata": {
13	"videoSources": [
14	{
15	"type": "s3",
16	"s3": "videoSources"
17	},
18	{
19	"type": "s3",
20	"s3": "videoSources"
21	}
22	],
23	"timestampManifest": {
24	"type": "mcap",
25	"mcap": {
26	"mcapChannelLocator": {
27	"type": "topic",
28	"topic": "mcapChannelLocator"
29	}
30	}
31	}
32	}
33	}'

1	{
2	"rid": "rid",
3	"title": "title",
4	"labels": [
5	"labels"
6	],
7	"properties": {
8	"properties": "properties"
9	},
10	"createdBy": "createdBy",
11	"createdAt": "2024-01-15T09:30:00Z",
12	"originMetadata": {
13	"videoSources": [
14	{
15	"type": "s3",
16	"s3": "videoSources"
17	},
18	{
19	"type": "s3",
20	"s3": "videoSources"
21	}
22	],
23	"timestampManifest": {
24	"type": "mcap",
25	"mcap": {
26	"mcapChannelLocator": {
27	"type": "topic",
28	"topic": "mcapChannelLocator"
29	}
30	}
31	},
32	"videoSourcesOriginalHandles": [
33	{
34	"type": "s3",
35	"s3": "videoSourcesOriginalHandles"
36	},
37	{
38	"type": "s3",
39	"s3": "videoSourcesOriginalHandles"
40	}
41	]
42	},
43	"description": "description",
44	"allSegmentsMetadata": {
45	"rid": "rid",
46	"numFrames": 1,
47	"numSegments": 1,
48	"scaleFactor": 1.1,
49	"minAbsoluteTimestamp": {
50	"seconds": 1000000,
51	"nanos": 1000000,
52	"picos": 1
53	},
54	"maxAbsoluteTimestamp": {
55	"seconds": 1000000,
56	"nanos": 1000000,
57	"picos": 1
58	},
59	"mediaDurationSeconds": 1.1,
60	"mediaFrameRate": 1.1,
61	"minTimestamp": {
62	"seconds": 1000000,
63	"nanos": 1000000,
64	"picos": 1
65	},
66	"maxTimestamp": {
67	"seconds": 1000000,
68	"nanos": 1000000,
69	"picos": 1
70	},
71	"durationSeconds": 1.1,
72	"frameRate": 1.1
73	}
74	}