CSV Imports

Import a CSV file

Submit a CSV file for asynchronous ingestion into Augment. The request body is the raw file content, sent with Content-Type: text/csv — not a multipart upload. The brokerage that owns the import is resolved from the API key used to authenticate the request.

A 202 response means the file was accepted and enqueued, not that every row was imported. Processing happens asynchronously; row-level mapping failures surface on the ingest event referenced by ingestId, not in this response.

mappingName selects the CSV column mapping to apply: either a global default mapping or one configured specifically for your brokerage. If no mapping with that name is configured, the request fails with CSV_IMPORT_UNKNOWN_MAPPING_NAME. Contact Augment to have a mapping configured before using this endpoint.

Files are capped at 5 MB, and each brokerage may submit at most 50 files per UTC day.

post/v2/csv-imports

Request

Base URL
https://api.prod.goaugment.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/goaugment/apis/augment-api/docs/v2/csv-imports/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

mappingNamestring required

Name of the configured CSV mapping to apply.

Request body text/csv

string binary required

Response

CSV import accepted

ingestIdstring required

Ingest event id; row-level results surface asynchronously on it.

Changes

No recorded changes to this operation across all 1 revision of this API.