Zum Inhalt springen

API und MCP

Auf Piqline aufbauen

Die Tools und Agenten Ihres Workspace, über HTTP oder MCP. Ein Schlüssel, Scopes, lesbare Fehler.

  • 92 Tools
  • 6 Agenten
  • 5 Scopes
  • REST und MCP

Ihr erster Aufruf

curl -s https://piqline.com/api/v1/workspace \
  -H "Authorization: Bearer $PIQLINE_API_KEY"
Antwort
{
  "workspace": { "id": "b7a1c3e0-5d2f-4c8a-9e41-2f6d0a7b1c93", "name": "Atelier" },
  "key": { "name": "Claude Code", "prefix": "piq_live_Ab12Cd", "scopes": ["read", "agents"] },
  "limits": { "requests_per_minute": 120, "requests_today": 1 }
}

Wo Sie beginnen

Die Piqline-API gibt Ihren Skripten und Agenten Zugriff auf Ihren Workspace: dieselben Tools und dieselben Agenten wie der Assistent im Dashboard, über HTTP oder MCP (Model Context Protocol). Jeder Aufruf wirkt auf einen Workspace, mit den Rechten des Mitglieds, das den Schlüssel erstellt hat.

Was Sie brauchen#

  • Einen Piqline-Workspace, in dem Sie Owner oder Admin sind. Mitglieder sehen die Seite für Schlüssel nur lesend.
  • Ein Tool, das HTTP-Anfragen sendet (in den Beispielen curl), oder einen MCP-Client.

1. Schlüssel erstellen#

  1. Öffnen Sie Einstellungen → API und MCP.
  2. Benennen Sie den Schlüssel, wählen Sie seine Scopes (beginnen Sie mit read) und ein Ablaufdatum.
  3. Klicken Sie auf Schlüssel erstellen und kopieren Sie den Schlüssel. Er wird nur einmal angezeigt.

Legen Sie ihn in einer Umgebungsvariable ab:

Shell
export PIQLINE_API_KEY="piq_live_…"

2. Schlüssel prüfen#

curl -s https://piqline.com/api/v1/workspace \
  -H "Authorization: Bearer $PIQLINE_API_KEY"

Antwort:

JSON
{
  "workspace": { "id": "b7a1c3e0-5d2f-4c8a-9e41-2f6d0a7b1c93", "name": "Atelier" },
  "key": {
    "id": "0d4e8f2a-71c6-4b3d-8a55-c9e2b6f10d47",
    "name": "Claude Code",
    "prefix": "piq_live_Ab12Cd",
    "scopes": ["read", "agents"]
  },
  "acting_as": {
    "user_id": "3c9a52e1-8b47-4d06-a2f3-71e0b5d4c689",
    "email": "vous@exemple.fr",
    "role": "owner"
  },
  "limits": {
    "requests_per_minute": 120,
    "agent_runs_per_minute": 10,
    "requests_per_day": 20000,
    "requests_today": 1
  }
}

key.scopes listet, was der Schlüssel darf, und limits, was ihm noch bleibt. Ein 401 bedeutet: Der Schlüssel fehlt, wurde falsch kopiert oder widerrufen. Siehe Fehler.

3. Tool aufrufen#

Ein Tool ist eine Fähigkeit des Assistenten: den Korpus lesen, live suchen, schreiben, handeln. Dieses Beispiel liest die Erfassungsvolumen der letzten 7 Tage:

curl -s https://piqline.com/api/v1/tools/getCoverageStats \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"period":"7d"}'

Die Antwort enthält den Namen des Tools und seine Ausgabe (hier gekürzt):

JSON
{
  "tool": "getCoverageStats",
  "output": {
    "period": "7d",
    "itemsTotal": 1842,
    "itemsPeriod": 214,
    "items24h": 37,
    "sources": 12,
    "byPlatform": [{ "platform": "rss", "items": 904, "items24h": 20 }]
  }
}

Die 92 aufrufbaren Tools, ihre Scopes und ihre Eingaben stehen im Katalog.

4. Agent befragen#

Ein Agent verkettet mehrere Tools und antwortet in natürlicher Sprache. Der Schlüssel braucht den Scope agents sowie die Scopes der Tools, die der Agent nutzen darf.

curl -s https://piqline.com/api/v1/agents/piqline \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":"Combien de sources suit ce workspace, et lesquelles sont en erreur ?"}'

Antwort, gekürzt:

JSON
{
  "agent": "piqline",
  "status": "completed",
  "text": "Le workspace suit 12 sources, dont 2 en erreur : …",
  "tool_calls": [{ "tool": "listSources", "state": "output-available" }],
  "pending": []
}

Mehr unter Agenten.

5. MCP-Client verbinden#

Mit Claude Code:

Shell
claude mcp add --transport http piqline https://piqline.com/api/mcp \
  --header "Authorization: Bearer $PIQLINE_API_KEY"

Weitere Clients behandelt der MCP-Server.

Noch nicht verfügbar#

  • Webhooks. Es wird nichts an Ihre Systeme gesendet. Um zu verfolgen, was neu eintrifft, rufen Sie getSignals oder searchItems in regelmäßigen Abständen ab.
  • Offizielle SDKs. Das OpenAPI-Dokument beschreibt jede Route: Ein Client-Generator macht daraus ein SDK in Ihrer Sprache.
  • OAuth-Anmeldung. Es werden nur Schlüssel akzeptiert. Konnektoren, die OAuth verlangen, etwa die von claude.ai und ChatGPT, können sich noch nicht verbinden.
  • Massenexport. Tools liefern begrenzte Ergebnisseiten (höchstens 40 Items bei searchItems).

Eine Frage zur API oder ein Fehler auf dieser Seite? Schreiben Sie uns.