Upload Files | Athena | API Reference Docs

Set up environment

1 !pip install -U athena-intelligence

1 import os
2 import io
3 import asyncio
4 from athena.client import Athena
5 
6 ATHENA_API_KEY = os.environ["ATHENA_API_KEY"]
7 
8 athena = Athena(
9     api_key=ATHENA_API_KEY,
10 )

Upload a data frame or a plot

Athena SDK can save pandas DataFrames as assets out of the box:

1 data_frame = pd.DataFrame({"column": [1, 2, 3]})
2 result = athena.tools.save_asset(data_frame, name="My data frame")
3 print(result)

The result will contain the asset_id.

It can also save most plots objects which support IPython display protocol, for example:

1 fig = plt.figure(figsize=(10, 6))
2 plt.plot([0, 1, 2, 3, 4, 5], [1, 2, 4, 8, 16, 32])
3 plt.show()
4 client.tools.save_asset(fig, name="Powers of two")

You can set the parent_folder_id to upload the file (or plot/data frame) to a specific folder.

Upload a file

To upload a file using the Athena SDK, you can use the athena.tools.save_asset() method. This method accepts a file tuple containing the filename, file content as a BytesIO object, and the MIME type.

Here’s an example of how to upload an Excel file:

1 async def upload_file():
2     # Prepare the file for upload
3     file_bytes = io.BytesIO()
4     with open("your_file.xlsx", "rb") as f:
5         file_bytes.write(f.read())
6         file_bytes.seek(0)  # Reset the cursor of the BytesIO object
7 
8     # Create the file tuple
9     file_tuple = (
10         "your_file.xlsx",
11         file_bytes,
12         "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
13     )
14 
15     # Upload the file
16     result = await athena.tools.save_asset(file_tuple)
17     print(result)
18 
19 # Run the async function
20 await upload_file()

In this example:

We open the file and read its contents into a BytesIO object.
We create a tuple containing the filename, the BytesIO object, and the MIME type.
We call athena.tools.save_asset() with our file tuple.
The function returns the result of the upload operation.

Using with FastAPI

If you’re using FastAPI and want to upload files received from a client, you can use the UploadFile object:

1 from fastapi import FastAPI, UploadFile
2 
3 app = FastAPI()
4 
5 @app.post("/upload/")
6 async def upload_file(file: UploadFile):
7     file_tuple = (file.filename, file.file, file.content_type)
8     result = await athena.tools.save_asset(file_tuple)
9     return {"message": "File uploaded successfully", "result": result}

This endpoint will accept file uploads and forward them to the Athena API using the SDK.

Remember to handle exceptions and implement proper error checking in your production code.

1	import os
2	import io
3	import asyncio
4	from athena.client import Athena
5
6	ATHENA_API_KEY = os.environ["ATHENA_API_KEY"]
7
8	athena = Athena(
9	api_key=ATHENA_API_KEY,
10	)

1	data_frame = pd.DataFrame({"column": [1, 2, 3]})
2	result = athena.tools.save_asset(data_frame, name="My data frame")
3	print(result)

1	fig = plt.figure(figsize=(10, 6))
2	plt.plot([0, 1, 2, 3, 4, 5], [1, 2, 4, 8, 16, 32])
3	plt.show()
4	client.tools.save_asset(fig, name="Powers of two")

1	async def upload_file():
2	# Prepare the file for upload
3	file_bytes = io.BytesIO()
4	with open("your_file.xlsx", "rb") as f:
5	file_bytes.write(f.read())
6	file_bytes.seek(0) # Reset the cursor of the BytesIO object
7
8	# Create the file tuple
9	file_tuple = (
10	"your_file.xlsx",
11	file_bytes,
12	"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
13	)
14
15	# Upload the file
16	result = await athena.tools.save_asset(file_tuple)
17	print(result)
18
19	# Run the async function
20	await upload_file()

1	from fastapi import FastAPI, UploadFile
2
3	app = FastAPI()
4
5	@app.post("/upload/")
6	async def upload_file(file: UploadFile):
7	file_tuple = (file.filename, file.file, file.content_type)
8	result = await athena.tools.save_asset(file_tuple)
9	return {"message": "File uploaded successfully", "result": result}