Docs

Quickstart

Last updated: 2026-07-212 min read

The GREM Developer API lets you call our tools — property valuation, content generation, photo enhancement, avatar video, site and PDF generation, and the AI chat — programmatically over HTTPS. Requests and responses are JSON.

Base URL

Every endpoint lives under this base:

https://developers.grem.capital/api/v1

1. Get an API key

In the cabinet, open AI tools → API and create a key on the Keys tab. The secret (gsk_live_…) is shown once — copy it right away.

Treat the key like a password: it grants access to your account's tools and billing. Never commit it to source control or expose it in browser code.

2. Make your first call

GET /ping verifies your key and costs nothing:

curl -H "Authorization: Bearer gsk_live_xxx" \
  https://developers.grem.capital/api/v1/ping
{ "ok": true, "subjectId": "…", "requestId": "req_…" }

3. Call a tool

A synchronous example — express property valuation:

curl -X POST https://developers.grem.capital/api/v1/valuation/express \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"propertyCategory":"apartment","totalArea":50}'
{
  "estimate": { "pricePoint": 156250, "rangeLow": 125575, "rangeHigh": 207813, "currency": "USD" },
  "requestId": "req_…"
}

Long-running tools

Tools like content, avatar or PDF generation return a job (202 with a jobId). Poll the job's status endpoint (polling is free) or, better, subscribe to a webhook to be notified when it completes. Generated files are served through our domain as artifacts.

Explore every endpoint

Interactive explorer

Try requests live in Swagger UI at https://developers.grem.capital/docs.

OpenAPI spec

Import https://developers.grem.capital/openapi.json into Postman or Insomnia, or use it to generate a client.

Read the essentials

Common questions

Where do I get an API key?

In the cabinet: AI tools > API, the Keys tab. The secret is shown once - copy it immediately.

What is the base URL?

https://developers.grem.capital/api/v1

How do I check that a key works?

Call GET /ping - it is not billed.

Are reads billed?

No. GET requests are not counted as API calls and are not charged to the wallet, including polling the status of deferred jobs.

What do I do when a call returns 402?

The wallet is short of funds or the plan quota is used up. Top up the balance or move to a higher plan.

Was this article helpful?