API-Dokumentation

Die BoundaryAI-API ermöglicht es Ihnen, Feedback-Daten programmgesteuert zu übermitteln, Datenquellen zu erstellen und den Workflow zur Sammlung von Feedback in Ihrer Organisation zu verwalten.

Übersicht

Die BoundaryAI-API ermöglicht es Ihnen, Feedbackdaten programmgesteuert aus jeder Quelle zu importieren – Support-Tickets, CRM-Exporte, Umfragen, Chat-Protokolle – und KI-gestützte Analysen zu nutzen, um Erkenntnisse zu extrahieren.

Kernkonzepte

Bevor Sie einsteigen, verstehen Sie diese Schlüsselkonzepte:

Konzept

Beschreibung

Feedback-Gruppe

Ein Container, der verwandte Datenquellen organisiert (z. B. „Q1 2024 Customer Feedback“)

Datenquelle

Eine Sammlung von Feedback innerhalb einer Gruppe (z. B. „Zendesk Tickets“, „NPS-Umfrage“)

Frage

Ein Feld innerhalb einer Datenquelle, das Feedbacktext enthält

APS

Analysepunkte – Credits, die beim Einreichen von Inhalten zur KI-Analyse verbraucht werden

Funktionsweise

1. Erstellen Sie eine Feedback-Gruppe (oder verwenden Sie eine vorhandene)
         ↓
2. Erstellen Sie eine Datenquelle mit Fragen
         ↓
3. Veröffentlichen Sie die Datenquelle
         ↓
4. Übermitteln Sie Ihre Feedback-Inhalte
         ↓
5. BoundaryAI analysiert und extrahiert Erkenntnisse

Authentifizierung

API-Schlüssel

Alle API-Anfragen erfordern einen API-Schlüssel, der im Autorisierungs Header übergeben wird:

Authorization: Bearer inpk_live_abc123xyz_SbcEpUl9DWuI8IOI-YImkxPNSisaAab7t0goFuliM-4

Schlüsselformat

inpk_{environment}_{key_id}_{secret}

Teil

Beschreibung

inpk

Fester Präfix (Input API Key)

environment

live (Produktion) oder test (keine APS-Abzüge)

key_id

10-stellige eindeutige Kennung

secret

Base64-kodiertes Secret (44 Zeichen)

Schlüsselberechtigungen

Beim Erstellen eines API-Schlüssels wählen Sie dessen Berechtigungsstufe:

Berechtigung

Kann tun

Anwendungsfall

push

Inhalte in bestehende Datenquellen pushen

Automatisierte Import-Skripte

create

Feedback-Gruppen und Datenquellen erstellen

Automation einrichten

all

Alles

Vollständige programmgesteuerte Kontrolle

So erhalten Sie Ihren API-Schlüssel

Gehen Sie zu Integrationen → API in Ihrem BoundaryAI-Dashboard
Klicken Sie API-Schlüssel erstellen
Wählen Sie einen Namen, die Umgebung und die Berechtigungsstufe
Speichern Sie den Schlüssel sofort — er wird nur einmal angezeigt!

Sicherheitshinweise

Schlüssel werden serverseitig gehasht; wir speichern niemals das Klartext-
Verwenden Sie test Umgebungsschlüssel zum Testen (keine APS-Gebühren)
Rotieren Sie Schlüssel regelmäßig über das Dashboard (vergessen Sie nicht, sie nach der Rotation zu kopieren, da sie ebenfalls nur einmal angezeigt werden)

Anfragen stellen

Basis-URLs

Umgebung

Basis-URL

Europa

https://app.boundary-ai.com/

Nordamerika

https://app.boundary-ai.com/

APAC

Demnächst verfügbar

Anfrageformat

Alle Anfragen müssen enthalten:

Authorization: Bearer {your_api_key}
Content-Type: application/json

Antwortformat

Erfolgsantwort

{
  "status": "success",
  "inserted": 3,
  "aps_deducted": 3,
  "question_id": 736,
  "survey_id": 287,
  "survey_series_id": 2
}

Fehlerantwort

{
  "error": {
    "code": "SURVEY_NOT_FOUND",
    "message": "Datenquelle mit der ID 999 existiert nicht",
    "details": {}
  }
}

Ratenbegrenzung

Drei Ebenen schützen die API:

Ebene

Limit

Geltungsbereich

