Choose between "Templates" or "Start from Scratch"

Browse our Templates
Get inspired by our templates to get started

If you select "Templates" you can see what do we have.

If you select "Start from Scratch" you can create a new Custom Action

First select what type of API request you want to do: "Post", "Get", "Put" or "Patch"

Click the "<https://api.example.com/v1/user/profile>" field to add the API address

If it's a GET call, you can add "Query Parameters"

To reference variables, put them between <>.
Key
Value
Add parameter

Click "Authentication" to enable it if requried

Choose the Authentication Location, and add your Bearer token or different Auth type. ! Important we don't support directly Basic Auth (create a token using <https://www.debugbear.com/basic-auth-header-generator>) \
Key = Authorization\
Value = Basic \_\_

Variables can be passed either **"Before the call"** or "**During the call"**

Right now, you can only use “user_phone_number,” which will be replaced by the caller’s phone number. Soon, you’ll be able to add other contact details too.

**"Before the call"** is better for situations where for example you want to pull context from a database/CRM based on a unique identifier as for example the phone_number.

**"During the call"** is good when you want something to happen during the call when the user says/requests something or wants to do a specific action

The variables have 4 inputs: **"Name"**, **"Type"**, **"Description"** and **"Example"**

Moving to **Section 3**: Set up your action Details.

**It's important to know the name** of the action is really important and need to be actionable e.g. Get user information, Send SMS, etc.

The **"Description"** input helps the AI understand what it needs to do, be descriptive but brief

The **"Speech"** is what the AI will say in the call while triggering the API call.

Choose to **run the action before the call starts**, by default runs after the call starts, this depends on your scenario

Click **"Initialize action"** to test your API call. 

Important: You need to initialize it once to complete the set-up of the Custom Action

If you have variables, you will need to provide some values, then click again "Initialize action" button

Click "**Pick action results to use in prompt**" to select what outputs of the API response you want to use

Enable the outputs, to be able to use them in the input below

Now you can write the Custom Action prompt, instructing the AI what to do and how to use the outputs from the response. Tell the AI exactly what do you expect to happen.\
\
Important, you can reference the outputs results by using &lt;api_result&gt;, for example &lt;results.status&gt; from previous step.

Now go back to the Assistant you want to use this Custom Action and add it there.

Creating a Custom Action on Fine-Tuner.ai