Delete agent tool message

curl --request DELETE \
  --url https://realtime-api.voiceflow.com/v1/stable/agent/tool-message \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.delete(
    'https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "message": "<string>"
}

Delete agent tool message

Clears one message slot on one of the agent’s tools, discarding its examples and unlinking its scripted response. The response carries only a confirmation message, so refetch the agent’s tool to see its remaining messages.

DELETE

/v1/stable/agent/tool-message

curl --request DELETE \
  --url https://realtime-api.voiceflow.com/v1/stable/agent/tool-message \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.delete(
    'https://realtime-api.voiceflow.com/v1/stable/agent/tool-message?projectID=<projectID>&environmentAlias=<environmentAlias>&slot=<slot>&toolID=<toolID>&nativeTool=<nativeTool>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Query Parameters

projectID

string

required

The ID of the project to operate on.

environmentAlias

string

required

The alias of the environment to operate on (e.g. main).

slot

object

required

Which of the tool's four messages to write. execution is said when the tool starts (the editor labels it Start), completion when it finishes (Complete), failure when it errors (Failed), delay when it is taking a while (Delayed).

Available options: delay, failure, execution, completion

toolID

string

A tool attached to this agent or playbook. Cannot be used with nativeTool.

nativeTool

object

Show child attributes

Response

200 - application/json

Confirms the message in the requested slot was removed.

message

string

required

A human-readable message confirming the deletion.

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

Delete agent tool message

Authorizations

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks