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": true,
    "generate_filler_message": true,
    "data": {},
    "prompt_id": "<string>",
    "filler_type": "hardcoded",
    "filler_description": "<string>",
    "filler_example": "<string>",
    "position": {
      "x": 123,
      "y": 123
    }
  }
]

Headers

authorization
string
required

Your API key for authentication. Use Bearer format.

Path Parameters

id
string
required

Query Parameters

prompt_id
string

Response

200 - application/json
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
description
string
required
default
boolean
default: false
generate_filler_message
boolean
default: true
data
object
required
prompt_id
string
required
filler_type
enum<string>
default: none
Available options:
hardcoded,
aigen,
none
filler_description
string
filler_example
string
position
object

Was this page helpful?

Returns a list of tools for a use case idGet Campaigns