Upload a file

Upload a file to a project. A file contains one or more documents that can be used to create a document group

Path Parameters

• project_id integer required

  ID of the project

multipart/form-data

Request Body required

• file binary required

  file to upload

• to_list boolean

  DEPRECATED: If set to false, the file preview will be in JSON format instead of a list. The default behavior will soon be changed to return a JSON and this parameter won't be needed anymore

Responses

• 200
• 400
• 401
• 403
• 404
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• id uuid

  The unique ID of the uploaded file.

• preview array[]

  Possible values: >= 2

  A preview of the columns found in that file. The first element represents the header, if present.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "preview": [
    [
      "string"
    ]
  ]
}

The uploaded file has an invalid format

User is not authenticated. This means token is either not present or invalid

User is read-only or does not have the minimal required project role "MANAGER"

The project was not found

Something is wrong with the API.

Loading...