Ingest Mcap

POST

Ingests data from mcap files in the S3 Nominal upload bucket. Currently only supports ingesting video channels.

Request

This endpoint expects an object.

sourceslist of objectsRequired

List of files in S3 to be ingested. These should be ordered by time, as data will be ingested and concatenated across all the files. Note: only a single files are currently supported, this field is mostly for forward compatibility.

channelConfiglist of objectsRequired

propertiesmap from strings to stringsRequired

labelsset of stringsRequired

channelsobjectOptional

Config to define which channels in the mcap should be ingested. The default is to ingest only channels with config, otherwise the mcap may not be supported.

titlestringOptional

descriptionstringOptional

Response

This endpoint returns an object.

outputslist of objects

asyncHandleobject

POST

1 curl -X POST https://api.gov.nominal.io/api/ingest/v1/ingest-mcap \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "sources": [
6     {
7       "type": "s3",
8       "s3": {
9         "path": "path"
10       }
11     },
12     {
13       "type": "s3",
14       "s3": {
15         "path": "path"
16       }
17     }
18   ],
19   "channelConfig": [
20     {
21       "locator": {
22         "type": "topic",
23         "topic": "locator"
24       },
25       "channelType": {
26         "type": "video",
27         "video": {}
28       }
29     },
30     {
31       "locator": {
32         "type": "topic",
33         "topic": "locator"
34       },
35       "channelType": {
36         "type": "video",
37         "video": {}
38       }
39     }
40   ],
41   "properties": {
42     "properties": "properties"
43   },
44   "labels": [
45     "labels"
46   ]
47 }'

200Successful

1 {
2   "outputs": [
3     {
4       "source": {
5         "type": "singleChannel",
6         "singleChannel": {
7           "type": "topic",
8           "topic": "source"
9         }
10       },
11       "target": {
12         "type": "videoRid",
13         "videoRid": "target"
14       }
15     },
16     {
17       "source": {
18         "type": "singleChannel",
19         "singleChannel": {
20           "type": "topic",
21           "topic": "source"
22         }
23       },
24       "target": {
25         "type": "videoRid",
26         "videoRid": "target"
27       }
28     }
29   ],
30   "asyncHandle": {
31     "rid": "rid"
32   }
33 }

Generate Slack Webhook Link

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/ingest/v1/ingest-mcap \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"sources": [
6	{
7	"type": "s3",
8	"s3": {
9	"path": "path"
10	}
11	},
12	{
13	"type": "s3",
14	"s3": {
15	"path": "path"
16	}
17	}
18	],
19	"channelConfig": [
20	{
21	"locator": {
22	"type": "topic",
23	"topic": "locator"
24	},
25	"channelType": {
26	"type": "video",
27	"video": {}
28	}
29	},
30	{
31	"locator": {
32	"type": "topic",
33	"topic": "locator"
34	},
35	"channelType": {
36	"type": "video",
37	"video": {}
38	}
39	}
40	],
41	"properties": {
42	"properties": "properties"
43	},
44	"labels": [
45	"labels"
46	]
47	}'

1	{
2	"outputs": [
3	{
4	"source": {
5	"type": "singleChannel",
6	"singleChannel": {
7	"type": "topic",
8	"topic": "source"
9	}
10	},
11	"target": {
12	"type": "videoRid",
13	"videoRid": "target"
14	}
15	},
16	{
17	"source": {
18	"type": "singleChannel",
19	"singleChannel": {
20	"type": "topic",
21	"topic": "source"
22	}
23	},
24	"target": {
25	"type": "videoRid",
26	"videoRid": "target"
27	}
28	}
29	],
30	"asyncHandle": {
31	"rid": "rid"
32	}
33	}