Developer Documentation

Upload a PDF, DOCX, or TXT file and extract text content. Max 10 MB.

Request

Multipart form data with a file field.

curl -X POST https://ask-tamar.com/api/v1/resumes/parse \
  -H "Authorization: Bearer tmr_..." \
  -F "[email protected]"

Response 200

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "text": "John Doe\nSenior Software Engineer...",
    "fileName": "resume.pdf",
    "pages": 2
  }
}

List all experience profiles for the authenticated user, most recently updated first.

Response 200

{
  "data": {
    "hasProfile": true,
    "profiles": [
      {
        "id": "660e8400-...",
        "name": "John Doe",
        "currentRole": "Senior Software Engineer",
        "seniority": "senior",
        "skills": ["Python", "AWS", "PostgreSQL"],
        "qaHistoryCount": 4,
        "sourceFileName": "resume.pdf",
        "updatedAt": "2026-03-28T10:00:00Z"
      }
    ]
  }
}

Returns hasProfile: false with an empty array if no profile exists yet.

Generate tailored enrichment questions based on a resume. Use the returned questions to collect answers from the candidate, then pass them as qaHistory to POST /profiles/synthesize for a higher-quality experience profile.

Two-step enrichment workflow

1. Call POST /profiles/questions → receive questions
2. Present questions to the user, collect their answers
3. Call POST /profiles/synthesize with qaHistory → create enriched profile

Request

{
  "sourceResumeId": "550e8400-..."
}

Provide either sourceResumeId or resumeText.

Response 200

{
  "data": {
    "seniority": "senior",
    "questions": [
      "Can you tell me about a time you led a cross-functional project?",
      "What's the largest team or codebase you've owned end-to-end?"
    ]
  }
}

Create or update an enriched experience profile from resume text and optional Q&A history. Profiles enable higher-quality tailoring.

Request

{
  "sourceResumeId": "550e8400-...",
  "resumeText": "John Doe\nSenior Software Engineer...",
  "qaHistory": [
    { "q": "Tell me about your leadership experience", "a": "I led a team of 5..." }
  ]
}

Provide either sourceResumeId or resumeText. The qaHistory is optional.

Response 200

{
  "data": {
    "profileId": "660e8400-...",
    "profileData": { "...": "structured experience profile" },
    "seniority": "senior"
  }
}

Generate a tailored resume by matching a resume or profile against a job description. Resolution order: profileId → sourceResumeId → resumeText.

Request

{
  "profileId": "660e8400-...",
  "sourceResumeId": "550e8400-...",
  "resumeText": "John Doe\nSenior Software Engineer...",
  "jobDescription": "We are looking for a Senior Backend Engineer...",
  "jobUrl": "https://linkedin.com/jobs/12345"
}

Provide at least one of profileId, sourceResumeId, or resumeText. Provide either jobDescription or jobUrl.

cURL Example

curl -X POST https://ask-tamar.com/api/v1/tailor \
  -H "Authorization: Bearer tmr_..." \
  -H "Content-Type: application/json" \
  -d '{
    "sourceResumeId": "550e8400-...",
    "jobDescription": "Senior Backend Engineer at Acme Corp..."
  }'

Response 200

{
  "data": {
    "id": "770e8400-...",
    "quality": "enriched",
    "analysis": {
      "mustHaves": ["Python", "AWS", "PostgreSQL"],
      "niceToHaves": ["Kubernetes", "GraphQL"],
      "strongMatches": ["Python", "AWS"],
      "transferableSkills": ["System design → architecture role"],
      "gaps": ["Kubernetes — no production experience listed"]
    },
    "resumeData": { "...": "structured resume data" },
    "changes": [{ "...": "list of changes made" }]
  }
}

The quality field is either enriched (used an experience profile) or basic (resume text only).

Fetch a generated resume by ID. Optionally specify a version number.

Query Parameters

Response 200

{
  "data": {
    "id": "770e8400-...",
    "resumeData": { "...": "structured resume" },
    "analysis": { "...": "match analysis" },
    "changes": [{ "...": "changes" }],
    "version": 2,
    "versions": [
      { "id": "770e8400-...", "version": 1, "feedback": null, "created_at": "2026-03-28T10:00:00Z" },
      { "id": "770e8400-...", "version": 2, "feedback": "Make the summary shorter", "created_at": "2026-03-28T10:05:00Z" }
    ],
    "quality": "enriched"
  }
}

Submit natural-language feedback to modify a generated resume. Creates a new version.

Request

{
  "feedback": "Make the summary shorter and emphasize Python experience",
  "selectionContext": { "optional": "context about selected elements" }
}

Response 200

{
  "data": {
    "version": 3,
    "changes": [{ "...": "changes applied" }],
    "resumeData": { "...": "updated structured resume" }
  }
}

Generate and download a PDF of the tailored resume.

cURL Example

curl -o resume.pdf \
  https://ask-tamar.com/api/v1/tailor/770e8400-.../pdf \
  -H "Authorization: Bearer tmr_..."

Response 200

Binary PDF file with Content-Type: application/pdf.

Check your current plan, subscription status, and usage for the billing period.

Response 200

{
  "data": {
    "plan": "developer",
    "planLabel": "Developer",
    "subscriptionStatus": "active",
    "currentPeriodEnd": "2026-04-28T10:00:00Z",
    "canceling": false,
    "usage": {
      "resumesThisMonth": 7,
      "resumeLimit": null,
      "iterationsPerResume": null
    },
    "rateLimitPerMinute": 60
  }
}

resumeLimit and iterationsPerResume are null when unlimited.

Create a new API key. Requires a session cookie (not an API key) — use this from the web app or after logging in. The raw key is returned once. Store it securely.

Request

{
  "name": "My integration"
}

Response 201

{
  "data": {
    "id": "880e8400-...",
    "key": "tmr_abc123def456...",
    "keyPrefix": "tmr_abc1...",
    "name": "My integration",
    "plan": "free",
    "createdAt": "2026-03-28T10:00:00Z"
  }
}

The key field is only shown in this response. Subsequent listings show only the prefix.

List your API keys. Requires a session cookie.

Response 200

{
  "data": [
    {
      "id": "880e8400-...",
      "keyPrefix": "tmr_abc1...",
      "name": "My integration",
      "plan": "free",
      "scopes": ["*"],
      "lastUsedAt": "2026-03-28T12:00:00Z",
      "expiresAt": null,
      "revoked": false,
      "createdAt": "2026-03-28T10:00:00Z"
    }
  ]
}

Revoke an API key. This is a soft-delete and cannot be undone. Requires a session cookie.

Response 200

{
  "data": {
    "id": "880e8400-...",
    "revoked": true
  }
}