Getting started

Four steps to your first recognition job.

1. Create an account

Register at /register, then verify your email (in development, the verification link is stored in the dev mail outbox and logged to the API console).

2. Create an API key

In the dashboard open API Keys → Create key. The full secret is shown once — store it somewhere safe. Keys look like sgk_<prefix>_<secret>.

3. Submit a job

curl -X POST http://localhost:4000/api/v1/recognition/jobs \
  -H "Authorization: Bearer sgk_your_key" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: my-first-job" \
  -d '{
    "operation": "text",
    "challenge": {
      "kind": "synthetic",
      "fixture": "sg-text-hello",
      "category": "text"
    }
  }'

Response:

{
  "id": "2c9f…",
  "status": "queued",
  "provider": "local-demo",
  "executionMode": "demo",
  "creditsReserved": 1,
  …
}

4. Poll for the result

curl http://localhost:4000/api/v1/recognition/jobs/2c9f… \
  -H "Authorization: Bearer sgk_your_key"

{
  "status": "succeeded",
  "result": { "type": "text", "value": "hello", "confidence": 1 },
  "creditsCharged": 1,
  "processingMs": 27
}

See Synthetic fixtures for every fixture the demo provider accepts.