{"openapi":"3.1.0","info":{"title":"Providers Lane Knowledge and Provider Preparation API","version":"1.0.0","description":"Live public educational reads and stateless provider-draft preparation. Authenticated private draft import is a separate human action. No public profile creation, booking, verification or roster-write endpoint is enabled."},"servers":[{"url":"https://providerslane.com"}],"paths":{"/v1/knowledge/care-categories":{"get":{"operationId":"listCareCategories","summary":"List care categories and source-checked guide availability","x-implementation-status":"operational","security":[],"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/knowledge/care-categories/{category}":{"get":{"operationId":"getCareCategoryGuide","summary":"Read a source-linked care-category guide","x-implementation-status":"operational","security":[],"parameters":[{"name":"category","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z][a-z0-9-]{0,79}$"}}],"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/knowledge/care-categories/{category}.md":{"get":{"operationId":"getCareCategoryGuideMarkdown","summary":"Read a care-category guide as Markdown","x-implementation-status":"operational","security":[],"parameters":[{"name":"category","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z][a-z0-9-]{0,79}$"}}],"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"text/markdown":{"schema":{"type":"string"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/knowledge/care-search":{"post":{"operationId":"searchCareCategoryAnswers","summary":"Retrieve source-linked care-category passages","x-implementation-status":"operational","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"question":{"type":"string","minLength":2,"maxLength":240},"category":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z][a-z0-9-]{0,79}$"},"limit":{"type":"integer","minimum":1,"maximum":8}},"required":["question"]}}}},"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/knowledge/catalog":{"get":{"operationId":"listMedicalSpecialties","summary":"List specialty labels and care categories","x-implementation-status":"operational","security":[],"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/knowledge/specialties/{specialty}":{"get":{"operationId":"getMedicalSpecialty","summary":"Read a specialty definition","x-implementation-status":"operational","security":[],"parameters":[{"name":"specialty","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z][a-z0-9-]{0,79}$"}}],"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/knowledge/guides/{specialty}":{"get":{"operationId":"getSpecialtyGuide","summary":"Read a full source-linked guide","x-implementation-status":"operational","security":[],"parameters":[{"name":"specialty","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z][a-z0-9-]{0,79}$"}}],"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"application/json":{"schema":{"type":"object","required":["apiVersion","kind","scope","contentRevision","notice","data"],"properties":{"apiVersion":{"type":"string"},"kind":{"type":"string"},"scope":{"type":"string","const":"public_education"},"contentRevision":{"type":"string","pattern":"^[a-f0-9]{64}$"},"notice":{"type":"string"},"data":{"$ref":"#/components/schemas/Guide"}},"additionalProperties":false}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/knowledge/guides/{specialty}.md":{"get":{"operationId":"getSpecialtyGuideMarkdown","summary":"Read the same guide as Markdown","x-implementation-status":"operational","security":[],"parameters":[{"name":"specialty","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z][a-z0-9-]{0,79}$"}}],"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"text/markdown":{"schema":{"type":"string"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/knowledge/search":{"post":{"operationId":"searchSpecialtyAnswers","summary":"Retrieve source-linked answer passages","x-implementation-status":"operational","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"question":{"type":"string","minLength":2,"maxLength":240},"specialty":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z][a-z0-9-]{0,79}$"},"limit":{"type":"integer","minimum":1,"maximum":8}},"required":["question"]}}}},"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/knowledge/compare":{"post":{"operationId":"compareMedicalSpecialties","summary":"Compare specialty information without medical recommendations","x-implementation-status":"operational","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"specialties":{"type":"array","minItems":2,"maxItems":4,"uniqueItems":true,"items":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z][a-z0-9-]{0,79}$"}}},"required":["specialties"]}}}},"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/provider-onboarding/schema":{"get":{"operationId":"getProviderProfileSchema","summary":"Read the portable private-profile draft schema","x-implementation-status":"operational","security":[],"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}},"/v1/provider-onboarding/prepare":{"post":{"operationId":"prepareProviderProfile","summary":"Prepare a draft packet for human review; does not save a profile","x-implementation-status":"operational","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"profile":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":160,"minLength":1},"credentials":{"type":"string","maxLength":80},"specialty":{"type":"string","enum":["allergy-immunology","anesthesiology","colon-rectal-surgery","dermatology","emergency-medicine","family-medicine","medical-genetics","internal-medicine","neurosurgery","nuclear-medicine","obgyn","ophthalmology","orthopedic-surgery","otolaryngology","dentistry","pathology","pediatrics","physical-medicine-rehabilitation","plastic-surgery","preventive-medicine","psychiatry","radiation-oncology","radiology","general-surgery","urology","psychology","counseling","social-work","nurse-practitioner","physician-assistant","nutrition","physical-therapy","occupational-therapy","speech-language"]},"bio":{"type":"string","maxLength":3000,"minLength":1},"city":{"type":"string","maxLength":80},"state":{"type":"string","pattern":"^(?:[A-Z]{2})?$"},"zip":{"type":"string","pattern":"^(?:[0-9]{5}(?:-[0-9]{4})?)?$"},"visit_type":{"type":"string","enum":["both","video","in-person"]},"languages":{"type":"string","maxLength":160,"minLength":1},"insurance":{"type":"string","maxLength":250}}}},"required":["profile"]}}}},"responses":{"200":{"description":"Public content or stateless preparation result; never proof of publication or verification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"description":"Invalid request"},"403":{"description":"Invalid Origin or credentials supplied to a public-only endpoint"},"404":{"description":"Unknown specialty or unavailable published guide"},"405":{"description":"Unsupported HTTP method"},"413":{"description":"Request exceeds 16 KiB"},"415":{"description":"Use uncompressed application/json"},"422":{"description":"Schema validation failed"},"429":{"description":"Instance request budget exceeded; honor Retry-After"}},"x-idempotent":true}}},"components":{"schemas":{"Envelope":{"type":"object","required":["apiVersion","kind","scope","contentRevision","notice","data"],"properties":{"apiVersion":{"type":"string"},"kind":{"type":"string"},"scope":{"type":"string","const":"public_education"},"contentRevision":{"type":"string","pattern":"^[a-f0-9]{64}$"},"notice":{"type":"string"},"data":{"type":"object"}},"additionalProperties":false},"Source":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"title":{"type":"string"},"publisher":{"type":"string"},"url":{"type":"string","format":"uri"},"checkedOn":{"type":"string","format":"date"}},"required":["id","title","publisher","url","checkedOn"]},"Passage":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/Source"}}},"required":["text","sources"]},"Guide":{"type":"object","required":["specialty","title","url","version","summary","sections","questions","sources","review"],"properties":{"specialty":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z][a-z0-9-]{0,79}$"},"title":{"type":"string"},"description":{"type":"string"},"heading":{"type":"string"},"url":{"type":"string","format":"uri"},"version":{"type":"string"},"publishedOn":{"type":"string"},"modifiedOn":{"type":"string"},"contentSha256":{"type":"string"},"summary":{"$ref":"#/components/schemas/Passage"},"sections":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"paragraphs":{"type":"array","items":{"$ref":"#/components/schemas/Passage"}},"questions":{"type":"array","items":{"type":"string"}}},"required":["id","title","url","paragraphs","questions"]}},"questions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"question":{"type":"string"},"answer":{"type":"string"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/Source"}}},"required":["question","answer","sources"]}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/Source"}},"review":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"sourceCheckedOn":{"type":"string"},"clinicianReviewed":{"type":"boolean","const":false},"attribution":{"type":"string"}},"required":["type","sourceCheckedOn","clinicianReviewed","attribution"]},"related":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"label":{"type":"string"},"url":{"type":"string"}},"required":["label","url"]}},"providerListingsAvailable":{"type":"boolean","const":false}},"additionalProperties":false}}}}