Upload a file

POST

1 curl -X POST https://api.x.flatfile.com/v1/files \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: multipart/form-data" \
5      -F spaceId="string" \
6      -F environmentId="string" \
7      -F file=@<filename1>

Play

200Successful

1 {
2   "data": {
3     "id": "string",
4     "name": "string",
5     "ext": "string",
6     "mimetype": "string",
7     "encoding": "string",
8     "status": "partial",
9     "size": 0,
10     "bytesReceived": 0,
11     "createdAt": "2023-01-01T00:00:00Z",
12     "updatedAt": "2023-01-01T00:00:00Z",
13     "spaceId": "string",
14     "description": "string",
15     "mode": "import",
16     "expiredAt": "2023-01-01T00:00:00Z",
17     "workbookId": "string",
18     "sheetId": "string",
19     "actions": [
20       {
21         "label": "string",
22         "confirm": true,
23         "constraints": [
24           {
25             "type": "hasAllValid",
26             "ignoreSelection": true
27           }
28         ],
29         "description": "string",
30         "guardrail": {
31           "content": "string"
32         },
33         "guide": {
34           "content": "string"
35         },
36         "icon": "string",
37         "inputForm": {
38           "type": "simple",
39           "fields": [
40             {
41               "key": "string",
42               "label": "string",
43               "type": "string",
44               "description": "string",
45               "defaultValue": {},
46               "config": {
47                 "options": [
48                   {
49                     "value": {},
50                     "label": "string",
51                     "description": "string",
52                     "color": "string",
53                     "icon": "string",
54                     "meta": {
55                       "string": {}
56                     }
57                   }
58                 ]
59               },
60               "constraints": [
61                 {
62                   "type": "required"
63                 }
64               ]
65             }
66           ]
67         },
68         "messages": [
69           {
70             "type": "error",
71             "content": "string"
72           }
73         ],
74         "mode": "foreground",
75         "mount": {
76           "type": "sheet",
77           "slugs": [
78             "string"
79           ]
80         },
81         "operation": "string",
82         "primary": true,
83         "schedule": "weekly",
84         "tooltip": "string",
85         "type": "string",
86         "requireAllValid": true,
87         "requireSelection": true,
88         "slug": "string"
89       }
90     ],
91     "origin": "filesystem"
92   }
93 }

Request

This endpoint expects a multipart form containing a file.

spaceIdstringRequired

Space ID

environmentIdstringRequired

Environment ID

modeenumOptional

The storage mode of file to insert, defaults to “import”

Allowed values:

filefileRequired

actionslist of objectsOptional

The actions attached to the file

originenumOptional

The origin of the file, ie filesystem

Allowed values:

Response

This endpoint returns an object.

dataobject

Any uploaded file of any type

Upload a file

Headers

Request

Response

Errors