Integrations & API

Every request is authenticated with an API key sent in the X-API-Key header. Create keys from the "API access" section of your profile — each key is shown once, then stored only as a hash. Requests act as the account that owns the key, so plans, limits and template access apply exactly as on the web.

X-API-Key: sk_xxxxxxxxxxxxxxxx
Accept: application/json
Accept-Language: ar   # or "en" — localizes messages

Inspect the account behind the key — plan, subscription and current usage. Useful for showing remaining quota in your own dashboard before creating CVs or downloading files.

{
  "data": {
    "id": 7, "name": "Acme HR", "email": "hr@acme.example",
    "plan": { "key": "pro", "name": "Pro", "cv_limit": null,
              "download_limit": null, "premium_templates": true, "watermark": false },
    "subscription": { "status": "active", "ends_at": "2026-08-30T00:00:00+03:00" },
    "usage": { "cvs": 12, "downloads_this_month": 31 },
    "api_key": { "name": "HR system production", "prefix": "sk_AbCdEf1…" }
  }
}

The templates your account can use — platform templates plus your company's own. available is false for premium templates on a free plan, and every template has a live preview_url.

{
  "id": 1, "slug": "aurora", "name": "Aurora",
  "description": "A vivid modern template with a bold color header.",
  "category": "professional", "layout": "modern",
  "is_premium": false, "is_company_template": false, "available": true,
  "preview_url": "https://seerati.g4t.io/templates/1/demo"
}

Full lifecycle for the account's CVs. CVs are addressed by their UUID, and every response includes links (self, pdf, html, and a public no-auth share page).

Body parameters — create

export API_KEY="sk_xxxxxxxxxxxxxxxx"

# Create
CV=$(curl -s https://seerati.g4t.io/api/v1/cvs \
  -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" -H "Accept: application/json" \
  -d '{"title":"Backend CV","locale":"ar","template_id":1}' | jq -r .data.id)

# Fill a section
curl -s -X PUT https://seerati.g4t.io/api/v1/cvs/$CV \
  -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" -H "Accept: application/json" \
  -d '{"sections":{"skills":[{"name":"Laravel","level":"expert"}]}}'

GET returns this shape and PUT accepts it back — it is the exact payload the web editor autosaves, so anything possible in the editor is possible via the API. Section arrays are replaced wholesale per section. Month fields use YYYY-MM; birth_date uses YYYY-MM-DD.

{
  "title": "Backend CV",
  "locale": "ar",
  "personal": { "full_name": "…", "job_title": "…", "summary": "…", "email": "…", "phone": "…",
                "website": "…", "address": "…", "nationality": "…", "birth_date": "1995-04-02" },
  "settings": { "primary_color": "#0f766e", "theme": "light", "font_family": "Cairo" },
  "section_order": ["experience", "education", "skills"],
  "hidden_sections": [],
  "sections": {
    "experience":     [{ "company": "…", "position": "…", "location": "…", "description": "…",
                         "start_date": "2021-03", "end_date": null, "is_current": true }],
    "education":      [{ "institution": "…", "degree": "…", "field_of_study": "…", "gpa": "…" }],
    "skills":         [{ "name": "Figma", "level": "expert" }],
    "languages":      [{ "name": "العربية", "level": "native" }],
    "certifications": [{ "name": "…", "issuer": "…", "url": "…", "issue_date": "2023-05" }],
    "projects":       [{ "name": "…", "description": "…", "url": "…" }],
    "awards":         [{ "title": "…", "issuer": "…", "description": "…", "date": "2024-01" }],
    "volunteers":     [{ "organization": "…", "role": "…", "description": "…" }],
    "references":     [{ "name": "…", "position": "…", "company": "…", "email": "…", "phone": "…" }],
    "tasks":          [{ "description": "…" }],
    "expertise":      [{ "description": "…" }]
  },
  "custom_sections": [{ "key": "custom-abc123", "title": "…", "content": "…" }]
}

Rendered by a real browser engine — correct Arabic shaping, RTL layout and print-grade output. Downloads count toward the plan's monthly limit, and free-plan exports carry a watermark.

curl -s -L https://seerati.g4t.io/api/v1/cvs/$CV/pdf -H "X-API-Key: $API_KEY" -o cv.pdf

The public plan catalogue — the only endpoint that needs no key. Upgrades happen on the website.

Success responses wrap results in { "data": … }; errors return { "message": …, "errors": { field: [ … ] } }.

Send Accept-Language: ar or en to localize messages. Cache template and plan lists where you can — they rarely change.