Pro-Schlüssel

60/min (max = 300)

Einzelner API-Schlüssel

Pro-Organisation

1000/min

Alle Schlüssel in der Organisation

Pro-IP

1000/min

Fallback-Schutz

Antwort-Header:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1704067200

Wenn Sie ratelimitiert werden, erhalten Sie HTTP 429 mit einem Retry-After Header.

Idempotenz

Verhindern Sie doppelte Daten, indem Sie einen Idempotency-Key einschließen:

Idempotency-Key: import-batch-2024-01-15-001

Szenario

Ergebnis

Erste Anfrage

Wird normal ausgeführt, Antwort wird 24 Std. zwischengespeichert

Gleicher Schlüssel + gleicher Payload

Gibt die zwischengespeicherte Antwort zurück (kein doppeltes Einfügen)

Gleicher Schlüssel + anderer Payload

Gibt HTTP zurück 409 Konfliktfehler

Beste Praxis: Verwenden Sie einen eindeutigen Bezeichner wie {source}-{date}-{batch} für jede Importcharge.

Endpoints-Referenz

Kurzübersicht

Methode

Endpoint

Beschreibung

Berechtigung

GET

/api/input/surveys/list

Alle Feedback-Gruppen & Datenquellen auflisten

beliebig

POST

/api/input/survey_series/create

Erstellen einer Feedback-Gruppe

create

POST

/api/input/survey/create

Erstellen einer Datenquelle

create

POST

/api/input/survey/publish

Eine Datenquelle veröffentlichen

create

POST

/api/input/content/push

Inhalte für eine Frage pushen

push

POST

/api/input/content/push/bulk

Inhalte für mehrere Fragen pushen

push

Datenquellen auflisten

Rufen Sie alle Feedback-Gruppen und Datenquellen ab, auf die Ihr API-Schlüssel zugreifen kann. Führen Sie dies zuerst aus um die IDs zu erhalten, die Sie zum Pushen von Inhalten benötigen.

GET /api/input/surveys/list

Abfrageparameter

Parameter

Typ

Beschreibung

survey_series_id

integer

Auf eine bestimmte Feedback-Gruppe filtern

survey_id

integer

Auf eine bestimmte Datenquelle filtern

Antwort

{
  "org_id": 1,
  "survey_series": [
    {
      "id": 101,
      "name": "Customer Support Logs",
      "surveys": [
        {
          "id": 505,
          "title": "Live Chat Export",
          "description": "Umfragebeschreibung hier",
          "mode": "ACCESSIBLE",
          "questions": [
            {
              "id": 888,
              "title": "User Message",
              "type": "long_answer",
              "accepts_text": true
            }
          ]
        }
      ]
    }
  ]
}

Verstehen der Antwort

Feld

Beschreibung

survey_series

Array von Feedback-Gruppen

surveys

Array von Datenquellen innerhalb einer Gruppe

questions

Felder, die für Inhalte verfügbar sind

accepts_text

Wichtig! Pushen Sie nur Text an Fragen, bei denen dies true

mode

ACCESSIBLE = veröffentlicht, EDITING = Entwurf

Beispiel

curl -X GET "https://app.boundary-ai.com/api/input/surveys/list" \
  -H "Authorization: Bearer $API_KEY"

Inhalte pushen

Feedback-Text an eine bestimmte Frage pushen. Dies ist der primäre Endpoint zum Importieren von Daten.

POST /api/input/content/push

Anfragekörper

{
  "survey_series_id": "123",
  "survey_id": "456",
  "question": {
    "question_id": "789",
    "content": [
      "Der Checkout-Prozess war verwirrend",
      "Liebe das neue Dark-Mode-Feature!",
      "App stürzt ab, wenn große Dateien hochgeladen werden"
    ]
  },
  "source_reference": "zendesk-export-2024-01-15"
}

Parameter

Feld

Typ

Erforderlich

Beschreibung

survey_series_id

string

Feedback-Gruppen-ID

survey_id

string

Datenquellen-ID

question.question_id

string

Frage-ID (muss accepts_text: true)

question.content

array

Array von Feedback-Strings

source_reference

string

Nein

Ihre Referenz für diese Importcharge

Inhaltslimits

Limit

Wert

Max. Elemente pro Anfrage

1,000

Max. Zeichen pro Element

10,000

Antwort

