Delete Agent

Delete agent

curl --request DELETE \
  --url https://api.inya.ai/platform/v1/agents/{botId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.inya.ai/platform/v1/agents/{botId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agent deleted successfully",
  "response": {
    "botId": "fb79920229d144608ebf665a10e50275"
  }
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

DELETE

agents

{botId}

Delete agent

curl --request DELETE \
  --url https://api.inya.ai/platform/v1/agents/{botId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.inya.ai/platform/v1/agents/{botId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agent deleted successfully",
  "response": {
    "botId": "fb79920229d144608ebf665a10e50275"
  }
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

Overview

Permanently delete a voice agent and all of its associated configuration from your organization. This action cannot be undone.

Required Permission

agents

Path Parameters

Name	Type	Required	Description
`botId`	string	Yes	Unique agent identifier.

Example cURL

curl -X DELETE "https://api.inya.ai/platform/v1/agents/fb79920229d144608ebf665a10e50275" \
  -H "x-api-key: <your_api_key>"

Response

Success (200)

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agent deleted successfully",
  "response": { "botId": "fb79920229d144608ebf665a10e50275" }
}

Error Responses

403 Forbidden - Insufficient permissions or agent not found

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "User does not have access to this bot"
}

Use Cases

Removing outdated or unused agents from your organization
Cleaning up test agents after development
Decommissioning agents after a project is completed

This action is permanent and cannot be undone. All agent configuration, FAQ entries, and settings will be removed. Ensure you have a backup of any configuration you may need before deleting.

Save the requestId from every response. You will need it if you contact Inya support to trace a specific request.

Authorizations

x-api-key

string

header

required

API key with 'agents' permission

Path Parameters

botId

string

required

Unique identifier of the agent

Response

Agent deleted successfully

status

string

Example:

"success"

requestId

string

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

message

string

response

object

Getting Started

Agents API

Conversations API

Agent Config API

Agent FAQ API

Chat SDK API

Reference

Overview

Required Permission

Path Parameters

Example cURL

Response

Success (200)

Error Responses

Use Cases

Authorizations

Path Parameters

Response

​Overview

​Required Permission

​Path Parameters

​Example cURL

​Response

​Success (200)

​Error Responses

​Use Cases

Authorizations

Path Parameters

Response

Overview

Required Permission

Path Parameters

Example cURL

Response

Success (200)

Error Responses

Use Cases