'FastAPI throws an error (Error loading ASGI app. Could not import module "api")

I tried to run FastAPI using uvicorn webserver but it throws an error.

I run this command,

uvicorn api:app --reload --host 0.0.0.0

but there is an error in the terminal.

Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
Started reloader process [23445]
Error loading ASGI app. Could not import module "api".
Stopping reloader process [23445]

Solution 1:^[1]

TL;DR

Add the directory name in front of your filename

uvicorn src.main:app

or cd into that directory

cd src
uvicorn main:app

Long Answer

It happens because you are not in the same folder with your FastAPI app instance more specifically:

Let's say i have an app-tree like this;

my_fastapi_app/
??? app.yaml
??? docker-compose.yml
??? src
?   ??? main.py
??? tests
    ??? test_xx.py
    ??? test_yy.py

$ pwd         # Present Working Directory
/home/yagiz/Desktop/my_fastapi_app

I'm not inside the same folder with my app instance, so if I try to run my app with uvicorn I'll get an error like yours

$ uvicorn main:app --reload
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [40645] using statreload
ERROR:    Error loading ASGI app. Could not import module "main".

The answer is so simple, add the folder name in front of your filename

uvicorn src.main:app --reload

or you can change your working directory

cd src

Now i'm inside of the folder with my app instance

src
??? main.py

Run your uvicorn again

$ uvicorn main:app --reload
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [40726] using statreload
INFO:     Started server process [40728]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Solution 2:^[2]

I had the same problem and solved it adding package name before main, in your case trying:

uvicorn src.main:app --reload

may solve the problem

Solution 3:^[3]

One reason this might be happening is that you are using:

uvicorn src/main:app --reload

instead of the correct syntax:

uvicorn src.main:app --reload

Notice the . instead of the /

That's assuming that (1) your structure is something like this:

project_folder/
??? some_folder
??? src
?   ??? main.py
??? tests
    ??? test_xx.py
    ??? test_yy.py

(2) that your FastAPI() object is indeed assigned to an object named app in main.py:

app = FastAPI()

(3) you are running the uvicorn command from the project_folder, e.g.:

(venv) <username>@<pcname>:~/PycharmProjects/project_folder$ uvicorn src.main:app --reload

Solution 4:^[4]

It seems it is important that you name your file main.py otherwise it won't work.

Edit: Actually I was running Jupyter Notebook on port 8888 so that port was already occupied. If you have to run Jupyter notebook, run it after running the API server, the notebook will automatically run on 8889. Alternatively, you can run the API server on a different port.

Solution 5:^[5]

This worked for me look at the docs for fastAPI. I am very thankful I ran accross that as the Python script needs to be named main.py not app.py

The command uvicorn main:app refers to:

main: the file main.py (the Python "module").
app: the object created inside of main.py with the line app = FastAPI()
--reload: make the server restart after code changes. Only use for development.

Solution 6:^[6]

Hit the Save button in VS Code etc because sometimes it will throw this error if you have not saved the file. Happened to me.

Solution 7:^[7]

Use this folder structure and configuration where main is in parent directory

launch.json

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: FastAPI",
            "type": "python",
            "request": "launch",
            "module": "uvicorn",
            "args": [
                "main:app"
            ],
            "jinja": true
        }
    ]
}

main.py

from fastapi import FastAPI
app = FastAPI(
    title="test",
    description="test",
    version="0.0.1",
)
if __name__ == "__main__":
import uvicorn

uvicorn.run(
    "main:app",
    host="0.0.0.0",
    reload=True,
    port=3001,
)

Solution 8:^[8]

moving the import statement for FastAPI to the top of the import statements fixes the error.

from fastapi import FastAPI
# then any other import statement

Sources

This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.

Source: Stack Overflow

Solution	Source
Solution 1
Solution 2	Mahdi Gheidi
Solution 3
Solution 4
Solution 5	bbartling
Solution 6	Gul Saeed Khattak
Solution 7	Ajay Tom George
Solution 8	Javad Nikbakht

'FastAPI throws an error (Error loading ASGI app. Could not import module "api")

Solution 1:[1]

TL;DR

Long Answer

Solution 2:[2]

Solution 3:[3]

Solution 4:[4]

Solution 5:[5]

Solution 6:[6]

Solution 7:[7]

Solution 8:[8]