Knowledge

List collections

GET

https://api.lelemon.cl

/v2/knowledge-collections

Bearer (API key)

Newest first. Collections read by the internal assistant are not listed.

Required scope: knowledge:read.

List collections › query Parameters

limit

integer · min: 1 · max: 100

Default: 20

cursor

string · maxLength: 512

The nextCursor of the previous page, with the same filters.

List collections › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

List collections › Responses

KnowledgeCollectionList

object

string · enum · required

Enum values:

list

hasMore

boolean · required

nextCursor

string | null · required

KnowledgeCollection[] · required

Create a collection

POST

https://api.lelemon.cl

/v2/knowledge-collections

Bearer (API key)

A collection groups documents. An agent searches only the collections you give it.

Required scope: knowledge:write.

Create a collection › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Idempotency-Key

string · minLength: 1 · maxLength: 255

Makes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.

Create a collection › Request Body

CreateKnowledgeCollection

name

string · minLength: 1 · maxLength: 255 · pattern: \S · required

description

string | null · maxLength: 2000

Create a collection › Responses

KnowledgeCollection

object

string · enum · required

Enum values:

knowledge_collection

id

string · required

name

string · required

description

string | null · required

documentCount

integer · required

Documents in any status.

createdAt

string · date-time · required

updatedAt

string · date-time · required

Search the knowledge

POST

https://api.lelemon.cl

/v2/knowledge-collections/search

Bearer (API key)

Finds the passages of your documents that answer a question, by meaning and by exact words, the same way an agent searches. Send collectionIds to search only some collections; leave it out to search all of them. Each passage says which collection and document it comes from. Read only and safe to repeat: it changes nothing. An empty data list means nothing answers it. 404 not_found when a collection does not exist or belongs to another organization; 503 service_unavailable when the search cannot run right now.

Required scope: knowledge:read.

Search the knowledge › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Idempotency-Key

string · minLength: 1 · maxLength: 255

Search the knowledge › Request Body

SearchKnowledge

query

string · minLength: 1 · maxLength: 1000 · required

What you are looking for, in your own words. It searches by meaning and by exact words (a product code, a name).

collectionIds

string[] · maxItems: 20

Search only these collections. Leave it out to search all of them.

limit

integer · min: 1 · max: 10

How many passages to return, best first.

Default: 5

Search the knowledge › Responses

KnowledgeSearch

object

string · enum · required

Enum values:

knowledge_search

KnowledgePassage[] · required

Best first. An empty list means nothing in the knowledge answers it.

Retrieve a collection

GET

https://api.lelemon.cl

/v2/knowledge-collections/{id}

Bearer (API key)

Returns one knowledge collection by id. Use it to refresh a single record you already know; to find records, use the list route. Its documents are listed on their own route. Read only. 404 not_found when the id does not exist or belongs to another organization. You can repeat it safely: it has no side effects.

Required scope: knowledge:read.

Retrieve a collection › path Parameters

id

string · pattern: ^kbc_[0-9A-Za-z]{22}… · required

The id of the knowledge collection (kbc_…).

Retrieve a collection › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Retrieve a collection › Responses

KnowledgeCollection

object

string · enum · required

Enum values:

knowledge_collection

id

string · required

name

string · required

description

string | null · required

documentCount

integer · required

Documents in any status.

createdAt

string · date-time · required

updatedAt

string · date-time · required

Delete a collection

DELETE

https://api.lelemon.cl

/v2/knowledge-collections/{id}

Bearer (API key)

Deletes its documents and removes the collection from every agent that had it. Answers 409 resource_in_use while a connected source feeds it.

Required scope: knowledge:write.

Delete a collection › path Parameters

id

string · pattern: ^kbc_[0-9A-Za-z]{22}… · required

The id of the knowledge collection (kbc_…).

Delete a collection › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Delete a collection › Responses

Deleted.

No data returned

Update a collection

PATCH

https://api.lelemon.cl

/v2/knowledge-collections/{id}

Bearer (API key)

Changes only what you send.

Required scope: knowledge:write.

Update a collection › path Parameters

id

string · pattern: ^kbc_[0-9A-Za-z]{22}… · required

The id of the knowledge collection (kbc_…).

