Quickstart

Make your first request in five minutes with a free sandbox key.

Get a sandbox key

Sign in to EduMark and open Settings → Developer API. Choose Create key, pick Sandbox, give it a name and choose what it may do. Copy the secret: it starts with edm_sandbox_ and is shown once.

Sandbox keys are free on every plan. They return realistic example results in about two seconds and never run AI, charge money or touch real learner data.

Send a request

Every AI product is a POST that answers straight away with 202 Accepted and a job. Send a unique Idempotency-Key so a retry never creates a second job.

export EDUMARK_API_KEY=edm_sandbox_...

curl -X POST https://api.edumark.ai/v1/flashcards \
  -H "Authorization: Bearer $EDUMARK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"topic": "Photosynthesis", "count": 5}'

Get the result

Poll GET /v1/jobs/{id} until status is succeeded (or needs_context, failed, cancelled). Wait poll_after_seconds between polls. The finished job carries result and any files.

  1. Queued202 and a job id, straight away
  2. ProcessingPoll, stream or wait for a webhook
  3. SucceededResult and files on the job
Every AI request runs as a background job, so nothing times out.

When you are ready for real work, create a Live key, add API balance or switch on Use credits towards API, and swap the key. Nothing else changes.

NextKeys and sandbox