FastAPI

​

STEP 1: Create a Project

1. Create a new Encord Project:

mkdir my_project
cd my_project

2. Create and source a new virtual environment.

python -m venv venv
source venv/bin/activate

3. Install dependencies.

python -m pip install "fastapi[standard]" encord-agents

​

STEP 2: Define the Agent

Create a main.py file using the following template:

from typing_extensions import Annotated

from encord.objects.ontology_labels_impl import LabelRowV2
from encord_agents import FrameData
from encord_agents.fastapi import dep_label_row
from encord_agents.fastapi.cors import EncordCORSMiddleware

from fastapi import FastAPI, Depends, Form

app = FastAPI()
app.add_middleware(EncordCORSMiddleware)

@app.post("/my_agent")
def my_agent(
    frame_data: FrameData,
    label_row: Annotated[LabelRowV2, Depends(dep_label_row)],
):
    # ... Do your edits to the labels
    label_row.save()

Complete the my_agent function with the logic you want to execute when the agent is triggered.

You can find multiple examples of what can be done with editor agents here.

​

STEP 3: Test the Agent

Trigger the agent by running it locally.

ENCORD_SSH_KEY_FILE=/path/to/your_private_key \
    fastapi dev main.py --port 8080

{
    "projectHash": "<project_hash>",
    "dataHash": "<data_hash>",
    "frame": <frame_number>
}

To test the agent endpoint, open the Label Editor in your browser on a frame where you want to run the agent. Then, copy the URL.

Open a new terminal in the my_project directory and run:

source venv/bin/activate
encord-agents test local my_agent '<the_pasted_url>'

Refresh the Label Editor in your browser to see the effect.

​

STEP 4: Deployment

Meanwhile, refer to the official FastAPI documentation.