GET
/
tools
/
{id}
curl --request GET \
  --url https://app.happyrobot.ai/api/v1/tools/{id} \
  --header 'authorization: <authorization>'
[
  {
    "id": "<string>",
    "use_case_id": "<string>",
    "organization_id": "<string>",
    "type": "Endpoint",
    "name": "<string>",
    "description": "<string>",
    "default": false,
    "generate_filler_message": true,
    "data": {},
    "prompt_id": "<string>",
    "filler_type": "none",
    "filler_description": "<string>",
    "filler_example": "<string>",
    "position": {
      "x": 0,
      "y": 0
    }
  }
]

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

Path Parameters

​
id
string
required
Required string length: 24

Query Parameters

​
prompt_id
string

Response

200
application/json
200
​
id
string
required
​
use_case_id
string
required
​
organization_id
string
required
​
type
enum<string>
required
Available options:
Endpoint,
DirectTransferCall,
BranchTransferCall,
TerminateCall,
Conditional,
PhoneTreeNavigation
​
name
string
required
Required string length: 2 - 60
​
description
string
required
Minimum length: 10
​
data
object
required
​
prompt_id
string
required
​
default
boolean
default:
false
​
generate_filler_message
boolean
default:
true
​
filler_type
enum<string>
default:
none
Available options:
hardcoded,
aigen,
none
​
filler_description
string
​
filler_example
string
​
position
object

Was this page helpful?

Delete a callGet Campaigns