Update a collection › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Update a collection › Request Body optional

UpdateKnowledgeCollection

name

string · minLength: 1 · maxLength: 255 · pattern: \S

description

string | null · maxLength: 2000

null clears it.

Update a collection › Responses

KnowledgeCollection

object

string · enum · required

Enum values:

knowledge_collection

id

string · required

name

string · required

description

string | null · required

documentCount

integer · required

Documents in any status.

createdAt

string · date-time · required

updatedAt

string · date-time · required

List documents

GET

https://api.lelemon.cl

/v2/knowledge-collections/{id}/documents

Bearer (API key)

Newest first, without the content.

Required scope: knowledge:read.

List documents › path Parameters

id

string · pattern: ^kbc_[0-9A-Za-z]{22}… · required

The id of the knowledge collection (kbc_…).

List documents › query Parameters

limit

integer · min: 1 · max: 100

Default: 20

cursor

string · maxLength: 512

The nextCursor of the previous page, with the same filters.

status

string · enum

Enum values:

processing

ready

failed

List documents › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

List documents › Responses

KnowledgeDocumentList

object

string · enum · required

Enum values:

list

hasMore

boolean · required

nextCursor

string | null · required

KnowledgeDocument[] · required

Add a document

POST

https://api.lelemon.cl

/v2/knowledge-collections/{id}/documents

Bearer (API key)

Send text as JSON or a file as multipart. It starts as processing; listen for knowledge_document.ready and knowledge_document.failed. Sending the same name again replaces the document and processes it again.

Required scope: knowledge:write.

Add a document › path Parameters

id

string · pattern: ^kbc_[0-9A-Za-z]{22}… · required

The id of the knowledge collection (kbc_…).

Add a document › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Idempotency-Key

string · minLength: 1 · maxLength: 255

Add a document › Request Body optional

CreateKnowledgeDocument

name

string · maxLength: 500 · pattern: \S

Required with text. With a file it defaults to the file name. The same name in a collection replaces the document.

text

string · pattern: \S

The content as text. Send either text or a file, not both.

file

string · binary

Multipart only. PDF, DOCX, TXT or MD, up to 15 MB. Send either a file or text.

Add a document › Responses

KnowledgeDocument

object

string · enum · required

Enum values:

knowledge_document

id

string · required

collectionId

string · required

name

string · required

mimeType

string · required

sizeBytes

integer · required

status

string · enum · required

Enum values:

processing

ready

failed

chunkCount

integer · required

Searchable passages.

required

Set when status is failed.

createdAt

string · date-time · required

updatedAt

string · date-time · required

POST/v2/knowledge-collections/{id}/documents

curl https://api.lelemon.cl/v2/knowledge-collections/:id/documents \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "horarios.md",
  "text": "Abrimos de 12:00 a 24:00."
}'

Example Request Body

{
  "name": "horarios.md",
  "text": "Abrimos de 12:00 a 24:00."
}

json

Example Responses

