---
title: "Analyze Csv"
method: POST
path: "/api/v1/import/analyze"
tags: ["import", "import"]
---

# Analyze Csv

`POST /api/v1/import/analyze`

## Request

- Base URL: `https://api.peil.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.peil.app/api/v1/import/analyze`
- Auth: OAuth 2 (password, token URL `/api/v1/auth/jwt/login`)

## Response `200`

Successful Response

- AnalyzeResponse
  - `entity_type` string, required
  - `delimiter` string, required
  - `row_count` integer, required
  - `column_mappings` ColumnMapping[], required
    - `csv_column` string, required
    - `peil_field` string, nullable
    - `confidence` number
    - `sample_values` string[]
  - `sample_rows` object[], required
  - `warnings` ImportWarning[], required
    - `type` string, required
    - `message` string, required
    - `column` string, nullable
    - `severity` string
  - `detected_date_format` string, nullable
  - `detected_number_format` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/peil/apis/peil-api.md) · [All operations](https://skmtc.dev/peil/apis/peil-api/llms.txt) · [OpenAPI document](https://skmtc.dev/peil/apis/peil-api/revisions/ee3ca1246dde?raw)