---
title: "Agents API Reference"
description: "Agents are chat personas a workspace builds: a role, a tone, guardrails and knowledge documents. An agent talks to visitors from the workflow steps it is plugged into, such as the Chat Bot step."
canonical: "https://linkbreakers.com/help/api/agents"
---

# Agents

Agents are chat personas a workspace builds: a role, a tone, guardrails and knowledge documents. An agent talks to visitors from the workflow steps it is plugged into, such as the Chat Bot step.

## Agents

## [#](#agents-object)The Agent Knowledge Document object

AgentKnowledgeDocument is one Markdown document the agent knows.

agentId

string

The agent the document belongs to (UUID).

content

string

The document's Markdown content.

createdAt

string (date-time)

When the document was created.

id

string

The unique identifier of the document (UUID).

title

string

The document's title.

updatedAt

string (date-time)

When the document was last updated.

Example object

```json
{
  "agentId": "string",
  "content": "# Opening hours\n\nMonday to Friday, 9am to 6pm.",
  "createdAt": "2026-11-01T17:04:23.947Z",
  "id": "string",
  "title": "Opening hours and prices",
  "updatedAt": "2026-11-01T17:04:23.947Z"
}
```

GET

`/v1/agent-presets`

Requires auth

## [#](#list-agent-presets)List agent presets

List every preset agent settings can take, with labels and descriptions. Requires the \`agents:read\` scope.

### [#](#list-agent-presets-parameters)Parameters

This endpoint does not accept any parameters.

### [#](#list-agent-presets-response)Response

200

Everything worked as expected.

guardrails

array<object>

The guardrails.

limits

object

AgentLimits are the sizes agent settings and knowledge must stay within.

questionHandlings

array<object>

The ways to handle visitor questions.

replyLengths

array<object>

The reply lengths.

roles

array<object>

The roles.

tones

array<object>

The tones.

### [#](#list-agent-presets-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X GET "https://api.linkbreakers.com/v1/agent-presets" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{
  "guardrails": [
    {
      "defaultEnabled": false,
      "description": "string",
      "label": "string",
      "value": "AGENT_GUARDRAIL_UNSPECIFIED"
    }
  ],
  "limits": {
    "chatBotDefaultExchanges": 0,
    "chatBotMaxExchanges": 0,
    "chatBotMaxObjectives": 0,
    "chatBotMinExchanges": 0,
    "customRulesMaxLength": 0,
    "instructionsMaxLength": 0,
    "knowledgeMaxDocuments": 0,
    "knowledgeMaxTotalCharacters": 0,
    "knowledgeTitleMaxLength": 0,
    "nameMaxLength": 0,
    "styleNotesMaxLength": 0
  },
  "questionHandlings": [
    {
      "description": "string",
      "label": "string",
      "value": "AGENT_QUESTION_HANDLING_UNSPECIFIED"
    }
  ],
  "replyLengths": [
    {
      "description": "string",
      "label": "string",
      "value": "AGENT_REPLY_LENGTH_UNSPECIFIED"
    }
  ],
  "roles": [
    {
      "description": "string",
      "label": "string",
      "value": "AGENT_ROLE_UNSPECIFIED"
    }
  ],
  "tones": [
    {
      "description": "string",
      "label": "string",
      "value": "AGENT_TONE_UNSPECIFIED"
    }
  ]
}
```

Base URL: `https://api.linkbreakers.com`

GET

`/v1/agents`

Requires auth

## [#](#list-agents)List agents

List the workspace's agents, without their knowledge documents. Requires the \`agents:read\` scope.

### [#](#list-agents-parameters)Parameters

#### query parameters

pageSize

integer (int64)

query

Maximum number of agents to return. Defaults to 50.

pageToken

string

query

Token from a previous response's next\_page\_token.

cursor

string

query

Opaque cursor from the previous page's nextPageToken. Same as pageToken; when both are sent, pageToken wins.

### [#](#list-agents-response)Response

200

Everything worked as expected.

agents

array<object>

The agents, without their knowledge documents.

nextPageToken

string

Token for the next page. Empty on the last page.

totalCount

integer (int64)

How many agents the workspace has. Set on the last page only.