{
  "object": "knowledge_document",
  "id": "kbd_02y0e5MANqacVbmtn1YyeJ",
  "collectionId": "kbc_2LpX0x8bVw1TqS9mYp3RkL",
  "name": "faq.pdf",
  "mimeType": "application/pdf",
  "sizeBytes": 0,
  "status": "processing",
  "chunkCount": 0,
  "error": {
    "code": "text_extraction_failed",
    "message": "message"
  },
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Retrieve a document

GET

https://api.lelemon.cl

/v2/knowledge-collections/{id}/documents/{docId}

Bearer (API key)

Includes the content the agent searches once the status is ready. A failed document carries error.code.

Required scope: knowledge:read.

Retrieve a document › path Parameters

id

string · pattern: ^kbc_[0-9A-Za-z]{22}… · required

The id of the knowledge collection (kbc_…).

docId

string · pattern: ^kbd_[0-9A-Za-z]{22}… · required

The id of the knowledge document (kbd_…).

Retrieve a document › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Retrieve a document › Responses

KnowledgeDocumentWithContent

object

string · enum · required

Enum values:

knowledge_document

id

string · required

collectionId

string · required

name

string · required

mimeType

string · required

sizeBytes

integer · required

status

string · enum · required

Enum values:

processing

ready

failed

chunkCount

integer · required

Searchable passages.

required

Set when status is failed.

createdAt

string · date-time · required

updatedAt

string · date-time · required

content

string | null · required

The text the agent searches. null until status is ready.

Delete a document

DELETE

https://api.lelemon.cl

/v2/knowledge-collections/{id}/documents/{docId}

Bearer (API key)

The agent stops finding it right away. Documents kept by a connected source answer 409 resource_in_use.

Required scope: knowledge:write.

Delete a document › path Parameters

id

string · pattern: ^kbc_[0-9A-Za-z]{22}… · required

The id of the knowledge collection (kbc_…).

docId

string · pattern: ^kbd_[0-9A-Za-z]{22}… · required

The id of the knowledge document (kbd_…).

Delete a document › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Delete a document › Responses

Deleted.

No data returned

Update a document

PATCH

https://api.lelemon.cl

/v2/knowledge-collections/{id}/documents/{docId}

Bearer (API key)

Rename it or replace its text. New text processes the document again. Documents kept by a connected source answer 409 resource_in_use.

Required scope: knowledge:write.

Update a document › path Parameters

id

string · pattern: ^kbc_[0-9A-Za-z]{22}… · required

The id of the knowledge collection (kbc_…).

docId

string · pattern: ^kbd_[0-9A-Za-z]{22}… · required

The id of the knowledge document (kbd_…).

Update a document › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Update a document › Request Body optional

UpdateKnowledgeDocument

name

string · maxLength: 500 · pattern: \S

text

string · pattern: \S

Replaces the content and processes the document again: status goes back to processing.

Update a document › Responses

KnowledgeDocument

object

string · enum · required

Enum values:

knowledge_document

id

string · required

collectionId

string · required

name

string · required

mimeType

string · required

sizeBytes

integer · required

status

string · enum · required

Enum values:

processing

ready

failed

chunkCount

integer · required

Searchable passages.

required

Set when status is failed.

createdAt

string · date-time · required

updatedAt

string · date-time · required

PATCH/v2/knowledge-collections/{id}/documents/{docId}

curl https://api.lelemon.cl/v2/knowledge-collections/:id/documents/:docId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "text": "Abrimos de 12:00 a 23:00."
}'

Example Request Body

{
  "text": "Abrimos de 12:00 a 23:00."
}

json

application/json

Example Responses

{
  "object": "knowledge_document",
  "id": "kbd_02y0e5MANqacVbmtn1YyeJ",
  "collectionId": "kbc_2LpX0x8bVw1TqS9mYp3RkL",
  "name": "faq.pdf",
  "mimeType": "application/pdf",
  "sizeBytes": 0,
  "status": "processing",
  "chunkCount": 0,
  "error": {
    "code": "text_extraction_failed",
    "message": "message"
  },
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Let an agent search a collection

PUT

https://api.lelemon.cl

/v2/agents/{id}/knowledge-collections/{collectionId}

Bearer (API key)

Safe to repeat. The agent uses the collection from its next answer.

Required scope: knowledge:write.

Let an agent search a collection › path Parameters

id

string · pattern: ^agt_[0-9A-Za-z]{22}… · required

The id of the agent (agt_…).

collectionId

string · pattern: ^kbc_[0-9A-Za-z]{22}… · required

The id of the knowledge collection (kbc_…).

Let an agent search a collection › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Let an agent search a collection › Responses

AgentKnowledgeCollection

object

string · enum · required

Enum values:

agent_knowledge_collection

agentId

string · required

collectionId

string · required

granted

boolean · required

Stop an agent from searching a collection

DELETE

https://api.lelemon.cl

/v2/agents/{id}/knowledge-collections/{collectionId}

Bearer (API key)

Safe to repeat: answers 204 even if the agent did not have it.

Required scope: knowledge:write.

Stop an agent from searching a collection › path Parameters

id

string · pattern: ^agt_[0-9A-Za-z]{22}… · required

The id of the agent (agt_…).

collectionId

string · pattern: ^kbc_[0-9A-Za-z]{22}… · required

The id of the knowledge collection (kbc_…).

Stop an agent from searching a collection › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Stop an agent from searching a collection › Responses

Removed.

No data returned

Routing rules Contacts