Gratis setup bij jaarabonnementen

Meld je vandaag aan!
Plan een demo

Documenten

Home

> API-referentie >

Eindpunten >

Documenten

API-referentie: Documenten-endpoints

De Documenten-API beheert statische promptinhoud, herbruikbare kennisfragmenten en definities voor dynamische gegevensopvraging voor de geauthenticeerde klant. De huidige implementatie biedt ook documentconversie, koppelingen tussen onderwerpen en documenten, en het ophalen van hook-documentprompts.

Overzicht

Een document kan gewone inhoud bevatten die gebruikt wordt in prompts, een realtime instructiebron zijn of een gegevensopvraagproces definiëren dat een extern systeem aanroept. Voor alle documentbeheer-endpoints is het ManageSettings-beleid vereist. Koppelingen tussen onderwerpen en hook-documenten bepalen waar een document beschikbaar wordt gemaakt tijdens de verwerking van onderwerpen, kanaalspecifieke flows en de uitvoering van workflow hooks.

Huidige endpoints

Documentrecords

  • GET /api/Documents – ManageSettings
    Geeft een gepagineerd overzicht van documenten voor de geauthenticeerde klant. Query ondersteunt pageNumber, pageSize, sortBy en sortOrder.
  • POST /api/Documents – ManageSettings
    Maak een document of een gegevensopvraagdefinitie aan. De API stelt customerID, creationDate en lastModifiedDate in.
  • GET /api/Documents/{id} – ManageSettings
    Geeft één document terug. Optionele query replacePlaceholders=true vervangt speciale placeholders zoals {{TopicList}} in de inhoud.
  • PUT /api/Documents/{id} – ManageSettings
    Werk een document bij en synchroniseer indien gewenst de vereisten voor aangepaste velden. Een null-waarde voor customFieldRequirements laat de vereisten ongewijzigd; een lege array wist ze.
  • DELETE /api/Documents/{id} – ManageSettings
    Verwijder één document voor de geauthenticeerde klant.

Upload converteren

  • POST /api/Documents/convert – ManageSettings
    Upload een Word- of Excel-bestand als multipart/form-data-veld file. De API converteert ondersteunde bestanden naar markdown en geeft { markdown } terug. Maximale uploadgrootte bedraagt 50 MB.

TopicDocuments

TopicDocuments koppelen documenten aan onderwerpen, speciale onderwerpen, kanalen of speciale kanalen.

  • GET /api/TopicDocuments – Bearer JWT
    Lijst topic-documentkoppelingen op. Filters omvatten topicId, documentId, channelId, hookName, isHook, pageNumber, pageSize, sortBy en sortOrder.
  • POST /api/TopicDocuments – Bearer JWT
    Maak één topic-documentkoppeling aan. Dubbele combinaties geven 409 Conflict.
  • POST /api/TopicDocuments/bulk – Bearer JWT
    Maak meerdere topic-documentkoppelingen tegelijk aan. Bestaande dubbele combinaties doen de bulk-aanmaak mislukken.
  • GET /api/TopicDocuments/{id} – Bearer JWT
    Lees één topic-documentkoppeling binnen de scope van de geauthenticeerde klant.
  • PUT /api/TopicDocuments/{id} – Bearer JWT
    Werk de documentlink-velden bij voor een combinatie van onderwerp, speciaal onderwerp, kanaal of speciaal kanaal.
  • DELETE /api/TopicDocuments/{id} – Bearer JWT
    Verwijder één topic-documentkoppeling.

HookDocuments

HookDocuments gebruiken topic-documentrecords als workflow-hookpromptdocumenten.

  • GET /api/HookDocuments/promptDocuments – TicketAccessOrPhoneAuth
    Geeft promptdocumenten terug voor een hookName en optioneel channelId. Telefoon-auth requests zijn beperkt tot het kanaal van de token.
  • POST /api/HookDocuments – Bearer JWT
    Maak een hook-documentkoppeling aan met dezelfde structuur als TopicDocumentCreateDTO. Voor hooks moet topicID null zijn en de hook-naam ingevuld bij specialTopic.

Authenticatie en toegang

  • Inkomende API-authenticatie
    Gebruik JWT Bearer-authenticatie. Document API-credentials worden niet gebruikt om inkomende AnswerPal API-calls te authenticeren.
  • Uitgaande API-configuratie
    overrideApiBaseUrl, overrideApiUsername, overrideApiPassword, overrideApiToken en overrideApiAuthenticationType worden gebruikt wanneer AnswerPal externe APIs aanroept voor gegevensophaling.
  • Hookdocumenten met telefonische authenticatie
    GET /api/HookDocuments/promptDocuments accepteert tickettoegang of telefoon-auth-context. Een telefoon-auth-token kan geen documenten aanvragen voor een ander kanaal.

Fouten

  • 400 Bad Request
    Ongeldige document-DTO, aangepaste veldvereiste die niet tot de klant behoort, ontbrekend uploadbestand, bestand groter dan 50 MB, niet-ondersteund Office-bestand of mislukte conversie.
  • 403 Forbidden
    Telefoon-auth hookdocumentaanvraag gebruikt een ander kanaal dan het tokenkanaal.
  • 404 Not Found
    Document, topic-documentkoppeling of hook-documentkoppeling bestaat niet binnen de scope van de geauthenticeerde klant.
  • 409 Conflict
    Dubbele topic-document- of hook-documentcombinatie.
  • 500 Server Error
    Onverwachte databasefout bij het aanmaken, bulk aanmaken, bijwerken of verwijderen van een topic-document.