### [#](#list-agents-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X GET "https://api.linkbreakers.com/v1/agents?pageSize={pageSize}&pageToken={pageToken}&cursor={cursor}" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{
  "agents": [
    {
      "createdAt": "2026-11-01T17:04:23.945Z",
      "customRules": "string",
      "emojiEnabled": false,
      "guardrails": [
        "AGENT_GUARDRAIL_UNSPECIFIED"
      ],
      "id": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
      "instructions": "You work for Hotel Lumiere, a boutique hotel in Lyon.",
      "knowledgeDocumentCount": 0,
      "knowledgeDocuments": [
        {}
      ],
      "language": "fr",
      "name": "Front desk",
      "questionHandling": "AGENT_QUESTION_HANDLING_UNSPECIFIED",
      "replyLength": "AGENT_REPLY_LENGTH_UNSPECIFIED",
      "role": "AGENT_ROLE_UNSPECIFIED",
      "styleNotes": "Address visitors informally.",
      "tone": "AGENT_TONE_UNSPECIFIED",
      "updatedAt": "2026-11-01T17:04:23.945Z",
      "usages": [
        {}
      ],
      "workspaceId": "string"
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
```

Base URL: `https://api.linkbreakers.com`

GET

`/v1/agents/{id}`

Requires auth

## [#](#get-an-agent)Get an agent

Retrieve an agent with its knowledge documents. Requires the \`agents:read\` scope.

### [#](#get-an-agent-parameters)Parameters

#### path parameters

id

string

Required

path

The agent's ID (UUID).

### [#](#get-an-agent-response)Response

200

Everything worked as expected.

agent

object

Agent is a chat persona the workspace builds and plugs into workflow steps.

### [#](#get-an-agent-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X GET "https://api.linkbreakers.com/v1/agents/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{
  "agent": {
    "createdAt": "2026-11-01T17:04:23.946Z",
    "customRules": "string",
    "emojiEnabled": false,
    "guardrails": [
      "AGENT_GUARDRAIL_UNSPECIFIED"
    ],
    "id": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
    "instructions": "You work for Hotel Lumiere, a boutique hotel in Lyon.",
    "knowledgeDocumentCount": 0,
    "knowledgeDocuments": [
      {
        "agentId": "string",
        "content": "# Opening hours\n\nMonday to Friday, 9am to 6pm.",
        "createdAt": "2026-11-01T17:04:23.946Z",
        "id": "string",
        "title": "Opening hours and prices",
        "updatedAt": "2026-11-01T17:04:23.946Z"
      }
    ],
    "language": "fr",
    "name": "Front desk",
    "questionHandling": "AGENT_QUESTION_HANDLING_UNSPECIFIED",
    "replyLength": "AGENT_REPLY_LENGTH_UNSPECIFIED",
    "role": "AGENT_ROLE_UNSPECIFIED",
    "styleNotes": "Address visitors informally.",
    "tone": "AGENT_TONE_UNSPECIFIED",
    "updatedAt": "2026-11-01T17:04:23.946Z",
    "usages": [
      {
        "linkId": "string",
        "linkName": "string",
        "workflowStepId": "string"
      }
    ],
    "workspaceId": "string"
  }
}
```

Base URL: `https://api.linkbreakers.com`

POST

`/v1/agents`

Requires auth

## [#](#create-an-agent)Create an agent

Create an agent. Presets left unset take their defaults. Requires the \`agents:write\` scope.

### [#](#create-an-agent-parameters)Parameters

#### header parameters

Idempotency-Key

string

header

Makes retrying this request safe. See components.parameters.IdempotencyKey.

### [#](#create-an-agent-request)Request body

customRules

string

Free-text rules the agent never breaks.

emojiEnabled

boolean

Whether the agent may use emoji. Off when unset.

guardrails

array<string (enum)>

The preset rules the agent never breaks. Leave empty for the defaults.

instructions

string

Free-text instructions that refine the role.

language

string

ISO 639-1 code of the language the agent always speaks. Empty matches the visitor's language.

name

string

Required

The agent's name.

questionHandling

string (enum)

AgentQuestionHandling is what the agent does when a visitor asks it something.

##### Allowed values

`AGENT_QUESTION_HANDLING_UNSPECIFIED`

Not set. Defaults to AGENT\_QUESTION\_HANDLING\_ANSWER\_AND\_STEER on create, keeps the value on update.

`AGENT_QUESTION_HANDLING_ANSWER_AND_STEER`

Answers, then brings the conversation back to its goal.

`AGENT_QUESTION_HANDLING_ANSWER_BRIEFLY`

One-line answers, then back to the goal.

`AGENT_QUESTION_HANDLING_COLLECT_ONLY`

Politely declines questions and only collects.

`AGENT_QUESTION_HANDLING_FREE_CONVERSATION`

Talks freely and collects along the way.

replyLength

string (enum)

AgentReplyLength is how long the agent's messages are.

##### Allowed values

`AGENT_REPLY_LENGTH_UNSPECIFIED`

Not set. Defaults to AGENT\_REPLY\_LENGTH\_SHORT on create, keeps the value on update.

`AGENT_REPLY_LENGTH_SHORT`

One or two sentences.

`AGENT_REPLY_LENGTH_MEDIUM`

A short paragraph.

`AGENT_REPLY_LENGTH_DETAILED`

As long as the answer needs.

role

string (enum)

AgentRole is the job the agent does for the workspace.

##### Allowed values

`AGENT_ROLE_UNSPECIFIED`

Not set. Defaults to AGENT\_ROLE\_CUSTOM on create, keeps the value on update.

`AGENT_ROLE_LEAD_QUALIFIER`

Qualifies leads: learns who the visitor is and what they need.

`AGENT_ROLE_EVENT_CONCIERGE`

Welcomes event attendees and answers practical questions.

`AGENT_ROLE_FEEDBACK_COLLECTOR`

Collects feedback about an experience.

`AGENT_ROLE_PRODUCT_EXPERT`

Presents a product and answers questions about it.

`AGENT_ROLE_SUPPORT_FAQ`

Answers frequent support questions.

`AGENT_ROLE_CUSTOM`

No preset role: the agent follows its instructions only.

styleNotes

string

Free-text notes that refine the tone.

tone

string (enum)

AgentTone is how the agent sounds.

##### Allowed values

`AGENT_TONE_UNSPECIFIED`

Not set. Defaults to AGENT\_TONE\_FRIENDLY on create, keeps the value on update.

`AGENT_TONE_FRIENDLY`

Warm and approachable.

`AGENT_TONE_PROFESSIONAL`

Polished and businesslike.

`AGENT_TONE_PLAYFUL`

Light and fun.

`AGENT_TONE_CONCISE`

Straight to the point.

`AGENT_TONE_ENTHUSIASTIC`

Energetic and upbeat.

### [#](#create-an-agent-response)Response

200

Everything worked as expected.

agent

object

Agent is a chat persona the workspace builds and plugs into workflow steps.

### [#](#create-an-agent-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X POST "https://api.linkbreakers.com/v1/agents" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  --data '{"customRules":"string","emojiEnabled":false,"guardrails":["AGENT_GUARDRAIL_UNSPECIFIED"],"instructions":"string","language":"string","name":"string","questionHandling":"AGENT_QUESTION_HANDLING_UNSPECIFIED","replyLength":"AGENT_REPLY_LENGTH_UNSPECIFIED","role":"AGENT_ROLE_UNSPECIFIED","styleNotes":"string","tone":"AGENT_TONE_UNSPECIFIED"}'
```

Sample payload (application/json)

```json
{
  "customRules": "string",
  "emojiEnabled": false,
  "guardrails": [
    "AGENT_GUARDRAIL_UNSPECIFIED"
  ],
  "instructions": "string",
  "language": "string",
  "name": "string",
  "questionHandling": "AGENT_QUESTION_HANDLING_UNSPECIFIED",
  "replyLength": "AGENT_REPLY_LENGTH_UNSPECIFIED",
  "role": "AGENT_ROLE_UNSPECIFIED",
  "styleNotes": "string",
  "tone": "AGENT_TONE_UNSPECIFIED"
}
```

Typical response

```json
{
  "agent": {
    "createdAt": "2026-11-01T17:04:23.946Z",
    "customRules": "string",
    "emojiEnabled": false,
    "guardrails": [
      "AGENT_GUARDRAIL_UNSPECIFIED"
    ],
    "id": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
    "instructions": "You work for Hotel Lumiere, a boutique hotel in Lyon.",
    "knowledgeDocumentCount": 0,
    "knowledgeDocuments": [
      {
        "agentId": "string",
        "content": "# Opening hours\n\nMonday to Friday, 9am to 6pm.",
        "createdAt": "2026-11-01T17:04:23.946Z",
        "id": "string",
        "title": "Opening hours and prices",
        "updatedAt": "2026-11-01T17:04:23.946Z"
      }
    ],
    "language": "fr",
    "name": "Front desk",
    "questionHandling": "AGENT_QUESTION_HANDLING_UNSPECIFIED",
    "replyLength": "AGENT_REPLY_LENGTH_UNSPECIFIED",
    "role": "AGENT_ROLE_UNSPECIFIED",
    "styleNotes": "Address visitors informally.",
    "tone": "AGENT_TONE_UNSPECIFIED",
    "updatedAt": "2026-11-01T17:04:23.946Z",
    "usages": [
      {
        "linkId": "string",
        "linkName": "string",
        "workflowStepId": "string"
      }
    ],
    "workspaceId": "string"
  }
}
```

Base URL: `https://api.linkbreakers.com`

POST

`/v1/agents/{agentId}/knowledge-documents`

Requires auth

## [#](#add-a-knowledge-document)Add a knowledge document

Add a Markdown document to an agent's knowledge. Requires the \`agents:write\` scope.

### [#](#add-a-knowledge-document-parameters)Parameters

#### path parameters

agentId

string

Required

path

The agent's ID (UUID).

#### header parameters

Idempotency-Key

string

header

Makes retrying this request safe. See components.parameters.IdempotencyKey.

### [#](#add-a-knowledge-document-request)Request body

content

string

Required

The document's Markdown content.

title

string

Required

The document's title.

### [#](#add-a-knowledge-document-response)Response

200

Everything worked as expected.

document

object

AgentKnowledgeDocument is one Markdown document the agent knows.

### [#](#add-a-knowledge-document-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X POST "https://api.linkbreakers.com/v1/agents/{agentId}/knowledge-documents" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  --data '{"content":"string","title":"string"}'
```

Sample payload (application/json)

```json
{
  "content": "string",
  "title": "string"
}
```

Typical response

```json
{
  "document": {
    "agentId": "string",
    "content": "# Opening hours\n\nMonday to Friday, 9am to 6pm.",
    "createdAt": "2026-11-01T17:04:23.946Z",
    "id": "string",
    "title": "Opening hours and prices",
    "updatedAt": "2026-11-01T17:04:23.946Z"
  }
}
```

Base URL: `https://api.linkbreakers.com`

PATCH

`/v1/agents/{agentId}/knowledge-documents/{id}`

Requires auth

## [#](#update-a-knowledge-document)Update a knowledge document

Change a knowledge document's title or content. Requires the \`agents:write\` scope.

### [#](#update-a-knowledge-document-parameters)Parameters

#### path parameters

agentId

string

Required

path

The agent's ID (UUID).

id

string

Required

path

The document's ID (UUID).

#### header parameters

Idempotency-Key

string

header

Makes retrying this request safe. See components.parameters.IdempotencyKey.

### [#](#update-a-knowledge-document-request)Request body

content

string

New Markdown content.

title

string

New title.

### [#](#update-a-knowledge-document-response)Response

200

Everything worked as expected.

document

object

AgentKnowledgeDocument is one Markdown document the agent knows.

### [#](#update-a-knowledge-document-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X PATCH "https://api.linkbreakers.com/v1/agents/{agentId}/knowledge-documents/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  --data '{"content":"string","title":"string"}'
```

Sample payload (application/json)

```json
{
  "content": "string",
  "title": "string"
}
```

Typical response

```json
{
  "document": {
    "agentId": "string",
    "content": "# Opening hours\n\nMonday to Friday, 9am to 6pm.",
    "createdAt": "2026-11-01T17:04:23.946Z",
    "id": "string",
    "title": "Opening hours and prices",
    "updatedAt": "2026-11-01T17:04:23.946Z"
  }
}
```

Base URL: `https://api.linkbreakers.com`

PATCH

`/v1/agents/{id}`

Requires auth

## [#](#update-an-agent)Update an agent

Change an agent's settings. Fields left unset keep their value. Requires the \`agents:write\` scope.

### [#](#update-an-agent-parameters)Parameters

#### path parameters

id

string

Required

path

The agent's ID (UUID).

#### header parameters

Idempotency-Key

string

header

Makes retrying this request safe. See components.parameters.IdempotencyKey.

### [#](#update-an-agent-request)Request body

customRules

string

New custom rules.

emojiEnabled

boolean

Whether the agent may use emoji.

guardrails

object

AgentGuardrailList wraps guardrails so an update can tell "unchanged" from "none".

instructions

string

New instructions.

language

string

New language code. An empty string matches the visitor's language.

name

string

New name.

questionHandling

string (enum)

AgentQuestionHandling is what the agent does when a visitor asks it something.

##### Allowed values

`AGENT_QUESTION_HANDLING_UNSPECIFIED`

Not set. Defaults to AGENT\_QUESTION\_HANDLING\_ANSWER\_AND\_STEER on create, keeps the value on update.

`AGENT_QUESTION_HANDLING_ANSWER_AND_STEER`

Answers, then brings the conversation back to its goal.

`AGENT_QUESTION_HANDLING_ANSWER_BRIEFLY`

One-line answers, then back to the goal.

`AGENT_QUESTION_HANDLING_COLLECT_ONLY`

Politely declines questions and only collects.

`AGENT_QUESTION_HANDLING_FREE_CONVERSATION`

Talks freely and collects along the way.

replyLength

string (enum)

AgentReplyLength is how long the agent's messages are.

##### Allowed values

`AGENT_REPLY_LENGTH_UNSPECIFIED`

Not set. Defaults to AGENT\_REPLY\_LENGTH\_SHORT on create, keeps the value on update.

`AGENT_REPLY_LENGTH_SHORT`

One or two sentences.

`AGENT_REPLY_LENGTH_MEDIUM`

A short paragraph.

`AGENT_REPLY_LENGTH_DETAILED`

As long as the answer needs.

role

string (enum)

AgentRole is the job the agent does for the workspace.

##### Allowed values

`AGENT_ROLE_UNSPECIFIED`

Not set. Defaults to AGENT\_ROLE\_CUSTOM on create, keeps the value on update.

`AGENT_ROLE_LEAD_QUALIFIER`

Qualifies leads: learns who the visitor is and what they need.

`AGENT_ROLE_EVENT_CONCIERGE`

Welcomes event attendees and answers practical questions.

`AGENT_ROLE_FEEDBACK_COLLECTOR`

Collects feedback about an experience.

`AGENT_ROLE_PRODUCT_EXPERT`

Presents a product and answers questions about it.

`AGENT_ROLE_SUPPORT_FAQ`

Answers frequent support questions.

`AGENT_ROLE_CUSTOM`

No preset role: the agent follows its instructions only.

styleNotes

string

New style notes.

tone

string (enum)

AgentTone is how the agent sounds.

##### Allowed values

`AGENT_TONE_UNSPECIFIED`

Not set. Defaults to AGENT\_TONE\_FRIENDLY on create, keeps the value on update.

`AGENT_TONE_FRIENDLY`

Warm and approachable.

`AGENT_TONE_PROFESSIONAL`

Polished and businesslike.

`AGENT_TONE_PLAYFUL`

Light and fun.

`AGENT_TONE_CONCISE`

Straight to the point.

`AGENT_TONE_ENTHUSIASTIC`

Energetic and upbeat.

### [#](#update-an-agent-response)Response

200

Everything worked as expected.

agent

object

Agent is a chat persona the workspace builds and plugs into workflow steps.

### [#](#update-an-agent-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X PATCH "https://api.linkbreakers.com/v1/agents/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  --data '{"customRules":"string","emojiEnabled":false,"guardrails":{"values":["AGENT_GUARDRAIL_UNSPECIFIED"]},"instructions":"string","language":"string","name":"string","questionHandling":"AGENT_QUESTION_HANDLING_UNSPECIFIED","replyLength":"AGENT_REPLY_LENGTH_UNSPECIFIED","role":"AGENT_ROLE_UNSPECIFIED","styleNotes":"string","tone":"AGENT_TONE_UNSPECIFIED"}'
```

Sample payload (application/json)

```json
{
  "customRules": "string",
  "emojiEnabled": false,
  "guardrails": {
    "values": [
      "AGENT_GUARDRAIL_UNSPECIFIED"
    ]
  },
  "instructions": "string",
  "language": "string",
  "name": "string",
  "questionHandling": "AGENT_QUESTION_HANDLING_UNSPECIFIED",
  "replyLength": "AGENT_REPLY_LENGTH_UNSPECIFIED",
  "role": "AGENT_ROLE_UNSPECIFIED",
  "styleNotes": "string",
  "tone": "AGENT_TONE_UNSPECIFIED"
}
```

Typical response

```json
{
  "agent": {
    "createdAt": "2026-11-01T17:04:23.947Z",
    "customRules": "string",
    "emojiEnabled": false,
    "guardrails": [
      "AGENT_GUARDRAIL_UNSPECIFIED"
    ],
    "id": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
    "instructions": "You work for Hotel Lumiere, a boutique hotel in Lyon.",
    "knowledgeDocumentCount": 0,
    "knowledgeDocuments": [
      {
        "agentId": "string",
        "content": "# Opening hours\n\nMonday to Friday, 9am to 6pm.",
        "createdAt": "2026-11-01T17:04:23.947Z",
        "id": "string",
        "title": "Opening hours and prices",
        "updatedAt": "2026-11-01T17:04:23.947Z"
      }
    ],
    "language": "fr",
    "name": "Front desk",
    "questionHandling": "AGENT_QUESTION_HANDLING_UNSPECIFIED",
    "replyLength": "AGENT_REPLY_LENGTH_UNSPECIFIED",
    "role": "AGENT_ROLE_UNSPECIFIED",
    "styleNotes": "Address visitors informally.",
    "tone": "AGENT_TONE_UNSPECIFIED",
    "updatedAt": "2026-11-01T17:04:23.947Z",
    "usages": [
      {
        "linkId": "string",
        "linkName": "string",
        "workflowStepId": "string"
      }
    ],
    "workspaceId": "string"
  }
}
```

Base URL: `https://api.linkbreakers.com`

DELETE

`/v1/agents/{agentId}/knowledge-documents/{id}`

Requires auth

## [#](#delete-a-knowledge-document)Delete a knowledge document

Remove a document from an agent's knowledge. Requires the \`agents:write\` scope.

### [#](#delete-a-knowledge-document-parameters)Parameters

#### path parameters

agentId

string

Required

path

The agent's ID (UUID).

id

string

Required

path

The document's ID (UUID).

### [#](#delete-a-knowledge-document-response)Response

200

Everything worked as expected.

No structured schema available for this section.

### [#](#delete-a-knowledge-document-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X DELETE "https://api.linkbreakers.com/v1/agents/{agentId}/knowledge-documents/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{}
```

Base URL: `https://api.linkbreakers.com`

DELETE

`/v1/agents/{id}`

Requires auth

## [#](#delete-an-agent)Delete an agent

Delete an agent and its knowledge documents. Requires the \`agents:write\` scope.

### [#](#delete-an-agent-parameters)Parameters

#### path parameters

id

string

Required

path

The agent's ID (UUID).

### [#](#delete-an-agent-response)Response

200

Everything worked as expected.

No structured schema available for this section.

### [#](#delete-an-agent-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X DELETE "https://api.linkbreakers.com/v1/agents/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{}
```

Base URL: `https://api.linkbreakers.com`

Cookies

We use cookies to measure our ads with Meta and Google and to record visits with PostHog. Our own analytics are cookie-free and run either way. [Privacy statement](https://linkbreakers.com/privacy#cookies)

---

Source: https://linkbreakers.com/help/api/agents