Augment CSV Imports API

openapi: 3.2.0
info:
  title: Augment CSV Imports API
  description: 'Augment is now SOC 2 Type II Certified


    The Augment API endpoints are calls your system makes to manage loads,

    carriers, and webhook configuration.

    The latest version of the Augment API is hosted online.


    ## API Endpoints


    Endpoints your system calls to interact with Augment:


    - Load Management

    - Carrier Management

    - CSV Imports

    - Quote Management - implemented by the

    rate provider and called by Augment

    - Models

    - Webhook Endpoints

    - Webhook Event Subscriptions


    Webhook management access is gated. Request access from Augment before using

    these endpoints. After access is enabled, you can self-manage the webhook

    endpoints that receive event payloads and the webhook event subscriptions

    that control which events are sent to each endpoint.


    Use Webhook Endpoints to create and

    update the HTTPS destinations where Augment sends webhook payloads. Use

    Webhook Event Subscriptions to

    choose event types for each endpoint and send test deliveries.


    Outbound webhook payloads, including Track & Trace events, are documented

    separately in the Webhooks reference. Subscriptions created

    through the public webhook management APIs deliver version 2 webhook payloads only.


    Quote Management is the exception to all

    of the above: that endpoint is implemented by the rate provider and called by

    Augment, which cannot retrieve quotes until it is live.


    ## Resources


    * Homepage

    * LinkedIn

    * Jobs - we''re hiring!


    ## Developer Notes


    All date-time fields are represented as strings. The date-time notation is defined by RFC 3339, section 5.6. Examples:

    - `2025-08-21T12:34:56Z`

    - `2025-08-21T04:34:56-08:00`


    However, when using local time, do not include the trailing `Z` or timezone offset in the date-time string.


    Example:

    - `2025-08-21T12:34:56`'
  version: 2.90.1
servers:
- url: https://api.prod.goaugment.com
security:
- httpBasic: []
tags:
- name: CSV Imports
  description: Public API endpoint for submitting CSV files for asynchronous ingestion into Augment.
paths:
  /v2/csv-imports:
    post:
      operationId: createCsvImport
      tags:
      - CSV Imports
      summary: Import a CSV file
      description: '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.'
      parameters:
      - name: mappingName
        in: query
        required: true
        schema:
          type: string
        description: Name of the configured CSV mapping to apply.
        example: default-load-import
      requestBody:
        required: true
        content:
          text/csv:
            schema:
              type: string
              format: binary
            example: 'loadNumber,mode,status,pickupCity,deliveryCity

              LOAD-12345,FTL,DRAFT,Santa Monica,San Francisco

              LOAD-12346,FTL,DRAFT,Los Angeles,Seattle

              '
      responses:
        '202':
          description: CSV import accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CsvImportAcceptedResponse'
        '400':
          description: 'Malformed request; do not retry without changing it. `errorCode` identifies the specific failure: `CSV_IMPORT_MISSING_MAPPING_NAME` (the `mappingName` query parameter was not sent), `CSV_IMPORT_INVALID_BODY` (the request body was not raw CSV content — for example an empty body), `CSV_IMPORT_EMPTY_FILE` (the file had no non-blank lines), `CSV_IMPORT_FILE_TOO_LARGE` (the file exceeds 5 MB), `CSV_IMPORT_MISSING_HEADER_ROW` (fewer than two non-blank lines, so there is no header plus at least one data row), or `CSV_IMPORT_UNKNOWN_MAPPING_NAME` (no mapping with that name is configured for your brokerage or globally).

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
              example:
                message: Bad Request
                errorCode: CSV_IMPORT_FILE_TOO_LARGE
                details: File exceeds the maximum size of 5242880 bytes
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '429':
          description: 'Daily file cap reached for this brokerage. Retry after midnight UTC; do not retry sooner.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
              example:
                message: Too Many Requests
                errorCode: CSV_IMPORT_DAILY_FILE_CAP_EXCEEDED
                details: Daily cap of 50 files per brokerage reached; retry after midnight UTC
components:
  schemas:
    CsvImportAcceptedResponse:
      type: object
      required:
      - ingestId
      properties:
        ingestId:
          type: string
          description: Ingest event id; row-level results surface asynchronously on it.
    ApiErrorBody:
      type: object
      required:
      - message
      x-property-order:
      - message
      - errorCode
      - details
      properties:
        message:
          type: string
          description: An error message
        errorCode:
          type: string
          description: An error code
        details:
          oneOf:
          - type: object
          - type: string
          description: Additional error details
  securitySchemes:
    httpBasic:
      type: http
      scheme: basic
      description: 'Authenticate with HTTP Basic auth by sending an empty username and your API key as the password, equivalent to encoding :<API_KEY> in the Basic credential.

        '
x-ext-urls: {}
x-provenance:
  method: harvested
  publisher: Augment
  source: https://apidocs.goaugment.com/reference/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)