{
  "status": "success",
  "inserted": 3,
  "aps_deducted": 3,
  "question_id": 736,
  "survey_id": 287,
  "survey_series_id": 2
}

Feld

Beschreibung

inserted

Anzahl neu hinzugefügter Einträge

duplicates

Anzahl übersprungener doppelter Einträge

aps_deducted

Verbrauchte Analysepunkte

Beispiel: Python

import requests

API_KEY = "inpk_live_xxx_yyy"
BASE_URL = "https://app.boundary-ai.com"

response = requests.post(
    f"{BASE_URL}/api/input/content/push",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    },
    json={
        "survey_series_id": "123",
        "survey_id": "456",
        "question": {
            "question_id": "789",
            "content": [
                "Tolles Produkt, einfach zu bedienen!",
                "Das Support-Team war sehr hilfreich",
                "Würde es anderen empfehlen"
            ]
        },
        "source_reference": "crm-export-2024-01"
    }
)

result = response.json()
print(f"Eingefügt: {result['inserted']}, APS verwendet: {result['aps_deducted']}")

Beispiel: JavaScript

const API_KEY = 'inpk_live_xxx_yyy';
const BASE_URL = 'https://app.boundary-ai.com';

const response = await fetch(`${BASE_URL}/api/input/content/push`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    survey_series_id: "123",
    survey_id: "456",
    question: {
      question_id: "789",
      content: [
        'Tolles Produkt, einfach zu bedienen!',
        'Das Support-Team war sehr hilfreich',
        'Würde es anderen empfehlen'
      ]
    },
    source_reference: 'crm-export-2024-01'
  })
});

const result = await response.json();
console.log(`Eingefügt: ${result.inserted}, APS verwendet: ${result.aps_deducted}`);

Beispiel: Curl

curl -X POST "https://app.boundary-ai.com/api/input/content/push" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: batch-001" \
  -d '{
    "survey_series_id": "123",
    "survey_id": "456",
    "question": {
      "question_id": "789",
      "content": [
        "Tolles Produkt, einfach zu bedienen!",
        "Das Support-Team war sehr hilfreich"
      ]
    }
  }'

Bulk-Inhalte pushen

Inhalte in mehreren Fragen in einer einzigen Anfrage pushen. Nützlich, wenn Ihre Daten mehrere Felder enthalten.

POST /api/input/content/push/bulk

Anfragekörper

{
  "survey_series_id": "123",
  "survey_id": "456",
  "questions": [
    {
      "question_id": "789",
      "content": ["Feedback für Frage 1", "Mehr Feedback"]
    },
    {
      "question_id": "790",
      "content": ["Feedback für Frage 2"]
    }
  ],
  "source_reference": "bulk-import-001"
}

Parameter

Feld

Typ

Erforderlich

Beschreibung

survey_series_id

string

Feedback-Gruppen-ID

survey_id

string

Datenquellen-ID

questions

array

Array von Frage-Objekten (max. 100)

questions[].question_id

string

Frage-ID

questions[].content

array

Array von Feedback-Strings

source_reference

string

Nein

Ihre Referenz für diese Charge

Antwort

{
  "status": "success",
  "survey_series_id": 2,
  "survey_id": 287,
  "total_inserted": 2,
  "total_aps_deducted": 2,
  "questions": [
    {"question_id": 736, "inserted": 2, "status": "success"}
  ]
}

Feedback-Gruppe erstellen

Erstellen Sie eine neue Feedback-Gruppe, um verwandte Datenquellen zu organisieren.

POST /api/input/survey_series/create

Erforderliche Berechtigung: create oder all

Anfragekörper

{
  "name": "Product Feedback 2024"
}

Parameter

Feld

Typ

Erforderlich

Beschreibung

Namen

string

Gruppenname (2–255 Zeichen)

Antwort

{
  "status": "success",
  "created": true,
  "survey_series": {
    "id": 123,
    "name": "Product Feedback 2024"
  }
}

Hinweis: Wenn eine Gruppe mit demselben Namen existiert, wird die vorhandene Gruppe zurückgegeben mit "created": false.

Datenquelle erstellen

Erstellen Sie eine neue Datenquelle mit Fragen innerhalb einer Feedback-Gruppe.

POST /api/input/survey/create

Erforderliche Berechtigung: create oder all

Anfragekörper

