L'API di Piqline dà ai tuoi script e ai tuoi agenti accesso al tuo workspace: gli stessi tool e gli stessi agenti dell'assistente della dashboard, via HTTP o MCP (Model Context Protocol). Ogni chiamata agisce su un workspace, con i diritti del membro che ha creato la chiave.
Che cosa ti serve#
- Un workspace Piqline in cui sei owner o admin. I membri vedono la pagina delle chiavi in sola lettura.
- Uno strumento che invia richieste HTTP (negli esempi
curl) oppure un client MCP.
1. Crea una chiave#
- Apri Impostazioni → API e MCP.
- Dai un nome alla chiave, seleziona i suoi scope (inizia con
read) e scegli una scadenza. - Clicca su Crea chiave, poi copia la chiave. Viene mostrata una sola volta.
Salvala in una variabile d'ambiente:
export PIQLINE_API_KEY="piq_live_…"2. Verifica la chiave#
curl -s https://piqline.com/api/v1/workspace \
-H "Authorization: Bearer $PIQLINE_API_KEY"const response = await fetch("https://piqline.com/api/v1/workspace", {
headers: { Authorization: "Bearer " + process.env.PIQLINE_API_KEY },
});
const data = await response.json();import os
import requests
response = requests.get(
"https://piqline.com/api/v1/workspace",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
)
data = response.json()Risposta:
{
"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 elenca ciò che la chiave può fare, e limits ciò che le resta. Un 401 indica che la chiave manca, è stata copiata male o è stata revocata: vedi Errori.
3. Chiama un tool#
Un tool è una capacità dell'assistente: leggere il corpus, cercare in diretta, scrivere, agire. Questo esempio legge i volumi di raccolta degli ultimi 7 giorni:
curl -s https://piqline.com/api/v1/tools/getCoverageStats \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"period":"7d"}'const response = await fetch("https://piqline.com/api/v1/tools/getCoverageStats", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({ period: "7d" }),
});
const data = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/getCoverageStats",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={"period": "7d"},
)
data = response.json()La risposta contiene il nome del tool e il suo output (abbreviato qui):
{
"tool": "getCoverageStats",
"output": {
"period": "7d",
"itemsTotal": 1842,
"itemsPeriod": 214,
"items24h": 37,
"sources": 12,
"byPlatform": [{ "platform": "rss", "items": 904, "items24h": 20 }]
}
}I 92 tool richiamabili, i loro scope e i loro input sono elencati nel catalogo.
4. Interroga un agente#
Un agente concatena più tool e risponde in linguaggio naturale. La chiave richiede lo scope agents, più gli scope dei tool che l'agente può usare.
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 ?"}'const response = await fetch("https://piqline.com/api/v1/agents/piqline", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({ input: "Combien de sources suit ce workspace, et lesquelles sont en erreur ?" }),
});
const data = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/agents/piqline",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={"input": "Combien de sources suit ce workspace, et lesquelles sont en erreur ?"},
)
data = response.json()Risposta, abbreviata:
{
"agent": "piqline",
"status": "completed",
"text": "Le workspace suit 12 sources, dont 2 en erreur : …",
"tool_calls": [{ "tool": "listSources", "state": "output-available" }],
"pending": []
}Altri dettagli in Agenti.
5. Collega un client MCP#
Con Claude Code:
claude mcp add --transport http piqline https://piqline.com/api/mcp \
--header "Authorization: Bearer $PIQLINE_API_KEY"Gli altri client sono trattati in Server MCP.
Non ancora disponibile#
- Webhook. Nulla viene inviato ai tuoi sistemi. Per seguire ciò che arriva, interroga
getSignalsosearchItemsa intervalli regolari. - SDK ufficiali. Il documento OpenAPI descrive ogni route: un generatore di client lo trasforma in un SDK nel tuo linguaggio.
- Accesso OAuth. Sono accettate solo le chiavi. I connettori che richiedono OAuth, come quelli di claude.ai e ChatGPT, non possono ancora collegarsi.
- Esportazione in blocco. I tool restituiscono pagine di risultati limitate (al massimo 40 elementi per
searchItems).