Skip to main content

​
Overview

This guide walks through creating a workbook agent called Attraction Rating (rates attractions on a 1-10 scale), enabling it for API use, and managing versions.

​
1) Create the agent in a workbook

Open the agent pane and create a new agent. Create a new agent from the agent pane Add the prompt, then scroll down and click Add column. Enter the prompt and click Add column

​
2) Edit the agent settings

After the column is added to the table, click the column header and select Edit agent. Open the column menu and choose Edit agent

​
3) Enable API usage

In the agent editor, click Advanced and then click Use in API. Advanced settings with the Use in API button This opens the API enablement panel. You can add a description and optionally rename the API attribute. This is a preview of the agent you are adding. Enable API usage panel with name and description Scroll down and click Enable API usage. Enable API usage button Once enabled, you will see a confirmation that it is ready to use. API usage enabled confirmation

​
4) Call the agent from the API

Use the attribute_key shown in the UI with the /enrich endpoint. 
# Use the default version (no version param)
curl --request POST \
  --url https://api.reprompt.io/v2/enrich \
  --header 'Authorization: Bearer {YOUR_API_KEY}' \
  --header 'Content-Type: application/json' \
  --data '{
    "attribute_key": "attraction_rating",
    "inputs": {
      "name": "Golden Gate Bridge",
      "full_address": "Golden Gate Bridge, San Francisco, CA"
    }
  }'

​
5) Edit the agent and create a new version

To make changes, return to the agent editor, update the prompt, and click Use in API again. The text below will show which version you are about to create (for example, “will save as version 2 of Attraction Rating”). Edit agent prompt and see the next version number Click Save. The confirmation will show which version will be saved. Save new version confirmation After saving, the agent is ready to use. Any API callers without a version parameter will now use the default version. Agent ready to use with default version behavior

​
6) Manage default versions

Click Saved enrichments to view all versions. The default version is labeled and shows API enabled. Saved enrichments showing default version and API enabled status To change the default, find the version you want and click Set as default. Set a different version as default The header updates to show the new default. Calls without a version parameter will now use this version. Default version updated in the header