{
  "survey_series_id": "123",
  "survey_title": "Zendesk Tickets Import",
  "survey_description": "Support-Tickets aus Januar 2024",
  "questions": [
    {
      "question_title": "Ticket-Inhalt",
      "question_type": "DEPTH_TEXT",
      "is_mandatory": true
    },
    {
      "question_title": "Kundenstimmung",
      "question_type": "SCQ",
      "question_options": ["Positive", "Neutral", "Negative"],
      "is_mandatory": false
    }
  ]
}

Parameter

Feld

Typ

Erforderlich

Beschreibung

survey_series_id

string

Eltern-Feedback-Gruppen-ID

survey_title

string

Name der Datenquelle (1–100 Zeichen)

survey_description

string

Nein

Beschreibung (max. 1000 Zeichen)

questions

array

Nein

Array von Fragen, die erstellt werden sollen

Fragetypen

Typ

Aliase

Beschreibung

Akzeptiert Text

DEPTH_TEXT

long_answer

Langtext (KI-analysiert)

✅ Ja

TEXT

short_answer

Kurztext

✅ Ja

MCQ

mcq

Multiple Choice (Mehrfachauswahl)

❌ Nein

SCQ

scq

Einzelauswahl

❌ Nein

RATING

rating

Skala 1–5

❌ Nein

NPS

nps

Net Promoter Score (0–10)

❌ Nein

Tipp: Verwenden Sie DEPTH_TEXT für Feedback-Text, den Sie von der KI analysieren lassen möchten.

Antwort

{
  "status": "success",
  "survey_series_id": 123,
  "survey_id": 456,
  "questions_created": 2,
  "questions": [
    {"id": 789, "title": "Ticket-Inhalt", "type": "DEPTH_TEXT"},
    {"id": 790, "title": "Kundenstimmung", "type": "SCQ"}
  ],
  "message": "Umfrage 'Zendesk Tickets Import' erstellt mit 2 Frage(n)"
}

Datenquelle veröffentlichen

Veröffentlichen Sie eine Datenquelle, um Datenerfassung und -analyse zu ermöglichen.

POST /api/input/survey/publish

Erforderliche Berechtigung: create oder all

Anfragekörper

{
  "survey_series_id": 123,
  "survey_id": 456
}

Antwort

{
  "status": "success",
  "survey_id": 456,
  "survey_series_id": 123,
  "mode": "ACCESSIBLE",
  "message": "Umfrage erfolgreich veröffentlicht"
}

Hinweis: Sie müssen eine Datenquelle veröffentlichen, bevor Sie Inhalte dorthin pushen können.

Webhooks

Siehe Webhooks Seite

Komplettes Beispiel

Hier ist ein vollständiger Workflow: Erstellen Sie eine Feedback-Gruppe, fügen Sie eine Datenquelle hinzu, veröffentlichen Sie sie und pushen Sie Inhalte.

#!/bin/bash
# Vollständiges API-Workflow-Beispiel

API_KEY="inpk_live_xxx_yyy"
BASE_URL="https://app.boundary-ai.com"

# Schritt 1: Erstellen Sie eine Feedback-Gruppe
echo "Erstelle Feedback-Gruppe..."
SERIES_RESPONSE=$(curl -s -X POST "$BASE_URL/api/input/survey_series/create" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Support Tickets Q1 2024"}')

SERIES_ID=$(echo $SERIES_RESPONSE | jq -r '.survey_series.id')
echo "Erstellte Feedback-Gruppen-ID: $SERIES_ID"

# Schritt 2: Erstellen Sie eine Datenquelle mit einer Textfrage
echo "Erstelle Datenquelle..."
SURVEY_RESPONSE=$(curl -s -X POST "$BASE_URL/api/input/survey/create" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d "{
    \"survey_series_id\": \"$SERIES_ID\",
    \"survey_title\": \"Zendesk Import\",
    \"questions\": [
      {\"question_title\": \"Ticket-Inhalt\", \"question_type\": \"DEPTH_TEXT\"}
    ]
  }")

SURVEY_ID=$(echo $SURVEY_RESPONSE | jq -r '.survey_id')
QUESTION_ID=$(echo $SURVEY_RESPONSE | jq -r '.questions[0].id')
echo "Erstellte Datenquellen-ID: $SURVEY_ID, Frage-ID: $QUESTION_ID"

# Schritt 3: Veröffentlichen Sie die Datenquelle
echo "Veröffentliche Datenquelle..."
curl -s -X POST "$BASE_URL/api/input/survey/publish" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"survey_series_id\": $SERIES_ID, \"survey_id\": $SURVEY_ID}"

# Schritt 4: Pushen Sie Feedback-Inhalte
echo "Pushe Inhalte..."
PUSH_RESPONSE=$(curl -s -X POST "$BASE_URL/api/input/content/push" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: zendesk-batch-$(date +%Y%m%d)-001" \
  -d "{
    \"survey_series_id\": \"$SERIES_ID\",
    \"survey_id\": \"$SURVEY_ID\",
    \"question\": {
      \"question_id\": \"$QUESTION_ID\",
      \"content\": [
        \"Der Checkout-Prozess war verwirrend und ich habe aufgegeben\",
        \"Liebe die neue Suchfunktion – so viel schneller!\",
        \"Die App stürzt jedes Mal ab, wenn ich versuche, ein PDF hochzuladen\","}
        "Der Kundensupport löste mein Problem innerhalb einer Stunde",
        "Wäre großartig, eine Dunkelmodus-Option zu haben"
      ]
    },
    "source_reference": "zendesk-export-2024-01-15"
  }")

