DEV3 Rungleaf REST API
Base URL /api/v1 · Authenticate with Authorization: Bearer n3k_… · OpenAPI 3.1 JSON
/api/v1/mescope: readThe workspace this key belongs to
/api/v1/usagescope: readUsage for the current billing period
/api/v1/membersscope: readList members
Parameters: role (query)
/api/v1/eventsscope: writeRecord 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
}/api/v1/resumesscope: readList resumes
Parameters: limit (query)
/api/v1/resumesscope: writeCreate 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
}/api/v1/resumes/{id}scope: readGet a resume with its content
Parameters: id (path)
/api/v1/resumes/{id}scope: writeUpdate 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
}/api/v1/resumes/{id}scope: writeDelete a resume
Parameters: id (path)
/api/v1/resumes/{id}/pdfscope: readRender the resume as PDF
Parameters: id (path)
/api/v1/resumes/{id}/docxscope: readRender the resume as DOCX (ATS Plain, Modern, Compact, Two column only)
Parameters: id (path)
/api/v1/resumes/{id}/versionsscope: readList versions
Parameters: id (path)
/api/v1/matchscope: writeKeyword 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
}/api/v1/ai/tasksscope: writeStart 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
}/api/v1/ai/tasks/{id}scope: readTask status and output
Parameters: id (path)
/api/v1/job-descriptionsscope: readList saved job descriptions
/api/v1/job-descriptionsscope: writeSave 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
}/api/v1/public-linksscope: writeCreate 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
}/api/v1/public-linksscope: readList public links of a resume
Parameters: resumeId (query)