How do the agent API actions work?

Setup

1. Give your API action a name and a description. These values will be passed to the AI, so make them descriptive of what the action is for.

2. Select the HTTP Method of your API call

3. Define the URL of your API endpoint. For path parameters, use double curly brackets, {{, for example https://api.company.com/accounts/{id}

   1. This will become a variable you can insert within a Runbook.

4. Add in any relevant headers. Note that headers do NOT support variables.

5. If a POST or PATCH request, add in the body payload

   1. Use the {{ characters to create a variable.

      

   2. Remember to enclose string values with quotes!

6. Paste in an example response payload

7. Hit save

Behavior

When defining a Runbook, you will specify how variables in your runbook map into variables required for your API call.

When a runbook is executing and reaches an API action step, it will inject values from the runbook based on your mapping.

If you are looking to extract a nested field, use dot notation to specify the exact field when calling the Action in the Runbook (e.g. data[0].id). If the field does not exist, an empty value will be returned.

Examples