echo "Push-Ergebnis: $PUSH_RESPONSE"
echo ""
echo "Fertig! Sehen Sie Ihr Feedback im BoundaryAI-Dashboard."

Support

E-Mail: hello@boundary-ai.com
Dokumentation: docs.boundary-ai.com
Dashboard: app.boundary-ai.com

VorherigeSchnellstartanleitung NächsteWebhooks

Zuletzt aktualisiert vor 1 Monat

hashtagÜbersicht

hashtagKernkonzepte

hashtagFunktionsweise

hashtagAuthentifizierung

hashtagAPI-Schlüssel

hashtagSchlüsselformat

hashtagSchlüsselberechtigungen

hashtagSo erhalten Sie Ihren API-Schlüssel

hashtagSicherheitshinweise

hashtagAnfragen stellen

hashtagBasis-URLs

hashtagAnfrageformat

hashtagAntwortformat

hashtagErfolgsantwort

hashtagFehlerantwort

hashtagRatenbegrenzung

hashtagIdempotenz

hashtagEndpoints-Referenz

hashtagKurzübersicht

hashtagDatenquellen auflisten

hashtagAbfrageparameter

hashtagAntwort

hashtagVerstehen der Antwort

hashtagBeispiel

hashtagInhalte pushen

hashtagAnfragekörper

hashtagParameter

hashtagInhaltslimits

hashtagAntwort

hashtagBeispiel: Python

hashtagBeispiel: JavaScript

hashtagBeispiel: Curl

hashtagBulk-Inhalte pushen

hashtagAnfragekörper

hashtagParameter

hashtagAntwort

hashtagFeedback-Gruppe erstellen

hashtagAnfragekörper

hashtagParameter

hashtagAntwort

hashtagDatenquelle erstellen

hashtagAnfragekörper

hashtagParameter

hashtagFragetypen

hashtagAntwort

hashtagDatenquelle veröffentlichen

hashtagAnfragekörper

hashtagAntwort

hashtagWebhooks

hashtagKomplettes Beispiel

hashtagSupport

Übersicht

Kernkonzepte

Funktionsweise

Authentifizierung

API-Schlüssel

Schlüsselformat

Schlüsselberechtigungen

So erhalten Sie Ihren API-Schlüssel

Sicherheitshinweise

Anfragen stellen

Basis-URLs

Anfrageformat

Antwortformat

Erfolgsantwort

Fehlerantwort

Ratenbegrenzung

Idempotenz

Endpoints-Referenz

Kurzübersicht

Datenquellen auflisten

Abfrageparameter

Antwort

Verstehen der Antwort

Beispiel

Inhalte pushen

Anfragekörper

Parameter

Inhaltslimits

Antwort

Beispiel: Python

Beispiel: JavaScript

Beispiel: Curl

Bulk-Inhalte pushen

Anfragekörper

Parameter

Antwort

Feedback-Gruppe erstellen

Anfragekörper

Parameter

Antwort

Datenquelle erstellen

Anfragekörper

Parameter

Fragetypen

Antwort

Datenquelle veröffentlichen

Anfragekörper

Antwort

Webhooks

Komplettes Beispiel

Support