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. Any endpoint that accepts a JSON payload can be used to set up an Editor Agent. Agents are triggered while annotating in the Label Editor.

Click here to see comprehensive Editor Agent examples.
Editor Agents differ from Task Agents, which are Workflow components that activate on all tasks passing through the Agent stage.

​
Permissions

Editor Agents are available to all Project user roles, including Admin, Team Manager, Annotator + Reviewer, Annotator, and Reviewer. However, restrictions apply to certain organization-level user roles.

FreemiumTeamEnterprise
Internal✅✅✅
External❌❌✅
Workforce❌❌❌

​
1. Set up an Editor Agent

First, you must create the agent. Several Editor Agent examples, along with detailed guidance on setup, installation, and hosting can be found here.

​
2. Register an Editor Agent

Only HTTPS endpoints are supported.

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.

  1. Give the Agent a meaningful name and description.

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

  3. 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.

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

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

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

Alternatively:

  1. Right-click the editor canvas.
  2. Click Trigger agent.
  3. Select the agent you want to run.

​
Add Editor Agents to Projects

Adding Editor Agents to Projects restricts the selection of agents for automatic labeling for your Annotators and Reviewers.

Only Org and Project Admins can add Editor Agents to a Project.

To add a Editor Agent to a Project:

  1. Go to **Annotate > Project > [select a Project]. The Project page appears.

  2. Click Agents. The Agents page appears.

  3. Click Attach an agent. A dialog appears.

  4. Select one or more Editor Agents to add to the Project.

  5. Click Save. The Task Agents appear in the Task Agent list.

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. Any endpoint that accepts a JSON payload can be used to set up an Editor Agent. Agents are triggered while annotating in the Label Editor.

Click here to see comprehensive Editor Agent examples.
Editor Agents differ from Task Agents, which are Workflow components that activate on all tasks passing through the Agent stage.

​
Permissions

Editor Agents are available to all Project user roles, including Admin, Team Manager, Annotator + Reviewer, Annotator, and Reviewer. However, restrictions apply to certain organization-level user roles.

FreemiumTeamEnterprise
Internal✅✅✅
External❌❌✅
Workforce❌❌❌

​
1. Set up an Editor Agent

First, you must create the agent. Several Editor Agent examples, along with detailed guidance on setup, installation, and hosting can be found here.

​
2. Register an Editor Agent

Only HTTPS endpoints are supported.

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.

  1. Give the Agent a meaningful name and description.

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

  3. 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.

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

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

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

Alternatively:

  1. Right-click the editor canvas.
  2. Click Trigger agent.
  3. Select the agent you want to run.

​
Add Editor Agents to Projects

Adding Editor Agents to Projects restricts the selection of agents for automatic labeling for your Annotators and Reviewers.

Only Org and Project Admins can add Editor Agents to a Project.

To add a Editor Agent to a Project:

  1. Go to **Annotate > Project > [select a Project]. The Project page appears.

  2. Click Agents. The Agents page appears.

  3. Click Attach an agent. A dialog appears.

  4. Select one or more Editor Agents to add to the Project.

  5. Click Save. The Task Agents appear in the Task Agent list.