{"openapi":"3.1.0","info":{"title":"DEV3 Rungleaf API","version":"1.0.0"},"servers":[{"url":"/api/v1"}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"n3k_…"}}},"paths":{"/me":{"get":{"summary":"The workspace this key belongs to","tags":["Workspace"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"plan":{"type":"string"},"members":{"type":"number"}},"required":["id","name","plan","members"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/usage":{"get":{"summary":"Usage for the current billing period","tags":["Billing"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"plan":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string"},"used":{"type":"number"},"limit":{"type":"number"}},"required":["metric","used","limit"],"additionalProperties":false}}},"required":["plan","rows"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/members":{"get":{"summary":"List members","tags":["Workspace"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"role","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string"}},"required":["id","name","email","role"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/events":{"post":{"summary":"Record a metered usage event","tags":["Billing"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$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}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/resumes":{"get":{"summary":"List resumes","tags":["Resumes"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"templateKey":{"type":"string"},"version":{"type":"number"},"status":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","title","templateKey","version","status"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"post":{"summary":"Create a resume","tags":["Resumes"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$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}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"templateKey":{"type":"string"},"version":{"type":"number"},"status":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","title","templateKey","version","status"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/resumes/{id}":{"get":{"summary":"Get a resume with its content","tags":["Resumes"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"templateKey":{"type":"string"},"version":{"type":"number"},"status":{"type":"string"},"updatedAt":{"type":"string"},"content":{}},"required":["id","title","templateKey","version","status","content"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"patch":{"summary":"Update a resume (creates a new version; send expectedVersion)","tags":["Resumes"],"security":[{"bearer":[]}],"x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$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}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"templateKey":{"type":"string"},"version":{"type":"number"},"status":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","title","templateKey","version","status"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"delete":{"summary":"Delete a resume","tags":["Resumes"],"security":[{"bearer":[]}],"x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/resumes/{id}/pdf":{"get":{"summary":"Render the resume as PDF","tags":["Export"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/resumes/{id}/docx":{"get":{"summary":"Render the resume as DOCX (ATS Plain, Modern, Compact, Two column only)","tags":["Export"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/resumes/{id}/versions":{"get":{"summary":"List versions","tags":["Resumes"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"number":{"type":"number"},"note":{"type":"string"},"createdAt":{"type":"string"}},"required":["number","note"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/match":{"post":{"summary":"Keyword match score of a resume against a job description (deterministic, not an ATS simulation)","tags":["Match"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$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}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"score":{"type":"number"},"matched":{"type":"array","items":{"type":"object","properties":{"term":{"type":"string"},"kind":{"type":"string"}},"required":["term","kind"],"additionalProperties":false}},"missing":{"type":"array","items":{"type":"object","properties":{"term":{"type":"string"},"kind":{"type":"string"}},"required":["term","kind"],"additionalProperties":false}}},"required":["score","matched","missing"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/ai/tasks":{"post":{"summary":"Start an AI task (runs on the simulated engine unless the operator connected a provider)","tags":["AI"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$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}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"credits":{"type":"number"},"simulated":{"type":"boolean"},"deduped":{"type":"boolean"}},"required":["id","status","credits","simulated","deduped"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/ai/tasks/{id}":{"get":{"summary":"Task status and output","tags":["AI"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"simulated":{"type":"boolean"},"output":{"anyOf":[{},{"type":"null"}]},"error":{"type":"string"}},"required":["id","status","simulated","output","error"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/job-descriptions":{"get":{"summary":"List saved job descriptions","tags":["Job descriptions"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"company":{"type":"string"}},"required":["id","title","company"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"post":{"summary":"Save a job description (max 12,000 characters)","tags":["Job descriptions"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$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}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/public-links":{"post":{"summary":"Create a public link for a resume","tags":["Public links"],"security":[{"bearer":[]}],"x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$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}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"}},"required":["id","slug"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"get":{"summary":"List public links of a resume","tags":["Public links"],"security":[{"bearer":[]}],"x-scope":"read","parameters":[{"name":"resumeId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"viewCount":{"type":"number"},"status":{"type":"string"}},"required":["id","slug","viewCount","status"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}}}}