Skip to main content
POST
/
v1
/
resume
/
{id}
/
share
Create Resume Share
curl --request POST \
  --url https://api.mokaru.ai/v1/resume/{id}/share \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "blurOptions": {}
}
'
{
  "success": true,
  "shareId": "<string>",
  "shareUrl": "<string>",
  "createdAt": "<string>",
  "reused": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.mokaru.ai/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Generate a public share link for a resume. The endpoint snapshots the resume’s current cvData, design settings, section order and optional fields into a EmpResumeShare row so the shared page renders the state at share-creation time, independent of later edits to the underlying resume. If a share already exists for this resume, the existing link is returned (upsert behaviour). Common use cases:
  • Send your CV without a PDF - share a live web URL instead of attaching a file.
  • Privacy-respecting share - blur company names, institutions, LinkedIn, etc. via blurOptions.
  • AI agent application flow - autofill the recruiter’s contact form with a Mokaru share link.
Scope required: resume:share | Rate limit: 10 requests/min

Request

POST /v1/resume/{id}/share

Path Parameters

id
string
required
Resume id to share.

Body Parameters

blurOptions
object
Privacy toggles. Each truthy key blurs the corresponding field on the public view.

Example

curl -X POST "https://api.mokaru.ai/v1/resume/clx1234/share" \
  -H "Authorization: Bearer mk_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "blurOptions": { "blurCompanies": true } }'

Response

success
boolean
Whether the share was created (or returned).
shareId
string
Share row ID (used in the URL).
shareUrl
string
Public URL, e.g. https://app.mokaru.ai/share/abc123.
createdAt
string
ISO 8601 timestamp of when this share was originally created.
reused
boolean
true if an existing share for this resume was returned instead of creating a new one.
{
  "success": true,
  "shareId": "clx_share_abc",
  "shareUrl": "https://app.mokaru.ai/share/clx_share_abc",
  "createdAt": "2026-05-21T10:00:00.000Z",
  "reused": false
}