Saltar para o conteúdo principal
PATCH
/
public
/
api
/
v1
/
knowledge-sources
/
{knowledgeSourcePublicId}
Rename / update knowledge source (name, description)
curl --request PATCH \
  --url https://api.gennia.ai/public/api/v1/knowledge-sources/{knowledgeSourcePublicId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "description": "Frequently asked questions from our support team.",
  "name": "Support FAQ"
}
'
{
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "errorMessage": "<string>",
  "lastProcessedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Autorizações

​
X-Api-Key
string
header
obrigatório

Parâmetros de caminho

​
knowledgeSourcePublicId
string<uuid>
obrigatório

Corpo

application/json

Body for updating an existing knowledge source. All fields are optional; only provided fields are updated.

​
description
string

New short description of what the knowledge source covers.

Maximum string length: 500
Exemplo:

"Frequently asked questions from our support team."

​
name
string

New display name of the knowledge source.

Required string length: 1 - 150
Exemplo:

"Support FAQ"

Resposta

OK

Workspace knowledge source.

​
createdAt
string<date-time>
​
description
string
​
errorMessage
string
​
lastProcessedAt
string<date-time>
​
name
string
​
processingStatus
enum<string>
Opções disponíveis:
PENDING,
PROCESSING,
COMPLETED,
FAILED
​
publicId
string<uuid>
​
sourceType
enum<string>
Opções disponíveis:
FILE_UPLOAD,
FILE,
TEXT_INPUT
​
updatedAt
string<date-time>