Premier appel API

L'API AlphaEdge est une API REST simple et intuitive. Une fois que vous avez obtenu une clé API, vous pouvez commencer à l'utiliser immédiatement dans vos applications.

Cold start

Lors du premier appel ou après une période d'inactivité, le modèle peut mettre environ 600 ms à répondre (cold start). Les appels suivants sont plus rapides.

Configuration requise

PARAMÈTRE	VALEUR
`base_url`	`https://api-endpoints.alphaedge-ai.com`
`api_key`	Demandez une clé API sur votre tableau de bord

Premier appel : OCR (Alpha Digit Max ou Medium)

Une fois votre clé API obtenue, vous pouvez tester l’endpoint OCR en multipart/form-data : le champ fichier doit s’appeler exactement image ; le slug du modèle (alpha-digit-max ou alpha-digit-medium) figure uniquement dans le chemin d’URL. Ne définissez pas Content-Type à la main — curl -F, requests (files=…) ou fetch(FormData) établissent multipart/form-data et le boundary.

bash

curl -X POST "https://api-endpoints.alphaedge-ai.com/models/alpha-digit-max/ocr" \
  -H "X-API-Key: TA_CLE" \
  -F "image=@/chemin/vers/document.png"

python

import os
import requests

url = "https://api-endpoints.alphaedge-ai.com/models/alpha-digit-max/ocr"
headers = {"X-API-Key": os.environ.get("ALPHAEDGE_API_KEY", "TA_CLE")}

with open("/chemin/vers/document.png", "rb") as f:
    files = {"image": ("document.png", f, "image/png")}
    r = requests.post(url, headers=headers, files=files, timeout=300)

print(r.status_code)
print(r.json())

javascript

import fs from "node:fs";

async function main() {
  const form = new FormData();
  form.append("image", new Blob([fs.readFileSync("/chemin/vers/document.png")]), "document.png");

  const res = await fetch("https://api-endpoints.alphaedge-ai.com/models/alpha-digit-max/ocr", {
    method: "POST",
    headers: { "X-API-Key": process.env.ALPHAEDGE_API_KEY || "TA_CLE" },
    body: form
  });

  console.log(res.status, await res.json());
}

main();

Réponse de l'API

La réponse est un JSON : le texte reconnu se trouve notamment dans le champ text. Pour les extensions de fichier acceptées, les scores de confiance et les erreurs courantes (422), voir la page OCR.