Uploads a file to Kintone.

When a file is uploaded, it produces a fileKey.
Note that although this API uploads a file to Kintone, it does not upload the file to an Attachment field of an App.
To upload the file to an Attachment field, the fileKey is used with the Add Record or Update Record API.

No record related permissions are needed, as this API does not directly attach a file to an App.

The request is sent in a multipart/form-data format. For more information, refer to the following RFC documents:

• RFC1867: Form-based File Upload in HTML
• RFC7578: Returning Values from Forms: multipart/form-data

Within the Content-Disposition header, specify "file" for the name parameter and the name of the file for the filename parameter.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

var blob = new Blob(['Sample Test File'], {type: 'text/plain'});
var formData = new FormData();
formData.append('__REQUEST_TOKEN__', kintone.getRequestToken());
formData.append('file', blob, 'test.txt');

var url = 'https://{subdomain}.kintone.com/k/v1/file.json';
var xhr = new XMLHttpRequest();
xhr.open('POST', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send(formData);

1
2
3

curl -X POST 'https://{subdomain}.kintone.com/k/v1/file.json' \
  -H 'X-Cybozu-API-Token: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx' \
  -F 'file=@FILEPATH'

1
2
3

{
  "fileKey": " c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
}

There are two types of fileKeys used in Kintone REST APIs.

• Upload File API filekey
  • Ex: c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6
  • This fileKey is used to update a record with an Attachment field, or add a record with an attachment.
  • This article discusses this type of fileKey
• Get Record API filekey
  • Ex: 201202061155587E339F9067544F1A92C743460E3D12B3297
  • This fileKey is used when downloading a file from an Attachment field.
  • This article does not cover this type of fileKey.

Use the following APIs, and set the value of the fileKey as the fileKey obtained from the Upload File API, as shown in the example body below.
Add Record
Add Records
Update Record
Update Records

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "app": 3,
  "id": 6,
  "record": {
    "attached_file": {
      "value": [
        {
          "fileKey": " c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"
        }
      ]
    }
  }
}

Only 1 file can be uploaded at a time.
After the file is uploaded onto Kintone, the file will be deleted after 3 days if the Add Record or Update Record API is not used.
This API cannot be called with the following API:
Kintone REST API Request API
For other limitations, refer to the following document:
Kintone REST API Limitations