API reference

Agent Knowledge Base

4 endpoints. Add your API key in the authentication panel to send test requests from this page.

Get agent knowledge base

GET/api/external/v1/agents/{agentId}/knowledge-base

Retrieves the current knowledge base state, including all configured items, for a specific AI agent.

Parameters

  • agentIdstring (uuid)pathRequired

Responses

  • 200Agent knowledge base state
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found

Create knowledge base item

POST/api/external/v1/agents/{agentId}/knowledge-base/items

Creates a new knowledge base item and associates it with the specified AI agent. Items can be web scrapes, text snippets, or other sources.

Parameters

  • agentIdstring (uuid)pathRequired

Request body application/json

  • titlestring
  • descriptionstring
  • scopestring
  • typestring
  • sourceConfigobject
  • attachToFlowboolean

Responses

  • 201Knowledge base item created successfully
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found

Update knowledge base item

PUT/api/external/v1/agents/{agentId}/knowledge-base/items/{itemId}

Updates an existing knowledge base item associated with the specified AI agent.

Parameters

  • agentIdstring (uuid)pathRequired
  • itemIdstring (uuid)pathRequired

Request body application/json

  • titlestring
  • descriptionstring
  • scopestring
  • typestring
  • sourceConfigobject
  • attachToFlowboolean

Responses

  • 200Knowledge base item updated successfully
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found

Delete knowledge base item

DELETE/api/external/v1/agents/{agentId}/knowledge-base/items/{itemId}

Permanently deletes a knowledge base item from the specified AI agent's knowledge base.

Parameters

  • agentIdstring (uuid)pathRequired
  • itemIdstring (uuid)pathRequired

Responses

  • 204Knowledge base item deleted successfully
  • 401Missing or invalid API key
  • 403Key is valid but lacks access to this resource
  • 404Requested resource not found