Openi DeveloperDeveloper

Create a file import (CSV/XLSX, up to 1GB) and enqueue processing. Francesinha (CNAB) uploads go through POST /v1/data-sources/{id}/files instead.

POST
/v1/imports

Authorization

ApiKeyAuth
x-api-key<token>

Tenant API key

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

datasetName?string
Default"transactions"
format?string

Value in

  • "csv"
  • "xlsx"
options?string

JSON string of parser options (CSV: delimiter, encoding; XLSX: sheet name or 1-based index via "sheet")

mapping?string

JSON string of datasetKey->column mapping

file*file
Formatbinary

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/imports" \  -F file="string"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "string"}