POST
/
tools
curl --request POST \
  --url https://app.happyrobot.ai/api/v1/tools \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "use_case_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>"
}'
{
  "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>"
}

Headers

authorization
string
required

Your API key for authentication. Use Bearer format.

Body

application/json
use_case_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

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

Was this page helpful?

Delete a toolReturns a list of tools for a use case id