Skip to Content
DocumentationGetting StartedQuickstart

Quickstart

Get your first GoTamil API call running in under 5 minutes.

1. Obtain your Bearer Token

Your OIDC identity provider issues JWT tokens containing your tenant_id. Include it as a Bearer token in the Authorization header.

export GOTAMIL_TOKEN="your-oidc-jwt-token"
export GOTAMIL_API="https://api.gotamil.in"

2. Proofread Tamil Text

curl -X POST "$GOTAMIL_API/v1/proofread" \
  -H "Authorization: Bearer $GOTAMIL_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "text": "தமிழ் உரை சரிபார்ப்பு சோதனை.",
    "language": "ta"
  }'

Sync response (text under 1200 chars):

{
  "request_id": "req-abc123",
  "tenant_id": "your-tenant",
  "operation_id": "op-uuid",
  "status": "succeeded",
  "provider": "gemini",
  "model": "gemini-2.5-flash",
  "latency_ms": 1200,
  "result": {
    "original_text": "...",
    "corrected_text": "...",
    "issues": [
      {
        "type": "grammar",
        "severity": "medium",
        "message": "...",
        "start": 0,
        "end": 5,
        "suggestion": "..."
      }
    ]
  }
}

3. Essay Critique

curl -X POST "$GOTAMIL_API/v1/essay-critique" \
  -H "Authorization: Bearer $GOTAMIL_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "essay": "தமிழ் கல்வி மாணவர்களின் மொழித் திறனை மேம்படுத்துகிறது...",
    "language": "ta"
  }'

4. Polling Async Operations

For longer texts (over 1200 chars) or when you send the Prefer: respond-async header, the API returns a 202 with a poll URL:

{
  "operation_id": "op-uuid",
  "status": "queued",
  "poll_url": "/v1/operations/op-uuid"
}

Poll until the status is succeeded or failed:

curl "$GOTAMIL_API/v1/operations/op-uuid" \
  -H "Authorization: Bearer $GOTAMIL_TOKEN"

Next Steps

Last updated on
IntroductionAuthentication