# Native extractor service Workspace-facing surface for enabling and converging native catalog extractors. OpenAPI file: [`nominal.ingest.v2.json`](https://dev.nominal.io/api/_downloads/064305915dc637b34369651e3e33dd72/nominal.ingest.v2.json) ## Endpoints ### List native extractors GET `/extractors/v2/native` Lists every catalog entry the deployment carries with this workspace’s installation state. Query parameters `workspaceRid` string required : ​ `pageSize` integer required : From 1 to 1,000. `nextPageToken` string : ​ Response `extractors` array of [`NativeExtractor`](https://dev.nominal.io/api/rest/native-extractor-service.md#nativeextractor) : ​ Fields of `NativeExtractor` `catalogId` string : Stable catalog identifier, e.g. “ardupilot-dataflash”. `availableVersions` array of string : Versions the deployment’s catalog currently carries, ascending. `installation` [`ContainerizedExtractor`](https://dev.nominal.io/api/rest/native-extractor-service.md#containerizedextractor) : The workspace-local extractor materialized for this entry, set when enabled. Ingest requests target it exactly like a customer-authored extractor, and the catalog version it is installed at is its active image’s tag. Fields of `ContainerizedExtractor` `rid` string : Unique resource identifier for this extractor. `workspaceRid` string : Workspace that owns this extractor. `name` string : User-supplied name. Need not be unique within a workspace. `description` string : Free-form description shown in the UI. `createdAt` string (date-time) : Timestamp at which this extractor was first registered. `isArchived` boolean : True once the extractor has been archived. Archived extractors are hidden from default search results and reject new ingests; flip back to false on UpdateContainerizedExtractor to restore. `activeContainerImage` [`ContainerImage`](https://dev.nominal.io/api/rest/native-extractor-service.md#containerimage) : The container image currently selected to run this extractor. Unset until the first image for this extractor reaches READY status; ingest requests that arrive before then will fail. The schema fields (inputs, parameters, output_file_format, default_timestamp_metadata) live on this nested image. Fields of `ContainerImage` `rid` string : ​ `tag` string : User-supplied tag, unique within (workspace, extractor). `sizeBytes` string (int64) : Size of the stored image in bytes once the image reaches READY. `status` [`ContainerImageStatus`](https://dev.nominal.io/api/rest/native-extractor-service.md#containerimagestatus) : Current lifecycle status (PENDING while pushing, READY after a successful push, FAILED otherwise). Values of `ContainerImageStatus` `CONTAINER_IMAGE_STATUS_UNSPECIFIED` : ​ `CONTAINER_IMAGE_STATUS_PENDING` : ​ `CONTAINER_IMAGE_STATUS_READY` : ​ `CONTAINER_IMAGE_STATUS_FAILED` : ​ `createdAt` string (date-time) : When the image record was created. `extractorRid` string : The containerized extractor this image is built for. `inputs` array of [`FileExtractionInput`](https://dev.nominal.io/api/rest/native-extractor-service.md#fileextractioninput) : The input files this extractor requires, mapped to environment variables that store the path to each file. Fields of `FileExtractionInput` `environmentVariable` string : The environment variable that stores the path to the input file. `name` string : Name of the input file which users will be prompted with. `description` string : Description of the input file which users will be prompted with. `fileFilters` array of [`FileFilter`](https://dev.nominal.io/api/rest/native-extractor-service.md#filefilter) : Optionally filter files for file selection. Fields of `FileFilter` `suffix` [`FileSuffix`](https://dev.nominal.io/api/rest/native-extractor-service.md#filesuffix) : ​ Fields of `FileSuffix` `suffix` string : ​ `required` boolean : Whether the input file is required for the extractor to run. `parameters` array of [`FileExtractionParameter`](https://dev.nominal.io/api/rest/native-extractor-service.md#fileextractionparameter) : Parameters the extractor accepts. Fields of `FileExtractionParameter` `environmentVariable` string : The environment variable that stores the argument. `name` string : Name of the parameter which users will be prompted with. `description` string : Description of the parameter which users will be prompted with. `required` boolean : Whether the parameter is required for the extractor to run. `fileOutputFormat` [`FileOutputFormat`](https://dev.nominal.io/api/rest/native-extractor-service.md#fileoutputformat) : Format of the output file produced by the extractor. Values of `FileOutputFormat` `FILE_OUTPUT_FORMAT_UNSPECIFIED` : ​ `FILE_OUTPUT_FORMAT_PARQUET` : ​ `FILE_OUTPUT_FORMAT_CSV` : ​ `FILE_OUTPUT_FORMAT_PARQUET_TAR` : ​ `FILE_OUTPUT_FORMAT_AVRO_STREAM` : ​ `FILE_OUTPUT_FORMAT_JSON_L` : ​ `FILE_OUTPUT_FORMAT_MANIFEST` : ​ `defaultTimestampMetadata` [`registry.v2.TimestampMetadata`](https://dev.nominal.io/api/rest/native-extractor-service.md#registry-v2-timestampmetadata) : Metadata about the intermediate parquet this extractor will produce. If not set, timestamp metadata must be provided at ingest time. Fields of `registry.v2.TimestampMetadata` `seriesName` string : Name of the series within the output whose values are used as the row timestamp. `timestampType` [`TimestampType`](https://dev.nominal.io/api/rest/native-extractor-service.md#timestamptype) : How the values in `series_name` should be interpreted as timestamps. Fields of `TimestampType` one of `relative`, `absolute` : ​ **relative** `relative` [`RelativeTimestamp`](https://dev.nominal.io/api/rest/native-extractor-service.md#relativetimestamp) : ​ Fields of `RelativeTimestamp` `timeUnit` string : Unit in which relative offsets are expressed. Aliases the classic REST TimeUnit alias. `offset` string (date-time) : Starting timestamp to use when indexing the file. **absolute** `absolute` [`AbsoluteTimestamp`](https://dev.nominal.io/api/rest/native-extractor-service.md#absolutetimestamp) : ​ Fields of `AbsoluteTimestamp` one of `iso8601`, `epochOfTimeUnit`, `customFormat` : ​ **iso8601** `iso8601` [`Iso8601Timestamp`](https://dev.nominal.io/api/rest/native-extractor-service.md#iso8601timestamp) : ​ **epochOfTimeUnit** `epochOfTimeUnit` [`EpochTimestamp`](https://dev.nominal.io/api/rest/native-extractor-service.md#epochtimestamp) : ​ Fields of `EpochTimestamp` `timeUnit` string Request **curl** ```shell curl "https://api.gov.nominal.io/api/extractors/v2/native?workspaceRid=&pageSize=1" \ -H "Authorization: Bearer " ``` **requests** ```python import requests response = requests.get( "https://api.gov.nominal.io/api/extractors/v2/native?workspaceRid=&pageSize=1", headers={"Authorization": "Bearer "}, ) response.raise_for_status() print(response.json()) ``` **httpx** ```python import httpx response = httpx.get( "https://api.gov.nominal.io/api/extractors/v2/native?workspaceRid=&pageSize=1", headers={"Authorization": "Bearer "}, ) response.raise_for_status() print(response.json()) ``` **aiohttp** ```python import asyncio import aiohttp async def main() -> None: async with aiohttp.ClientSession() as session: async with session.get( "https://api.gov.nominal.io/api/extractors/v2/native?workspaceRid=&pageSize=1", headers={"Authorization": "Bearer "}, ) as response: response.raise_for_status() print(await response.json()) asyncio.run(main()) ``` Response: `200` ```json { "extractors": [ { "catalogId": "", "availableVersions": [ "" ], "installation": { "rid": "", "workspaceRid": "", "name": "", "description": "", "createdAt": "2026-01-01T00:00:00Z", "isArchived": true, "activeContainerImage": { "rid": "", "tag": "", "sizeBytes": "1", "status": "CONTAINER_IMAGE_STATUS_PENDING", "createdAt": "2026-01-01T00:00:00Z", "extractorRid": "", "inputs": [ { "environmentVariable": "", "name": "", "description": "", "fileFilters": [ { "suffix": { "suffix": "" } } ], "required": true } ], "parameters": [ { "environmentVariable": "", "name": "", "description": "", "required": true } ], "fileOutputFormat": "FILE_OUTPUT_FORMAT_PARQUET", "defaultTimestampMetadata": { "seriesName": "", "timestampType": { "relative": { "timeUnit": "