File APIs¶
You can use File APIs to remotely send and upload files to your Workspace storage and insert them into any of your table within the database. The default root folder for all user files is set to "drive."
Warning
-
File API supports image, audio, and video data with the following extensions:
- Image: "jpg", "png", "jpeg"
- Audio: "mp3", "wav
- Video: "mp4", "wmv", "avi"
-
Files with extensions not listed above are stored in the "drive/others" folder.
GET /file/¶
A list of files and folders is returned from a specified file path. The file path can be expressed using a regular expression.
import requests
import json
api_token = "Issued_API_TOKEN"
file_path = "File Path"
api_url = f"https://{your-engine-url}/api/v1/file/?file_path={file_path}"
header = {
"Authorization": f"Bearer {api_token}"
}
r = requests.get(api_url, headers=header)
r.raise_for_status()
return_json = r.json()
curl -X 'GET' \
'https://{your-engine-url}/api/v1/file/?file_path={file_path}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer Issued_API_TOKEN' \
-H 'Content-Type: application/json'
POST /file/¶
In order to upload a file, use the below methods to send a file to the Workspace storage. When the "dir=folder name" is added to the URL, the file will be uploaded to the designated folder.
import requests
import json
api_token = "Issued_API_TOKEN"
api_url = "https://{your-engine-url}/api/v1/file/"
header = {
"Authorization": f"Bearer {api_token}"
}
files = {'file': open('Data File Path', 'rb')}
r = requests.post(api_url, files=files, headers=header)
r.raise_for_status()
return_json = r.json()
curl -X 'POST' \
'https://{your-engine-url}/api/v1/file/' \
-H 'accept: application/json' \
-H 'Authorization: Bearer Issued_API_TOKEN' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@Data File Path;type=file_type/Data File Type'
If "db_commit" is set to True and "table_name" and "column_name" are specified, the given file is sent to Workspace storage and the file path is inserted into the specified column of the specified table.
import requests
import json
api_token = "Issued_API_TOKEN"
base_url = "https://{your-engine-url}/api/v1/file/"
table_name = "Table Name"
column_name = "Column Name"
db_commit = True
api_url = f"{base_url}?db_commit={db_commit}&table_name={table_name}&column_name={column_name}"
header = {
"Authorization": f"Bearer {api_token}"
}
files = {'file': open('Data File Path', 'rb')}
r = requests.post(api_url, files=files, headers=header)
r.raise_for_status()
return_json = r.json()
curl -X 'POST' \
'https://{your-engine-url}/api/v1/file/?db_commit={db_commit}&table_name={table_name}&column_name={column_name}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer Issued_API_TOKEN' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@Data File Path;type=file_type/Data File Type'
FAQ
- In order to use a file within the Jupyter workspace, you must put '/'home/jovyan' in front of the path.
DELETE /file/¶
In order to delete a file from the Workspace storage, use the below methods.
import requests
import json
api_token = "Issued_API_TOKEN"
file_path = "Data File Path"
api_url = f"https://{your-engine-url}/api/v1/file/?file_path={file_path}'
header = {
"Authorization": f"Bearer {api_token}"
}
r = requests.delete(api_url, headers=header)
r.raise_for_status()
return_json = r.json()
curl -X 'DELETE' \
'https://{your-engine-url}/api/v1/file/?file_path={file_path}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer Issued_API_TOKEN' \
-H 'Content-Type: application/json'
If "db_commit" is set to True and "table_name" and "column_name" are specified, the given file is deleted from Workspace storage, and all rows in the table with the same value as the given file path in the specified column will be deleted.
import requests
import json
api_token = "Issued_API_TOKEN"
base_url = "https://{your-engine-url}/api/v1/file/"
db_commit = True
file_path = 'File Path'
table_name = 'Table Name'
column_name = 'Column Name'
api_url = f"{base_url}?db_commit={db_commit}&file_path={file_path}&table_name={table_name}&column_name={column_name}"
header = {
"Authorization": f"Bearer {api_token}"
}
r = requests.delete(api_url, headers=header)
r.raise_for_status()
return_json = r.json()
curl -X 'DELETE' \
'https://{your-engine-url}/api/v1/file/?db_commit={db_commit}&file_path={file_path}&table_name={table_name}&column_name={column_name}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer Issued_API_TOKEN' \
-H 'Content-Type: application/json'