Editor Agents

Editor Agents enable you to integrate your own API endpoint, such as your own model hosted on a server (or in a cloud function), with Encord to enhance your annotation processes. Agents can be called while annotating in the Label Editor.

​

1. Set up an Editor Agent

First, you must create the agent. An example using ChatGPT-4o can be found here.

​

2. Register an Editor Agent

To register an Agent in Encord:

1. Navigate to the Agents section of the Encord platform.
2. Ensure you are in the Editor Agents screen.
3. Click + Register agent to set up a new editor Agent.

3. Give the Agent a meaningful name and description.

4. Enter the API endpoint for the agent. This Endpoint is called when the Agent is run in the Label Editor.

5. Click Register agent to register the Agent with Encord.

​

3. Test the Editor Agent

After an Agent is registered, the Agent can be tested. We strongly recommend testing an Agent before using it in the Label Editor.

To test an Agent:

1. Navigate to the Agents section of the Encord platform.

2. Click the Agent you want to test.

3. Click Test agent. The Test payload is sent to the API endpoint.

   A notification appears telling you whether the API endpoint was reached appears at the top of your screen.

​

4. Use the Editor Agent in the Label Editor

To use the registered Agent during annotation:

1. Click Automated labeling in the bottom left of the screen. The automated labeling drawer appears.

2. Open the Agents section of the automated labeling drawer.

3. Select the Agent you want to use from the dropdown.

4. Click Trigger agent to trigger the Agent and call the API endpoint.