Per sviluppatori
Integra Refine con la REST API o collega strumenti IA tramite il Model Context Protocol (MCP)
MCP
Model Context Protocol (MCP)
MCP è uno standard aperto che permette agli assistenti IA di interagire direttamente con strumenti e fonti di dati esterni. Collega il tuo strumento IA preferito a Refine con un solo endpoint.
- Aggiungi l’URL dell’endpoint MCP di Refine alla configurazione del tuo strumento IA
- Il tuo strumento gestirà automaticamente l’autenticazione OAuth
Usi Claude sul web, desktop o mobile? Installa il connettore Refine direttamente dalla directory di Claude: non serve copiare alcuna configurazione.
Apri il connettore Refine{
"mcpServers": {
"refine": {
"url": "https://api.refine.ink/mcp"
}
}
}{
"mcpServers": {
"refine": {
"url": "https://api.refine.ink/mcp"
}
}
}{
"servers": {
"refine": {
"type": "http",
"url": "https://api.refine.ink/mcp"
}
}
}OAuth è il metodo di autenticazione predefinito. Il tuo client MCP gestirà automaticamente il flusso di autorizzazione.
MCP può usare anche chiavi API per l’autenticazione.
REST API
REST API
Una API REST con documentazione OpenAPI interattiva. Esplora tutti gli endpoint disponibili, gli schemi di richiesta e risposta e prova le richieste direttamente dal browser.
Esplora la documentazione API- Crea una chiave API nella sezione Impostazioni avanzate account del tuo profilo
- Usa la chiave per autenticare le tue richieste
# 1. Upload a document
UPLOAD=$(curl -s -X POST "https://api.refine.ink/documents/upload" \
-H "X-API-Key: your-api-key" \
-F "file=@paper.pdf")
TASK_ID=$(echo $UPLOAD | jq -r '.task_id')
# 2. Wait for upload processing via SSE
curl -N "https://api.refine.ink/documents/upload/events/$TASK_ID?token=your-api-key"
# Listen until you receive: event: complete, data: {"document_id": "..."}
DOCUMENT_ID="<document_id from SSE>"
# 3. Start document processing (costs 1 credit)
PROCESS=$(curl -s -X POST "https://api.refine.ink/documents/$DOCUMENT_ID/process" \
-H "X-API-Key: your-api-key" \
-H "Content-Type: application/json" \
-d '{"preview": false}')
SESSION_ID=$(echo $PROCESS | jq -r '.review_id')
# 4. Stream processing progress via SSE
curl -N "https://api.refine.ink/documents/$DOCUMENT_ID/process/events/$SESSION_ID?token=your-api-key"import requests
import sseclient # pip install sseclient-py
API_KEY = "your-api-key"
BASE = "https://api.refine.ink"
headers = {"X-API-Key": API_KEY}
# 1. Upload a document
with open("paper.pdf", "rb") as f:
upload = requests.post(
f"{BASE}/documents/upload",
headers=headers,
files={"file": f}
).json()
task_id = upload["task_id"]
# 2. Wait for upload processing via SSE
response = requests.get(
f"{BASE}/documents/upload/events/{task_id}?token={API_KEY}",
stream=True
)
client = sseclient.SSEClient(response)
for event in client.events():
if event.event == "complete":
document_id = json.loads(event.data)["document_id"]
break
# 3. Start document processing (costs 1 credit)
process = requests.post(
f"{BASE}/documents/{document_id}/process",
headers=headers,
json={"preview": False}
).json()
review_id = process["review_id"]
# 4. Stream processing progress via SSE
response = requests.get(
f"{BASE}/documents/{document_id}/process/events/{review_id}?token={API_KEY}",
stream=True
)
for event in sseclient.SSEClient(response).events():
print(event.event, event.data)const API_KEY = "your-api-key";
const BASE = "https://api.refine.ink";
// 1. Upload a document
const form = new FormData();
form.append("file", new Blob([fileBuffer]), "paper.pdf");
const upload = await fetch(`${BASE}/documents/upload`, {
method: "POST",
headers: { "X-API-Key": API_KEY },
body: form,
}).then(r => r.json());
const taskId = upload.task_id;
// 2. Wait for upload processing via SSE
const uploadEvents = new EventSource(
`${BASE}/documents/upload/events/${taskId}?token=${API_KEY}`
);
const documentId = await new Promise<string>((resolve) => {
uploadEvents.addEventListener("complete", (e) => {
resolve(JSON.parse(e.data).document_id);
uploadEvents.close();
});
});
// 3. Start document processing (costs 1 credit)
const process = await fetch(
`${BASE}/documents/${documentId}/process`,
{
method: "POST",
headers: {
"X-API-Key": API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({ preview: false }),
}
).then(r => r.json());
// 4. Stream processing progress via SSE
const processEvents = new EventSource(
`${BASE}/documents/${documentId}/process/events/${process.review_id}?token=${API_KEY}`
);
// Events are named, so listen per event rather than on "message"
processEvents.addEventListener("progress", (e) => {
console.log(JSON.parse(e.data));
});
processEvents.addEventListener("complete", (e) => {
console.log(JSON.parse(e.data));
processEvents.close();
});Tieni al sicuro le tue chiavi API. Non inserirle nel controllo versione né esporle nel codice lato client.
TEST
Testa la tua integrazione
Non devi spendere crediti per sviluppare l’integrazione con Refine. Usa un mock dell’API basato sul nostro schema OpenAPI durante lo sviluppo, poi passa alla pipeline reale quando sei pronto.
Crea un mock dell’API dallo schema OpenAPI
Ogni endpoint è descritto nel nostro schema OpenAPI, quindi qualsiasi strumento di mock compatibile con OpenAPI può avviare per te un’API Refine fittizia: Prism, Mockoon, Microcks, WireMock, Postman o il server mock del tuo framework. Indirizza il client a questa API per testare il codice di caricamento, elaborazione e polling senza usare il servizio reale.
# Grab the OpenAPI schema
curl -o refine-openapi.json https://api.refine.ink/openapi.json
# Serve a mock from it with the tool of your choice, e.g. Prism
npx @stoplight/prism-cli mock refine-openapi.json
# Point your client at the mock instead of the real API
export REFINE_API_URL=http://127.0.0.1:4010Lo schema è sempre aggiornato con l’API in produzione: vedi lo schema OpenAPI.
Oppure prova il flusso reale
I mock non possono mostrarti come sono i commenti reali. Contattaci e assegneremo crediti per l’anteprima al tuo account, così potrai elaborare documenti reali con l’intera pipeline. Le anteprime sono elaborazioni rapide che richiedono poca potenza di calcolo, quindi restituiscono meno commenti di una revisione completa: abbastanza per verificare l’integrazione dall’inizio alla fine.
Contattaci per richiedere crediti per l’anteprimaInizia a sviluppare
Le API per sviluppatori sono in beta. Accogliamo con piacere i tuoi commenti mentre continuiamo a svilupparle.