Velden en DTO's

Documentvelden

Kern documentvelden

  • documentID
    Alleen-lezen ID voor het document of de gegevensopvraagdefinitie.
  • name
    Verplicht tekenveld, max. 100. Weergavenaam voor het document.
  • description, content
    Optionele beschrijvingstekst en prompt/documentinhoud.
  • isDataRetrievalProcess
    Markeert dit record als een gegevensophaalproces in plaats van een statisch document.
  • includeInRealtimeInstructions
    Laat toe dat opgehaalde inhoud behouden blijft in telefonische realtime instructies.
  • creationDate, lastModifiedDate
    Alleen-lezen tijdstempels die door de API worden ingesteld.

Uitgaande API- en functie-toolvelden

  • overrideApiBaseUrl, overrideApiUsername, overrideApiPassword, overrideApiToken, overrideApiAuthenticationType
    Uitgaande connector-overrides voor dit document/gegevensopvraagproces.
  • apiEndpoint, apiMethod, apiHeaders, apiBodyTemplate
    Definitie van externe API-call. apiHeaders is JSON-tekst.
  • fieldMapping
    Optionele mapping van opgehaalde data naar velden die door prompts of acties gebruikt worden.
  • isFunctionTool, functionParametersSchema, toolCallTimeoutSeconds
    Configuratie en time-out van functie-tool.

Aangepaste veldvelden

  • customFieldDefinitions
    Wordt getoond bij gedetailleerd lezen om beschikbare aangepaste velddefinities voor de klant weer te geven.
  • customFieldRequirements
    Lijst met vereiste aangepaste velddefinities voor dit document aanmaken/bijwerken. Null laat huidige vereisten ongewijzigd; een lege array wist ze.
  • documentCustomFieldRequirementID, customFieldDefinitionID, isRequired, fieldName, displayName, fieldType, description
    Velden op DocumentCustomFieldRequirementDTO.

TopicDocument- en promptvelden

TopicDocument-velden

  • topicDocumentID, customerID
    Alleen-respons koppelings-ID en klantbereik.
  • topicID, specialTopic
    Onderwerpdoel. topicID kan null zijn; specialTopic ondersteunt waarden zoals All of een hooknaam.
  • documentID
    Vereist document dat gekoppeld wordt.
  • channelID, specialChannel
    Optioneel kanaalspecifiek doel. specialChannel kan All of een kanaaltype zijn.
  • topicName, documentName, channelName
    Alleen-respons weergavenamen.

PromptDocument-responsvelden

  • documentID, name, content, contentType
    Promptdocumentidentiteit en inhoud.
  • includeInRealtimeInstructions, imageUrls
    Realtime-instructievlag en afbeeldings-URL’s gekoppeld aan de inhoud van de prompt.

Voorbeeldverzoeken

Een gegevensophaaldocument aanmaken

{
  "name": "Order status lookup",
  "description": "Fetches the current order status",
  "content": null,
  "isDataRetrievalProcess": true,
  "apiEndpoint": "https://erp.example.com/orders/{{orderNumber}}",
  "apiMethod": "GET",
  "apiHeaders": "{\"Accept\":\"application/json\"}",
  "fieldMapping": "{\"status\":\"$.status\"}",
  "isFunctionTool": true,
  "functionParametersSchema": "{\"type\":\"object\",\"properties\":{\"orderNumber\":{\"type\":\"string\"}}}",
  "toolCallTimeoutSeconds": 30
}

Een Office-bestand omzetten naar markdown

POST /api/Documents/convert
Authorization: Bearer <token>
Content-Type: multipart/form-data

[email protected]

Promptdocumenten voor een hook ophalen

GET /api/HookDocuments/promptDocuments?hookName=OnPhonePickup&channelId=3
Authorization: Bearer <token>

FAQ

Een statisch document levert prompt- of kennisinhoud direct aan. Een gegevensophaalproces zet isDataRetrievalProcess=true en definieert uitgaande API-callvelden, zoals apiEndpoint, apiMethod, headers, bodytemplate en veldmapping.

Ja. GET /api/Documents/{id}?replacePlaceholders=true vervangt speciale placeholders zoals {{TopicList}} voordat de inhoud wordt teruggegeven.

Gebruik /api/TopicDocuments voor topic-/kanaalkoppelingen en /api/HookDocuments voor hook promptdocumentflows. Beide gebruiken het TopicDocument-koppelingsmodel.

Inkomende AnswerPal API-verzoeken gebruiken JWT Bearer-authenticatie. De documentvelden overrideApiAuthenticationType, overrideApiUsername, overrideApiPassword en overrideApiToken zijn uitgaande instellingen die worden gebruikt wanneer AnswerPal een externe API aanroept.

Hulp nodig?

Contacteer ondersteuning

Inhoudsopgave

AnswerPal: AI-gedreven oplossingen voor klantenservice die je ondersteuning en communicatie moeiteloos versterken.

Snelle links

Contact

Voor ondersteunings-, commerciële en partnervragen kunt u mailen naar [email protected]

AnswerPal
Bisschoppenhoflaan 380
2100 Antwerpen
België

+32.36416685

BE 0862.692.858

Sociale media