Démarrage rapide

Dans l'espace personnel, ouvrez API → Clés et cliquez sur Créer la clé. La clé n'est affichée qu'une seule fois - conservez-la dans un gestionnaire de secrets. Une nouvelle clé reçoit tous les scopes ; vous pouvez les restreindre à la création. Détails : Authentification.

curl https://developers.grem.capital/api/v1/ping \
  -H "Authorization: Bearer gsk_live_xxx"

{"ok": true, ...} signifie que la clé fonctionne. GET /ping est gratuit et ne demande aucun scope. GET /me indique précisément ce que la clé est autorisée à faire.

L'estimation express répond immédiatement :

curl -X POST https://developers.grem.capital/api/v1/valuation/express \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6b1f0c2e-6c1e-4a8e-9f5d-3c2a1b0e9d87" \
  -d '{"propertyCategory":"apartment","addressText":"Torstraße 12, Berlin","totalArea":64,"rooms":2,"currency":"EUR"}'

{
  "estimate": { "pricePoint": <number>, "rangeLow": <number>, "rangeHigh": <number>, "confidence": "<level>", "currency": "EUR" },
  "requestId": "req_..."
}

Idempotency-Key rend une nouvelle tentative sans risque : répéter la requête avec la même clé renvoie le premier résultat sans facturer une seconde fois.

Les outils longs répondent 202 avec une tâche. Si vous voulez recevoir le résultat par webhook, abonnez-vous d'abord (étape 5) : une tâche lancée avant l'abonnement n'envoie pas son événement.

curl -X POST https://developers.grem.capital/api/v1/text/generate \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"city":"Berlin","totalArea":64,"rooms":2,"propertyCategory":"apartment","language":"en"}'

{ "jobId": "...", "status": "...", "state": "pending", "requestId": "req_..." }

Interrogez le statut (gratuit) jusqu'à ce que state vaille completed, partial ou failed :

curl https://developers.grem.capital/api/v1/text/generate/jobs/JOB_ID \
  -H "Authorization: Bearer gsk_live_xxx"

Le fonctionnement des tâches et le téléchargement des fichiers : Tâches et résultats.

Au lieu d'interroger le statut, abonnez-vous à l'événement : GREM envoie un POST à votre URL lorsque la tâche se termine. Abonnez-vous avant de lancer la tâche : une tâche lancée avant l'abonnement n'envoie pas son événement.

curl -X POST https://developers.grem.capital/api/v1/webhooks \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/grem-hook","events":["text.completed","text.failed"]}'

La réponse contient le secret de signature whsec_... - il n'est affiché qu'une seule fois. Comment vérifier la signature : Webhooks.