DEV3 Rungleaf
Sign inBuild my resume

DEV3 Rungleaf REST API

Base URL /api/v1 · Authenticate with Authorization: Bearer n3k_… · OpenAPI 3.1 JSON

get/api/v1/mescope: read

The workspace this key belongs to

get/api/v1/usagescope: read

Usage for the current billing period

get/api/v1/membersscope: read

List members

Parameters: role (query)

post/api/v1/eventsscope: write

Record a metered usage event

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "metric": {
      "type": "string",
      "pattern": "^[a-z0-9._-]+$"
    },
    "quantity": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 1000000
    }
  },
  "required": [
    "metric",
    "quantity"
  ],
  "additionalProperties": false
}
get/api/v1/resumesscope: read

List resumes

Parameters: limit (query)

post/api/v1/resumesscope: write

Create a resume

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "templateKey": {
      "type": "string"
    },
    "content": {}
  },
  "required": [
    "title"
  ],
  "additionalProperties": false
}
get/api/v1/resumes/{id}scope: read

Get a resume with its content

Parameters: id (path)

patch/api/v1/resumes/{id}scope: write

Update a resume (creates a new version; send expectedVersion)

Parameters: id (path)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedVersion": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "title": {
      "type": "string"
    },
    "templateKey": {
      "type": "string"
    },
    "content": {},
    "note": {
      "type": "string"
    }
  },
  "required": [
    "expectedVersion"
  ],
  "additionalProperties": false
}
delete/api/v1/resumes/{id}scope: write

Delete a resume

Parameters: id (path)

get/api/v1/resumes/{id}/pdfscope: read

Render the resume as PDF

Parameters: id (path)

get/api/v1/resumes/{id}/docxscope: read

Render the resume as DOCX (ATS Plain, Modern, Compact, Two column only)

Parameters: id (path)

get/api/v1/resumes/{id}/versionsscope: read

List versions

Parameters: id (path)

post/api/v1/matchscope: write

Keyword match score of a resume against a job description (deterministic, not an ATS simulation)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "resumeId": {
      "type": "string"
    },
    "jdText": {
      "type": "string",
      "minLength": 20
    },
    "jobDescriptionId": {
      "type": "string"
    }
  },
  "required": [
    "resumeId"
  ],
  "additionalProperties": false
}
post/api/v1/ai/tasksscope: write

Start an AI task (runs on the simulated engine unless the operator connected a provider)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "task": {
      "type": "string",
      "enum": [
        "bullet.rewrite",
        "summary.write",
        "resume.tailor",
        "cover.write",
        "skills.suggest",
        "tone.check"
      ]
    },
    "input": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "task",
    "input"
  ],
  "additionalProperties": false
}
get/api/v1/ai/tasks/{id}scope: read

Task status and output

Parameters: id (path)

get/api/v1/job-descriptionsscope: read

List saved job descriptions

post/api/v1/job-descriptionsscope: write

Save a job description (max 12,000 characters)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "company": {
      "type": "string",
      "maxLength": 160
    },
    "text": {
      "type": "string",
      "minLength": 20
    }
  },
  "required": [
    "title",
    "text"
  ],
  "additionalProperties": false
}
post/api/v1/public-linksscope: write

Create a public link for a resume

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "resumeId": {
      "type": "string"
    },
    "password": {
      "type": "string",
      "minLength": 4,
      "maxLength": 100
    },
    "expiresInDays": {
      "type": "integer",
      "minimum": 1,
      "maximum": 3650
    },
    "allowDownload": {
      "type": "boolean"
    }
  },
  "required": [
    "resumeId"
  ],
  "additionalProperties": false
}