{"openapi":"3.1.0","info":{"title":"AvelinLabs API","summary":"Commercial occupation intelligence API for developer integrations.","description":"The AvelinLabs Developer API provides occupation intelligence, market intelligence, and developer account operations for enterprise software integrations.","version":"0.1.0","contact":{"name":"AvelinLabs","url":"https://avelinlabs.com/","email":"api@avelinlabs.com"},"x-avelin-governance":{"api_major_version_freeze":"v1","api_stability_policy":"additive_only","deprecated_header_policy":"legacy_skillvista_headers_removed","semantic_stability_guarantee":"ranking_and_confidence_semantics_stable","confidence_family_stability":"confidence_families_non_interchangeable_and_stable","calibration_semantics_stability":"benchmark_driven_calibration_semantics_stable"}},"paths":{"/api/v1/job/analyze":{"post":{"tags":["Occupation Intelligence"],"summary":"Analyze a job posting","description":"Analyze a job posting and return ranked O*NET occupations with calibrated confidence, semantic reasoning signals, and enriched occupation detail. Requires a Runtime API Key. Platform login bearer tokens are not accepted on runtime endpoints.","operationId":"analyze_job_api_v1_job_analyze_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobRequest"},"example":{"title":"Cloud Security Architect","description":"Lead zero-trust security architecture across AWS and Azure, define cloud security controls, guide incident response, and partner with engineering teams on secure platform design.","debug":false}}},"required":true},"responses":{"200":{"description":"Ranked occupation matches with confidence and enrichment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAnalyzeResponse"},"example":{"results":[{"onet_code":"15-1299.08","title":"Information Security Engineers","confidence":0.93,"domain_grounding":"high","domain_grounding_explanation":"Information Security Engineers is strongly supported by the inferred business domain, intent, and semantic signals extracted from the input.","matching_skills":["cloud security","incident response","aws","azure"],"confidence_explanation":"High confidence due to strong semantic alignment with cloud security architecture responsibilities.","related_occupations":[]}],"confidence":0.93,"confidence_raw":0.91,"confidence_band":"high","domain_grounding":"high","domain_grounding_explanation":"Information Security Engineers is strongly supported by the inferred business domain, intent, and semantic signals extracted from the input.","calibration_method":"logistic_regression","confidence_explanation":"High confidence due to strong family consistency across the top-ranked occupations."}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"RuntimeApiKey":[]}]}},"/api/v1/job/classify":{"post":{"tags":["Occupation Intelligence"],"summary":"Classify a job posting","description":"Classify a job posting into the single best-fit O*NET occupation while preserving the same calibrated confidence semantics used by the full analysis pipeline. Requires a Runtime API Key. Platform login bearer tokens are not accepted on runtime endpoints.","operationId":"classify_job_api_v1_job_classify_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobRequest"},"example":{"title":"AI Product Manager","description":"Own roadmap for generative AI features, partner with engineering and design, define product requirements, and evaluate customer adoption signals.","debug":false}}},"required":true},"responses":{"200":{"description":"Top occupation match with calibrated confidence.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobClassificationResponse"},"example":{"occupation":{"onet_code":"11-2021.00","title":"Marketing Managers"},"confidence":0.81,"confidence_raw":0.78,"confidence_band":"medium","domain_grounding":"medium","domain_grounding_explanation":"Marketing Managers is supported by the inferred business domain and semantic signals, but some grounding evidence is mixed.","confidence_explanation":"The posting aligns with product leadership and cross-functional ownership patterns."}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"RuntimeApiKey":[]}]}},"/api/v1/occupation/candidates":{"post":{"tags":["Occupation Intelligence"],"summary":"Retrieve plausible O*NET occupation candidates","description":"Return a deterministic, explainable O*NET 30.3 candidate list for human or downstream selection. This search endpoint does not classify the request, express correctness confidence, select a mapping, or persist results. Requires a Runtime API Key.","operationId":"get_occupation_candidates_api_v1_occupation_candidates_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OccupationCandidatesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OccupationCandidatesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"RuntimeApiKey":[]}]}},"/api/v1/occupation/{onet_code}":{"get":{"tags":["Occupation Intelligence"],"summary":"Get occupation summary","description":"Return core occupation metadata and top skills for a specific O*NET code. Requires a Runtime API Key. Platform login bearer tokens are not accepted on runtime endpoints.","operationId":"get_occupation_api_v1_occupation__onet_code__get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"onet_code","in":"path","required":true,"schema":{"type":"string","title":"Onet Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OccupationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/occupation/profile/{onet_code}":{"get":{"tags":["Occupation Intelligence"],"summary":"Get occupation profile","description":"Return a detailed O*NET occupation profile including capabilities, technologies, and related roles. Requires a Runtime API Key. Platform login bearer tokens are not accepted on runtime endpoints.","operationId":"get_occupation_profile_route_api_v1_occupation_profile__onet_code__get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"onet_code","in":"path","required":true,"schema":{"type":"string","title":"Onet Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OccupationProfileResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workforce/capabilities":{"get":{"tags":["Workforce Intelligence"],"summary":"Get Workforce service capabilities","description":"Return the controlled-beta country, geography, occupation-taxonomy, and evidence capability boundary. The initial service exposes the U.S. SOC help catalog only; public Evidence Pack creation remains unavailable. Requires a Runtime API Key.","operationId":"get_workforce_capabilities_api_v1_workforce_capabilities_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"country_code","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":2,"title":"Country Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkforceCapabilitiesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workforce/occupations":{"get":{"tags":["Workforce Intelligence"],"summary":"Search the U.S. SOC occupation catalog","description":"List or search canonical six-digit U.S. SOC occupation codes backed by the governed O*NET 30.3 reference catalog. Search is help-only: it does not classify a job, select occupations, rank investments, or infer NAICS. Requires a Runtime API Key.","operationId":"search_workforce_occupations_api_v1_workforce_occupations_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"country_code","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":2,"title":"Country Code"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Query"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkforceOccupationListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workforce/occupations/{soc_code}":{"get":{"tags":["Workforce Intelligence"],"summary":"Get U.S. SOC occupation details","description":"Return one canonical six-digit U.S. SOC occupation with associated O*NET-SOC codes and bounded O*NET 30.3 skills and tasks. SOC, O*NET-SOC, and NAICS remain separate taxonomies. Requires a Runtime API Key.","operationId":"get_workforce_occupation_detail_api_v1_workforce_occupations__soc_code__get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"soc_code","in":"path","required":true,"schema":{"type":"string","title":"Soc Code"}},{"name":"country_code","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":2,"title":"Country Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkforceOccupationDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workforce/evidence-packs":{"post":{"tags":["Workforce Intelligence"],"summary":"Create or reuse a Workforce Evidence Pack","description":"Create an account-scoped, deterministic Workforce Evidence Pack from reviewed local OEWS/QWI snapshots, the governed O*NET 30.3 catalog, and optional approved local O*NET v2 enrichment. No provider is called during the request. Requires a Runtime API Key.","operationId":"create_workforce_evidence_pack_api_v1_workforce_evidence_packs_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkforceEvidencePackCreateRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkforceEvidencePackResourceResponse"}}}},"200":{"description":"Deterministic cache reuse.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkforceEvidencePackResourceResponse"}}}},"409":{"description":"Required reviewed evidence snapshot is unavailable."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"RuntimeApiKey":[]}]}},"/api/v1/workforce/evidence-packs/{evidence_pack_id}":{"get":{"tags":["Workforce Intelligence"],"summary":"Retrieve a Workforce Evidence Pack","description":"Retrieve the account-scoped machine-readable Evidence Pack, including source lineage and evidence boundaries. Requires a Runtime API Key.","operationId":"get_workforce_evidence_pack_api_v1_workforce_evidence_packs__evidence_pack_id__get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"evidence_pack_id","in":"path","required":true,"schema":{"type":"string","title":"Evidence Pack Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkforceEvidencePackDocumentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/workforce/evidence-packs/{evidence_pack_id}/report":{"get":{"tags":["Workforce Intelligence"],"summary":"Retrieve a Workforce Evidence Pack report","description":"Retrieve the account-scoped standalone HTML report. The document has no external scripts or assets. Requires a Runtime API Key.","operationId":"get_workforce_evidence_pack_report_api_v1_workforce_evidence_packs__evidence_pack_id__report_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"evidence_pack_id","in":"path","required":true,"schema":{"type":"string","title":"Evidence Pack Id"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","pattern":"^html$","default":"html","title":"Format"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/market/top":{"get":{"tags":["Market Intelligence"],"summary":"Market Top Demand","description":"Return top market-demand terms for a selected canonical term type across active or historical market views. Requires a Runtime API Key. Platform login bearer tokens are not accepted on runtime endpoints. Percentages are shares of distinct jobs within the selected scope and optional country filter.","operationId":"market_top_api_v1_market_top_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"type","in":"query","required":true,"schema":{"enum":["technology","skill","ability","knowledge","work_activity"],"type":"string","title":"Type"}},{"name":"scope","in":"query","required":false,"schema":{"enum":["active","historical"],"type":"string","default":"active","title":"Scope"}},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Top market-demand rows by term type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketTopDemandResponse"},"example":{"scope":"active","country":"US","terms":[{"term_type":"technology","term_name":"aws","job_count":88000,"percentage":0.09}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/market/skills/trending":{"get":{"tags":["Market Intelligence"],"summary":"Get trending skills","description":"Return trending skills and growth signals derived from pre-aggregated market-intelligence tables. Requires a Runtime API Key. Platform login bearer tokens are not accepted on runtime endpoints. A growth_rate of 1.0 indicates a bootstrap condition where the current 30-day window has demand and the previous 30-day window was zero.","operationId":"market_trending_skills_api_v1_market_skills_trending_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketTrendingSkillsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/market/technologies/trending":{"get":{"tags":["Market Intelligence"],"summary":"Get trending technologies","description":"Return trending technologies with recent demand growth metrics for enterprise planning and go-to-market analysis. Requires a Runtime API Key. Platform login bearer tokens are not accepted on runtime endpoints. A growth_rate of 1.0 indicates a bootstrap condition where the current 30-day window has demand and the previous 30-day window was zero.","operationId":"market_trending_technologies_api_v1_market_technologies_trending_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketTrendingTechnologiesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/market/overview":{"get":{"tags":["Market Intelligence"],"summary":"Get market overview","description":"Return a compact market overview with top skills, top technologies, and remote-rate summaries. Requires a Runtime API Key. Platform login bearer tokens are not accepted on runtime endpoints. All overview aggregates use the active market scope.","operationId":"market_overview_api_v1_market_overview_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketOverviewResponse"}}}}},"security":[{"RuntimeApiKey":[]}]}},"/api/v1/market/remote-rate":{"get":{"tags":["Market Intelligence"],"summary":"Get remote-work rates","description":"Return remote-work rates from the market-intelligence layer for supported geographies. Requires a Runtime API Key. Platform login bearer tokens are not accepted on runtime endpoints. The response is built from the active market scope.","operationId":"market_remote_rate_api_v1_market_remote_rate_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketRemoteRateResponse"}}}}},"security":[{"RuntimeApiKey":[]}]}},"/api/v1/grounding/capabilities":{"get":{"tags":["Customer Grounding"],"summary":"Get Customer Grounding controlled beta capabilities","description":"Authenticated controlled beta capability summary for Customer Grounding. Requires a Runtime API Key; tenant context is derived from that key. This endpoint does not claim production GA, OCR, connectors, vector retrieval, SDKs, or customer UI support.","operationId":"get_customer_grounding_capabilities_api_v1_grounding_capabilities_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Get Customer Grounding Capabilities Api V1 Grounding Capabilities Get"}}}}},"security":[{"RuntimeApiKey":[]}]}},"/api/v1/grounding/sources":{"get":{"tags":["Customer Grounding"],"summary":"List Customer Grounding sources","description":"List Customer Grounding sources scoped to the authenticated Runtime API Key tenant.","operationId":"list_customer_grounding_sources_api_v1_grounding_sources_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response List Customer Grounding Sources Api V1 Grounding Sources Get"}}}}},"security":[{"RuntimeApiKey":[]}]},"post":{"tags":["Customer Grounding"],"summary":"Register a Customer Grounding source","description":"Controlled beta endpoint for registering text or Markdown Customer Grounding source metadata. Requires a Runtime API Key with Customer Grounding enabled; tenant context is derived from that key.","operationId":"register_customer_grounding_source_api_v1_grounding_sources_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroundingSourceCreateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Register Customer Grounding Source Api V1 Grounding Sources Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"RuntimeApiKey":[]}]}},"/api/v1/grounding/sources/{source_id}":{"get":{"tags":["Customer Grounding"],"summary":"Get a Customer Grounding source","operationId":"get_customer_grounding_source_api_v1_grounding_sources__source_id__get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Customer Grounding Source Api V1 Grounding Sources  Source Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Customer Grounding"],"summary":"Delete a Customer Grounding source","description":"Excludes the source from retrieval before deletion tombstone completion.","operationId":"delete_customer_grounding_source_api_v1_grounding_sources__source_id__delete","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomerGroundingSourceDeleteRequest"},{"type":"null"}],"title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Customer Grounding Source Api V1 Grounding Sources  Source Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/sources/{source_id}/ingest-text":{"post":{"tags":["Customer Grounding"],"summary":"Ingest text or Markdown into a Customer Grounding source","description":"Text/Markdown-only controlled beta ingestion. Raw content is not echoed in validation errors.","operationId":"ingest_customer_grounding_text_api_v1_grounding_sources__source_id__ingest_text_post","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroundingTextIngestRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Ingest Customer Grounding Text Api V1 Grounding Sources  Source Id  Ingest Text Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/sources/{source_id}/ingest-file":{"post":{"tags":["Customer Grounding"],"summary":"Ingest a file into a Customer Grounding source","description":"Controlled beta file ingestion for text, Markdown, selectable-text PDF, and DOCX sources. Requires a Runtime API Key with Customer Grounding enabled; tenant context is derived from that key. OCR, connector sync, image extraction, and raw document logging are not supported.","operationId":"ingest_customer_grounding_file_api_v1_grounding_sources__source_id__ingest_file_post","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_ingest_customer_grounding_file_api_v1_grounding_sources__source_id__ingest_file_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Ingest Customer Grounding File Api V1 Grounding Sources  Source Id  Ingest File Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/sources/{source_id}/versions":{"get":{"tags":["Customer Grounding"],"summary":"List Customer Grounding source versions","operationId":"list_customer_grounding_source_versions_api_v1_grounding_sources__source_id__versions_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Customer Grounding Source Versions Api V1 Grounding Sources  Source Id  Versions Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/sources/{source_id}/artifacts":{"get":{"tags":["Customer Grounding"],"summary":"List Customer Grounding artifacts","operationId":"list_customer_grounding_artifacts_api_v1_grounding_sources__source_id__artifacts_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Customer Grounding Artifacts Api V1 Grounding Sources  Source Id  Artifacts Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/sources/{source_id}/ingestion-runs":{"get":{"tags":["Customer Grounding"],"summary":"List Customer Grounding ingestion runs for a source","description":"Return bounded, tenant-scoped ingestion-run metadata for one Customer Grounding source. Responses do not include raw source text, raw uploaded documents, or internal storage references.","operationId":"list_customer_grounding_source_ingestion_runs_api_v1_grounding_sources__source_id__ingestion_runs_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Customer Grounding Source Ingestion Runs Api V1 Grounding Sources  Source Id  Ingestion Runs Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/ingestion-runs/{ingestion_run_id}":{"get":{"tags":["Customer Grounding"],"summary":"Get a Customer Grounding ingestion run","description":"Return tenant-scoped ingestion-run metadata without raw source text, raw file content, or parser-internal payloads.","operationId":"get_customer_grounding_ingestion_run_api_v1_grounding_ingestion_runs__ingestion_run_id__get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"ingestion_run_id","in":"path","required":true,"schema":{"type":"string","title":"Ingestion Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Customer Grounding Ingestion Run Api V1 Grounding Ingestion Runs  Ingestion Run Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/sources/{source_id}/disable":{"post":{"tags":["Customer Grounding"],"summary":"Disable a Customer Grounding source","operationId":"disable_customer_grounding_source_api_v1_grounding_sources__source_id__disable_post","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomerGroundingSourceActionRequest"},{"type":"null"}],"title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Disable Customer Grounding Source Api V1 Grounding Sources  Source Id  Disable Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/sources/{source_id}/enable":{"post":{"tags":["Customer Grounding"],"summary":"Enable a Customer Grounding source","operationId":"enable_customer_grounding_source_api_v1_grounding_sources__source_id__enable_post","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","title":"Source Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomerGroundingSourceActionRequest"},{"type":"null"}],"title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Enable Customer Grounding Source Api V1 Grounding Sources  Source Id  Enable Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/role-intelligence/reports":{"post":{"tags":["Customer Grounding"],"summary":"Generate a grounded Role Intelligence report","description":"Controlled beta endpoint that uses the authenticated tenant's active Customer Grounding sources to generate evidence-backed Role Intelligence with trace and review signals.","operationId":"generate_customer_grounded_role_report_api_v1_grounding_role_intelligence_reports_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroundingRoleReportRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerGroundingRoleReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"RuntimeApiKey":[]}]}},"/api/v1/grounding/usage":{"get":{"tags":["Customer Grounding"],"summary":"Get Customer Grounding usage summary","description":"Return safe aggregate Customer Grounding usage for the authenticated account-scoped tenant. The response is controlled beta usage visibility, not billing, pricing, or production GA reporting.","operationId":"get_customer_grounding_usage_api_v1_grounding_usage_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"To"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Customer Grounding Usage Api V1 Grounding Usage Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/traces":{"get":{"tags":["Customer Grounding"],"summary":"List Customer Grounding traces","description":"Return bounded, tenant-scoped trace summaries without raw prompts, raw role context, raw source documents, or internal debug payloads.","operationId":"list_customer_grounding_traces_api_v1_grounding_traces_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Customer Grounding Traces Api V1 Grounding Traces Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/reports":{"get":{"tags":["Customer Grounding"],"summary":"List Customer Grounding reports","description":"Return bounded, tenant-scoped grounded report summaries projected from persisted traces. Responses omit raw prompts, raw role context, raw documents, raw keys, and internal trace payloads.","operationId":"list_customer_grounding_reports_api_v1_grounding_reports_get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Customer Grounding Reports Api V1 Grounding Reports Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/reports/{decision_id}":{"get":{"tags":["Customer Grounding"],"summary":"Get a Customer Grounding report summary","description":"Return a tenant-scoped grounded report projection by decision id. The payload contains safe trace and evidence metadata only.","operationId":"get_customer_grounding_report_api_v1_grounding_reports__decision_id__get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"decision_id","in":"path","required":true,"schema":{"type":"string","title":"Decision Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Customer Grounding Report Api V1 Grounding Reports  Decision Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/grounding/traces/{trace_id}":{"get":{"tags":["Customer Grounding"],"summary":"Get a Customer Grounding trace summary","description":"Return a tenant-scoped customer-facing trace summary without raw documents or internal debug payloads.","operationId":"get_customer_grounding_trace_api_v1_grounding_traces__trace_id__get","security":[{"RuntimeApiKey":[]}],"parameters":[{"name":"trace_id","in":"path","required":true,"schema":{"type":"string","title":"Trace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Customer Grounding Trace Api V1 Grounding Traces  Trace Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/platform/register":{"post":{"tags":["Authentication"],"summary":"Create a developer account","description":"Request an AvelinLabs developer account for governed APIs and runtime services. The response is deliberately generic; when a new account can be created, a verification email activates the identity lifecycle.","operationId":"register_platform_user_api_v1_platform_register_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformRegisterRequest"},"example":{"email":"security.architect@example.com","password":"ChangeMe123!","full_name":"Alex Morgan","company_name":"Northwind Security"}}},"required":true},"responses":{"200":{"description":"Registration request accepted without disclosing whether the account already exists.","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Register Platform User Api V1 Platform Register Post"},"example":{"status":"pending_verification","message":"If the account can be registered, a verification email will be sent","next_step":"Check your inbox and verify your email address before logging in."}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/platform/login":{"post":{"tags":["Authentication"],"summary":"Authenticate a developer account","description":"Authenticate a registered developer and return a management bearer token for account, contract, usage, and API-key operations. This token is not intended for runtime API consumption.","operationId":"public_platform_login_api_v1_platform_login_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformLoginRequest"},"example":{"email":"security.architect@example.com","password":"ChangeMe123!"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Public Platform Login Api V1 Platform Login Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/platform/verify-email":{"get":{"tags":["Authentication"],"summary":"Verify a developer email address","description":"Validate a signed verification token from the account verification email, activate the developer identity, and provision finite Beta access when no current active or trial contract exists.","operationId":"platform_verify_email_link_api_v1_platform_verify_email_get","parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string","minLength":10,"maxLength":4096,"title":"Token"}}],"responses":{"200":{"description":"Verification outcome.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Platform Verify Email Link Api V1 Platform Verify Email Get"},"examples":{"verified":{"value":{"status":"verified","message":"Email verified successfully","beta_access":"activated","next_step":"Your Beta access has been activated. You can now log in and create a Runtime API Key."}},"invalid":{"value":{"status":"invalid_token"}},"expired":{"value":{"status":"expired_token"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Authentication"],"summary":"Verify a developer email address via legacy POST payload","description":"Compatibility endpoint for token-based email verification using a JSON payload.","operationId":"platform_verify_email_api_v1_platform_verify_email_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformVerifyEmailRequest"},"example":{"email":"security.architect@example.com","token":"avln_tk_example"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Platform Verify Email Api V1 Platform Verify Email Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/platform/resend-verification":{"post":{"tags":["Authentication"],"summary":"Resend a verification email","description":"Issue a fresh signed verification link and send it to the developer account without exposing account existence.","operationId":"platform_resend_verification_api_v1_platform_resend_verification_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformResendVerificationRequest"},"example":{"email":"security.architect@example.com"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Platform Resend Verification Api V1 Platform Resend Verification Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/platform/forgot-password":{"post":{"tags":["Authentication"],"summary":"Start a password reset","description":"Send a one-time password reset link to the developer email address without exposing account existence.","operationId":"platform_forgot_password_api_v1_platform_forgot_password_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformForgotPasswordRequest"},"example":{"email":"data.engineer@example.com"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Platform Forgot Password Api V1 Platform Forgot Password Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/platform/reset-password":{"post":{"tags":["Authentication"],"summary":"Complete a password reset","description":"Validate a one-time password reset token and replace the developer account password.","operationId":"platform_reset_password_api_v1_platform_reset_password_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformResetPasswordRequest"},"example":{"token":"avln_tk_example","new_password":"NewStrongPass123!"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Platform Reset Password Api V1 Platform Reset Password Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/platform/api-keys/create":{"post":{"tags":["Account & Usage"],"summary":"Create an API key","description":"Create a developer Runtime API Key bound to the current active contract. The generated API key is the credential used to access runtime services such as classify, analyze, market, and occupation endpoints.","operationId":"public_create_api_key_api_v1_platform_api_keys_create_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformApiKeyCreateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Public Create Api Key Api V1 Platform Api Keys Create Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ManagementBearerToken":[]}]}},"/api/v1/platform/api-keys/revoke":{"post":{"tags":["Account & Usage"],"summary":"Revoke an API key","description":"Revoke a previously issued Runtime API Key and prevent further runtime access.","operationId":"public_revoke_api_key_api_v1_platform_api_keys_revoke_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformApiKeyRevokeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Public Revoke Api Key Api V1 Platform Api Keys Revoke Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ManagementBearerToken":[]}]}},"/api/v1/platform/api-keys":{"get":{"tags":["Account & Usage"],"summary":"List API keys","description":"List Runtime API Keys available to the current developer account.","operationId":"public_list_api_keys_api_v1_platform_api_keys_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response Public List Api Keys Api V1 Platform Api Keys Get"}}}}},"security":[{"ManagementBearerToken":[]}]}},"/api/v1/platform/api-keys/{key_ref}":{"get":{"tags":["Account & Usage"],"summary":"Get API key details","description":"Return details for a single Runtime API Key owned by the current developer account. The key reference may be the legacy numeric identifier or the API key name.","operationId":"public_get_api_key_api_v1_platform_api_keys__key_ref__get","security":[{"ManagementBearerToken":[]}],"parameters":[{"name":"key_ref","in":"path","required":true,"schema":{"type":"string","title":"Key Ref"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Public Get Api Key Api V1 Platform Api Keys  Key Ref  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/platform/usage":{"get":{"tags":["Account & Usage"],"summary":"Get usage history","description":"Return usage history for the current developer account or current management principal.","operationId":"public_get_usage_api_v1_platform_usage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Public Get Usage Api V1 Platform Usage Get"}}}}},"security":[{"ManagementBearerToken":[]}]}},"/api/v1/platform/usage/daily":{"get":{"tags":["Account & Usage"],"summary":"Get daily usage","description":"Return usage records scoped to the current UTC day.","operationId":"public_get_usage_daily_api_v1_platform_usage_daily_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Public Get Usage Daily Api V1 Platform Usage Daily Get"}}}}},"security":[{"ManagementBearerToken":[]}]}},"/api/v1/platform/usage/monthly":{"get":{"tags":["Account & Usage"],"summary":"Get monthly usage","description":"Return usage records scoped to the current UTC month.","operationId":"public_get_usage_monthly_api_v1_platform_usage_monthly_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Public Get Usage Monthly Api V1 Platform Usage Monthly Get"}}}}},"security":[{"ManagementBearerToken":[]}]}},"/api/v1/platform/contracts":{"get":{"tags":["Account & Usage"],"summary":"List contracts","description":"List contracts available to the current developer account.","operationId":"public_get_contracts_api_v1_platform_contracts_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response Public Get Contracts Api V1 Platform Contracts Get"}}}}},"security":[{"ManagementBearerToken":[]}]}},"/api/v1/platform/contracts/current":{"get":{"tags":["Account & Usage"],"summary":"Get current contract","description":"Return the active contract used for developer API access and limit enforcement.","operationId":"public_get_current_contract_api_v1_platform_contracts_current_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Public Get Current Contract Api V1 Platform Contracts Current Get"}}}}},"security":[{"ManagementBearerToken":[]}]}},"/api/v1/platform/rate-limit-status":{"get":{"tags":["Account & Usage"],"summary":"Get rate-limit status","description":"Return the current contract rate-limit, quota, and concurrency status for the authenticated account or API key.","operationId":"public_get_rate_limit_status_api_v1_platform_rate_limit_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Public Get Rate Limit Status Api V1 Platform Rate Limit Status Get"}}}}},"security":[{"ManagementBearerToken":[]}]}},"/api/v1/platform/feedback":{"get":{"tags":["Feedback"],"summary":"List my feedback","description":"List feedback created by the authenticated platform user. Requires ManagementBearerToken. Runtime API Keys are not accepted.","operationId":"public_list_feedback_api_v1_platform_feedback_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PlatformFeedbackResponse"},"type":"array","title":"Response Public List Feedback Api V1 Platform Feedback Get"}}}}},"security":[{"ManagementBearerToken":[]}]},"post":{"tags":["Feedback"],"summary":"Create customer feedback","description":"Create feedback for the authenticated platform user. Requires ManagementBearerToken returned by POST /api/v1/platform/login. Runtime API Keys are not accepted.","operationId":"public_create_feedback_api_v1_platform_feedback_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformFeedbackCreateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformFeedbackResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ManagementBearerToken":[]}]}},"/api/v1/platform/feedback/{feedback_id}":{"get":{"tags":["Feedback"],"summary":"Get my feedback detail","description":"Return one feedback entry owned by the authenticated platform user. Requires ManagementBearerToken. Runtime API Keys are not accepted.","operationId":"public_get_feedback_api_v1_platform_feedback__feedback_id__get","security":[{"ManagementBearerToken":[]}],"parameters":[{"name":"feedback_id","in":"path","required":true,"schema":{"type":"integer","title":"Feedback Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformFeedbackResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/health/live":{"get":{"tags":["Health"],"summary":"Liveness probe","description":"Return a lightweight liveness signal suitable for external traffic managers and tunnel health checks.","operationId":"health_live_health_live_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/health/ready":{"get":{"tags":["Health"],"summary":"Readiness probe","description":"Return a lightweight customer-facing readiness signal indicating whether the public API is usable for governed customer traffic.","operationId":"health_ready_health_ready_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/health":{"get":{"tags":["Health"],"summary":"Legacy API health","description":"Return the legacy API health payload for backward-compatible client integrations. Requires a Runtime API Key. Platform login bearer tokens are not accepted on runtime endpoints.","operationId":"health_api_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}},"security":[{"RuntimeApiKey":[]}]}}},"components":{"schemas":{"Body_ingest_customer_grounding_file_api_v1_grounding_sources__source_id__ingest_file_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File","description":"Customer Grounding source file"},"version_label":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Version Label"},"metadata_json":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Metadata Json"}},"type":"object","required":["file"],"title":"Body_ingest_customer_grounding_file_api_v1_grounding_sources__source_id__ingest_file_post"},"ClassificationOccupation":{"properties":{"onet_code":{"type":"string","title":"Onet Code"},"title":{"type":"string","title":"Title"}},"type":"object","required":["onet_code","title"],"title":"ClassificationOccupation"},"ConfidenceDebug":{"properties":{"entropy":{"type":"number","title":"Entropy","default":0.0},"margin":{"type":"number","title":"Margin","default":0.0},"base_confidence":{"type":"number","title":"Base Confidence","default":0.0},"adjusted_confidence":{"type":"number","title":"Adjusted Confidence","default":0.0}},"type":"object","title":"ConfidenceDebug"},"CustomerGroundingRoleReportRequest":{"properties":{"role_title":{"type":"string","maxLength":500,"minLength":1,"title":"Role Title"},"role_context":{"anyOf":[{"type":"string","maxLength":10000},{"type":"null"}],"title":"Role Context"},"focus_areas":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Focus Areas"},"source_ids":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Source Ids"},"top_k":{"type":"integer","maximum":20.0,"minimum":1.0,"title":"Top K","default":5},"include_passport":{"type":"boolean","title":"Include Passport","default":false}},"additionalProperties":false,"type":"object","required":["role_title"],"title":"CustomerGroundingRoleReportRequest"},"CustomerGroundingRoleReportResponse":{"properties":{"report":{"additionalProperties":true,"type":"object","title":"Report"},"draft":{"additionalProperties":true,"type":"object","title":"Draft"},"trace_id":{"type":"string","title":"Trace Id"},"trace":{"additionalProperties":true,"type":"object","title":"Trace"},"evidence_references":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Evidence References"},"source_references":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Source References"},"artifact_references":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Artifact References"},"evidence_snapshots":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Evidence Snapshots"},"uncertainty_signals":{"items":{"type":"string"},"type":"array","title":"Uncertainty Signals"},"review_flags":{"items":{"type":"string"},"type":"array","title":"Review Flags"},"passport":{"anyOf":[{"$ref":"#/components/schemas/DecisionPassportV1"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["report","draft","trace_id","trace","evidence_references","source_references","artifact_references","evidence_snapshots","uncertainty_signals","review_flags"],"title":"CustomerGroundingRoleReportResponse"},"CustomerGroundingSourceActionRequest":{"properties":{},"additionalProperties":false,"type":"object","title":"CustomerGroundingSourceActionRequest"},"CustomerGroundingSourceCreateRequest":{"properties":{"source_id":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Source Id"},"source_type":{"type":"string","maxLength":100,"minLength":1,"title":"Source Type","default":"customer_text"},"title":{"type":"string","maxLength":500,"minLength":1,"title":"Title"},"owner":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}],"title":"Owner"},"permissions_scope":{"type":"string","maxLength":100,"minLength":1,"title":"Permissions Scope","default":"customer_private"},"retention_class":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Retention Class","default":"short_lived"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"}},"additionalProperties":false,"type":"object","required":["title"],"title":"CustomerGroundingSourceCreateRequest"},"CustomerGroundingSourceDeleteRequest":{"properties":{"reason":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","title":"CustomerGroundingSourceDeleteRequest"},"CustomerGroundingTextIngestRequest":{"properties":{"text":{"type":"string","maxLength":20000,"minLength":1,"title":"Text"},"content_type":{"type":"string","maxLength":100,"title":"Content Type","default":"text/markdown"},"version_label":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Version Label"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"}},"additionalProperties":false,"type":"object","required":["text"],"title":"CustomerGroundingTextIngestRequest"},"DecisionBlock":{"properties":{"decision":{"type":"string","title":"Decision","default":"REJECT"},"decision_score":{"type":"number","title":"Decision Score","default":0.0},"reason":{"type":"string","title":"Reason","default":""},"applied_rule":{"type":"string","title":"Applied Rule","default":""}},"type":"object","title":"DecisionBlock"},"DecisionPassportAbstention":{"properties":{"status":{"type":"string","enum":["not_abstained","abstained"],"title":"Status"},"reason":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","required":["status"],"title":"DecisionPassportAbstention"},"DecisionPassportAssessment":{"properties":{"confidence":{"$ref":"#/components/schemas/DecisionPassportMetric"},"trust_score":{"$ref":"#/components/schemas/DecisionPassportMetric"},"evidence_sufficiency":{"$ref":"#/components/schemas/DecisionPassportEvidenceSufficiency"},"limitations":{"items":{"$ref":"#/components/schemas/DecisionPassportLimitation"},"type":"array","maxItems":25,"title":"Limitations"}},"additionalProperties":false,"type":"object","required":["confidence","trust_score","evidence_sufficiency"],"title":"DecisionPassportAssessment"},"DecisionPassportConflict":{"properties":{"code":{"type":"string","maxLength":96,"pattern":"^[a-z][a-z0-9_]*$","title":"Code"},"summary":{"type":"string","maxLength":500,"minLength":1,"title":"Summary"},"evidence_reference_ids":{"items":{"type":"string"},"type":"array","maxItems":10,"minItems":2,"title":"Evidence Reference Ids"}},"additionalProperties":false,"type":"object","required":["code","summary","evidence_reference_ids"],"title":"DecisionPassportConflict"},"DecisionPassportCoverage":{"properties":{"status":{"type":"string","enum":["measured","limited","not_assessed","unavailable","not_applicable"],"title":"Status"},"ratio":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Ratio"},"basis":{"anyOf":[{"type":"string","maxLength":96,"minLength":1,"pattern":"^[a-z][a-z0-9_]*$"},{"type":"null"}],"title":"Basis"},"reason":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","required":["status"],"title":"DecisionPassportCoverage"},"DecisionPassportDecision":{"properties":{"decision_id":{"type":"string","maxLength":128,"minLength":3,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","title":"Decision Id"},"type":{"type":"string","const":"customer_grounded_role_intelligence","title":"Type"},"status":{"type":"string","enum":["completed","review_required","abstained"],"title":"Status"},"summary":{"type":"string","maxLength":500,"minLength":1,"title":"Summary"}},"additionalProperties":false,"type":"object","required":["decision_id","type","status","summary"],"title":"DecisionPassportDecision"},"DecisionPassportEvidence":{"properties":{"references":{"items":{"$ref":"#/components/schemas/DecisionPassportEvidenceReference"},"type":"array","maxItems":50,"title":"References"},"coverage":{"$ref":"#/components/schemas/DecisionPassportCoverage"},"freshness":{"$ref":"#/components/schemas/DecisionPassportFreshness"},"conflicts":{"items":{"$ref":"#/components/schemas/DecisionPassportConflict"},"type":"array","maxItems":25,"title":"Conflicts"},"missing_evidence":{"items":{"$ref":"#/components/schemas/DecisionPassportMissingEvidence"},"type":"array","maxItems":25,"title":"Missing Evidence"}},"additionalProperties":false,"type":"object","required":["coverage","freshness"],"title":"DecisionPassportEvidence"},"DecisionPassportEvidenceReference":{"properties":{"evidence_reference_id":{"type":"string","maxLength":128,"minLength":3,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","title":"Evidence Reference Id"},"evidence_class":{"type":"string","const":"customer_grounding","title":"Evidence Class"},"source_reference":{"type":"string","maxLength":128,"minLength":3,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","title":"Source Reference"},"source_type":{"type":"string","maxLength":96,"minLength":1,"pattern":"^[a-z][a-z0-9_]*$","title":"Source Type"},"authority":{"type":"string","const":"customer_grounded","title":"Authority"},"authority_basis":{"type":"string","maxLength":500,"minLength":1,"title":"Authority Basis"},"source_version":{"$ref":"#/components/schemas/DecisionPassportVersionState"},"relationship":{"type":"string","enum":["supports","contradicts","contextualizes"],"title":"Relationship"},"relevance":{"$ref":"#/components/schemas/DecisionPassportMetric"},"tenant_boundary":{"type":"string","enum":["authenticated_tenant","shared_reference"],"title":"Tenant Boundary"}},"additionalProperties":false,"type":"object","required":["evidence_reference_id","evidence_class","source_reference","source_type","authority","authority_basis","source_version","relationship","relevance","tenant_boundary"],"title":"DecisionPassportEvidenceReference"},"DecisionPassportEvidenceSufficiency":{"properties":{"status":{"type":"string","enum":["sufficient","limited","insufficient","not_assessed"],"title":"Status"},"basis":{"type":"string","maxLength":500,"minLength":1,"title":"Basis"}},"additionalProperties":false,"type":"object","required":["status","basis"],"title":"DecisionPassportEvidenceSufficiency"},"DecisionPassportFreshness":{"properties":{"status":{"type":"string","enum":["current","stale","not_assessed","unavailable","not_applicable"],"title":"Status"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"},"reason":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","required":["status"],"title":"DecisionPassportFreshness"},"DecisionPassportGovernance":{"properties":{"abstention":{"$ref":"#/components/schemas/DecisionPassportAbstention"},"human_review":{"$ref":"#/components/schemas/DecisionPassportHumanReview"}},"additionalProperties":false,"type":"object","required":["abstention","human_review"],"title":"DecisionPassportGovernance"},"DecisionPassportHumanReview":{"properties":{"required":{"type":"boolean","title":"Required"},"status":{"type":"string","enum":["not_required","pending","completed","unavailable"],"title":"Status"},"reasons":{"items":{"type":"string"},"type":"array","maxItems":10,"title":"Reasons"}},"additionalProperties":false,"type":"object","required":["required","status"],"title":"DecisionPassportHumanReview"},"DecisionPassportLimitation":{"properties":{"code":{"type":"string","maxLength":96,"pattern":"^[a-z][a-z0-9_]*$","title":"Code"},"summary":{"type":"string","maxLength":500,"minLength":1,"title":"Summary"},"effect":{"type":"string","enum":["inform","limit_scope","human_review","do_not_use"],"title":"Effect"}},"additionalProperties":false,"type":"object","required":["code","summary","effect"],"title":"DecisionPassportLimitation"},"DecisionPassportMetric":{"properties":{"status":{"type":"string","enum":["assessed","not_assessed","unavailable","not_applicable"],"title":"Status"},"score":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Score"},"level":{"anyOf":[{"type":"string","enum":["low","medium","high"]},{"type":"null"}],"title":"Level"},"method":{"anyOf":[{"type":"string","maxLength":128,"minLength":1},{"type":"null"}],"title":"Method"},"reason":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","required":["status"],"title":"DecisionPassportMetric"},"DecisionPassportMissingEvidence":{"properties":{"code":{"type":"string","maxLength":96,"pattern":"^[a-z][a-z0-9_]*$","title":"Code"},"summary":{"type":"string","maxLength":500,"minLength":1,"title":"Summary"},"required":{"type":"boolean","title":"Required"},"effect":{"type":"string","enum":["abstain","human_review","limit_scope"],"title":"Effect"}},"additionalProperties":false,"type":"object","required":["code","summary","required","effect"],"title":"DecisionPassportMissingEvidence"},"DecisionPassportScope":{"properties":{"purpose":{"type":"string","const":"workforce_decision_support","title":"Purpose"},"subject_reference":{"type":"string","maxLength":128,"minLength":3,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","title":"Subject Reference"},"tenant_scope":{"type":"string","const":"authenticated_tenant","title":"Tenant Scope"}},"additionalProperties":false,"type":"object","required":["purpose","subject_reference","tenant_scope"],"title":"DecisionPassportScope"},"DecisionPassportTrace":{"properties":{"decision_trace_id":{"type":"string","maxLength":128,"minLength":3,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","title":"Decision Trace Id"},"request_id":{"type":"string","maxLength":128,"minLength":3,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]*$","title":"Request Id"},"generated_at":{"type":"string","title":"Generated At"}},"additionalProperties":false,"type":"object","required":["decision_trace_id","request_id","generated_at"],"title":"DecisionPassportTrace"},"DecisionPassportV1":{"properties":{"passport_id":{"type":"string","pattern":"^dp_[a-f0-9]{32}$","title":"Passport Id"},"schema_version":{"type":"string","const":"1.0.0","title":"Schema Version"},"decision":{"$ref":"#/components/schemas/DecisionPassportDecision"},"scope":{"$ref":"#/components/schemas/DecisionPassportScope"},"evidence":{"$ref":"#/components/schemas/DecisionPassportEvidence"},"assessment":{"$ref":"#/components/schemas/DecisionPassportAssessment"},"governance":{"$ref":"#/components/schemas/DecisionPassportGovernance"},"versions":{"$ref":"#/components/schemas/DecisionPassportVersions"},"trace":{"$ref":"#/components/schemas/DecisionPassportTrace"}},"additionalProperties":false,"type":"object","required":["passport_id","schema_version","decision","scope","evidence","assessment","governance","versions","trace"],"title":"DecisionPassportV1"},"DecisionPassportVersionState":{"properties":{"status":{"type":"string","enum":["identified","pending","unavailable","not_applicable"],"title":"Status"},"value":{"anyOf":[{"type":"string","maxLength":128,"minLength":1},{"type":"null"}],"title":"Value"},"reason":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","required":["status"],"title":"DecisionPassportVersionState"},"DecisionPassportVersions":{"properties":{"decision_contract":{"$ref":"#/components/schemas/DecisionPassportVersionState"},"decision_policy":{"$ref":"#/components/schemas/DecisionPassportVersionState"},"taxonomy":{"anyOf":[{"$ref":"#/components/schemas/DecisionPassportVersionState"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["decision_contract","decision_policy"],"title":"DecisionPassportVersions"},"ExplanationScoreSummary":{"properties":{"semantic_match":{"type":"number","title":"Semantic Match","default":0.0},"skill_match":{"type":"number","title":"Skill Match","default":0.0},"domain_grounding":{"type":"number","title":"Domain Grounding","default":0.0},"domain_alignment":{"type":"number","title":"Domain Alignment","description":"Deprecated compatibility alias for domain_grounding.","default":0.0,"deprecated":true},"signal_overlap":{"type":"number","title":"Signal Overlap","default":0.0}},"type":"object","title":"ExplanationScoreSummary"},"FeedbackCategory":{"type":"string","enum":["bug","feature_request","improvement","data_quality","classification_issue","market_data_issue","general_feedback"],"title":"FeedbackCategory"},"FeedbackSeverity":{"type":"string","enum":["low","medium","high","critical"],"title":"FeedbackSeverity"},"FeedbackStatus":{"type":"string","enum":["open","under_review","planned","resolved","rejected"],"title":"FeedbackStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status"},"engine":{"type":"string","title":"Engine"},"product_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Name"},"api_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Version"},"api_major_version_freeze":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Major Version Freeze"},"api_stability_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Stability Policy"},"deprecated_header_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deprecated Header Policy"},"semantic_stability_guarantee":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Semantic Stability Guarantee"},"confidence_family_stability":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Family Stability"},"calibration_semantics_stability":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calibration Semantics Stability"},"runtime_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Runtime Mode"},"sql_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sql Mode"},"platform_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Platform Mode"},"calibration_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calibration Mode"},"observability_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observability Mode"},"strict_production_mode":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Strict Production Mode"}},"type":"object","required":["status","engine"],"title":"HealthResponse"},"JobAnalyzeResponse":{"properties":{"job_title":{"type":"string","title":"Job Title"},"model_version":{"type":"string","title":"Model Version"},"confidence":{"type":"number","title":"Confidence","default":0.0},"confidence_raw":{"type":"number","title":"Confidence Raw","default":0.0},"confidence_band":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Band","description":"Customer-facing categorical confidence band derived from calibrated runtime confidence."},"confidence_explanation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Explanation"},"calibration_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calibration Method"},"calibration_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calibration Version"},"trust_score":{"type":"number","title":"Trust Score","default":0.0},"uncertainty":{"$ref":"#/components/schemas/UncertaintyBreakdown"},"decision":{"anyOf":[{"$ref":"#/components/schemas/DecisionBlock"},{"type":"null"}]},"confidence_type":{"type":"string","title":"Confidence Type","default":"winner_strength"},"distribution_type":{"type":"string","title":"Distribution Type","default":"softmax_probability"},"task_type":{"type":"string","title":"Task Type"},"job_signals":{"items":{"type":"string"},"type":"array","title":"Job Signals"},"inferred_intent":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]},"type":"object","title":"Inferred Intent"},"title_reliability_score":{"type":"number","title":"Title Reliability Score","default":0.0},"intent_override_applied":{"type":"boolean","title":"Intent Override Applied","default":false},"onet_families":{"items":{"type":"string"},"type":"array","title":"Onet Families"},"domain_confidence":{"type":"number","title":"Domain Confidence","default":0.0},"domain_is_ambiguous":{"type":"boolean","title":"Domain Is Ambiguous","default":false},"domain_grounding":{"type":"string","title":"Domain Grounding","description":"Top-result domain grounding label derived from inferred domain, intent, and semantic support.","default":"MEDIUM"},"domain_grounding_explanation":{"type":"string","title":"Domain Grounding Explanation","description":"Customer-facing explanation of the top-result domain grounding label.","default":""},"is_ambiguous":{"type":"boolean","title":"Is Ambiguous"},"confidence_level":{"type":"string","title":"Confidence Level","description":"Compatibility confidence label derived from confidence_band for public responses."},"llm_used":{"type":"boolean","title":"Llm Used","default":false},"llm_status":{"type":"string","title":"Llm Status","default":"not_used"},"llm_reasoning":{"type":"string","title":"Llm Reasoning","default":""},"llm_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llm Error"},"weak_signal_detected":{"type":"boolean","title":"Weak Signal Detected","default":false},"weak_signal_reason":{"type":"string","title":"Weak Signal Reason","default":"signal_present"},"calibration_error":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Calibration Error"},"confidence_bucket":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Bucket"},"confidence_debug":{"anyOf":[{"$ref":"#/components/schemas/ConfidenceDebug"},{"type":"null"}]},"stage_rankings":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]},"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Stage Rankings"},"results":{"items":{"$ref":"#/components/schemas/RankingResult"},"type":"array","title":"Results"}},"type":"object","required":["job_title","model_version","task_type","job_signals","is_ambiguous","confidence_level","results"],"title":"JobAnalyzeResponse"},"JobClassificationResponse":{"properties":{"occupation":{"$ref":"#/components/schemas/ClassificationOccupation"},"confidence":{"type":"number","title":"Confidence"},"confidence_raw":{"type":"number","title":"Confidence Raw","default":0.0},"confidence_band":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Band","description":"Customer-facing categorical confidence band derived from calibrated runtime confidence."},"confidence_explanation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Explanation"},"calibration_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calibration Method"},"calibration_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calibration Version"},"trust_score":{"type":"number","title":"Trust Score","default":0.0},"uncertainty":{"$ref":"#/components/schemas/UncertaintyBreakdown"},"decision":{"anyOf":[{"$ref":"#/components/schemas/DecisionBlock"},{"type":"null"}]},"confidence_type":{"type":"string","title":"Confidence Type","default":"winner_strength"},"distribution_type":{"type":"string","title":"Distribution Type","default":"softmax_probability"},"task_type":{"type":"string","title":"Task Type"},"job_signals":{"items":{"type":"string"},"type":"array","title":"Job Signals"},"inferred_intent":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]},"type":"object","title":"Inferred Intent"},"title_reliability_score":{"type":"number","title":"Title Reliability Score","default":0.0},"intent_override_applied":{"type":"boolean","title":"Intent Override Applied","default":false},"onet_families":{"items":{"type":"string"},"type":"array","title":"Onet Families"},"domain_confidence":{"type":"number","title":"Domain Confidence","default":0.0},"domain_is_ambiguous":{"type":"boolean","title":"Domain Is Ambiguous","default":false},"domain_grounding":{"type":"string","title":"Domain Grounding","description":"Top-result domain grounding label derived from inferred domain, intent, and semantic support.","default":"MEDIUM"},"domain_grounding_explanation":{"type":"string","title":"Domain Grounding Explanation","description":"Customer-facing explanation of the top-result domain grounding label.","default":""},"is_ambiguous":{"type":"boolean","title":"Is Ambiguous"},"confidence_level":{"type":"string","title":"Confidence Level","description":"Compatibility confidence label derived from confidence_band for public responses."},"llm_used":{"type":"boolean","title":"Llm Used","default":false},"llm_status":{"type":"string","title":"Llm Status","default":"not_used"},"llm_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llm Error"},"weak_signal_detected":{"type":"boolean","title":"Weak Signal Detected","default":false},"weak_signal_reason":{"type":"string","title":"Weak Signal Reason","default":"signal_present"},"calibration_error":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Calibration Error"},"confidence_bucket":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Bucket"},"confidence_debug":{"anyOf":[{"$ref":"#/components/schemas/ConfidenceDebug"},{"type":"null"}]}},"type":"object","required":["occupation","confidence","task_type","job_signals","is_ambiguous","confidence_level"],"title":"JobClassificationResponse"},"JobRequest":{"properties":{"title":{"type":"string","maxLength":500,"minLength":1,"title":"Title"},"description":{"type":"string","maxLength":20000,"title":"Description","default":""},"debug":{"type":"boolean","title":"Debug","default":false}},"type":"object","required":["title"],"title":"JobRequest"},"MarketOverviewResponse":{"properties":{"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope","description":"Market aggregation scope used for the overview aggregates."},"top_skills":{"items":{"$ref":"#/components/schemas/MarketTopSkillItem"},"type":"array","title":"Top Skills"},"top_technologies":{"items":{"$ref":"#/components/schemas/MarketTopTechnologyItem"},"type":"array","title":"Top Technologies"},"remote_rate":{"items":{"$ref":"#/components/schemas/MarketRemoteRateItem"},"type":"array","title":"Remote Rate"}},"type":"object","required":["top_skills","top_technologies","remote_rate"],"title":"MarketOverviewResponse","example":{"remote_rate":[{"country_code":"US","remote_jobs":90000,"remote_rate":0.18,"total_jobs":500000}],"scope":"active","top_skills":[{"job_count":125000,"percentage":0.12,"skill_name":"Python"}],"top_technologies":[{"job_count":88000,"percentage":0.09,"technology_name":"AWS"}]}},"MarketRemoteRateItem":{"properties":{"country_code":{"type":"string","title":"Country Code"},"remote_rate":{"type":"number","title":"Remote Rate"},"remote_jobs":{"type":"integer","title":"Remote Jobs"},"total_jobs":{"type":"integer","title":"Total Jobs"}},"type":"object","required":["country_code","remote_rate","remote_jobs","total_jobs"],"title":"MarketRemoteRateItem"},"MarketRemoteRateResponse":{"properties":{"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope","description":"Market aggregation scope used for the remote-rate response."},"countries":{"items":{"$ref":"#/components/schemas/MarketRemoteRateItem"},"type":"array","title":"Countries"}},"type":"object","required":["countries"],"title":"MarketRemoteRateResponse","example":{"countries":[{"country_code":"US","remote_jobs":90000,"remote_rate":0.18,"total_jobs":500000}],"scope":"active"}},"MarketTopDemandItem":{"properties":{"term_type":{"type":"string","title":"Term Type"},"term_name":{"type":"string","title":"Term Name"},"job_count":{"type":"integer","title":"Job Count"},"percentage":{"type":"number","title":"Percentage","description":"Share of distinct jobs within the selected market scope and optional country filter."}},"type":"object","required":["term_type","term_name","job_count","percentage"],"title":"MarketTopDemandItem"},"MarketTopDemandResponse":{"properties":{"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope","description":"Market aggregation scope used to compute the response, such as active or historical."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Optional country filter applied to the response. Null means all supported countries in the selected scope."},"terms":{"items":{"$ref":"#/components/schemas/MarketTopDemandItem"},"type":"array","title":"Terms"}},"type":"object","required":["terms"],"title":"MarketTopDemandResponse","example":{"country":"US","scope":"active","terms":[{"job_count":88000,"percentage":0.09,"term_name":"AWS","term_type":"technology"}]}},"MarketTopSkillItem":{"properties":{"skill_name":{"type":"string","title":"Skill Name"},"job_count":{"type":"integer","title":"Job Count"},"percentage":{"type":"number","title":"Percentage"}},"type":"object","required":["skill_name","job_count","percentage"],"title":"MarketTopSkillItem"},"MarketTopTechnologyItem":{"properties":{"technology_name":{"type":"string","title":"Technology Name"},"job_count":{"type":"integer","title":"Job Count"},"percentage":{"type":"number","title":"Percentage"}},"type":"object","required":["technology_name","job_count","percentage"],"title":"MarketTopTechnologyItem"},"MarketTrendingSkillItem":{"properties":{"skill_name":{"type":"string","title":"Skill Name"},"growth_rate":{"type":"number","title":"Growth Rate","description":"Relative growth between the last 30 days and the previous 30 days. A value of 1.0 can indicate a bootstrap condition where the current window has demand but the previous window was zero."},"jobs_last_30_days":{"type":"integer","title":"Jobs Last 30 Days"},"jobs_previous_30_days":{"type":"integer","title":"Jobs Previous 30 Days","description":"Distinct-job count for the preceding 30-day comparison window."}},"type":"object","required":["skill_name","growth_rate","jobs_last_30_days","jobs_previous_30_days"],"title":"MarketTrendingSkillItem"},"MarketTrendingSkillsResponse":{"properties":{"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope","description":"Fixed market window used by the trending response."},"skills":{"items":{"$ref":"#/components/schemas/MarketTrendingSkillItem"},"type":"array","title":"Skills"}},"type":"object","required":["skills"],"title":"MarketTrendingSkillsResponse","example":{"scope":"last_30_days_vs_previous_30_days","skills":[{"growth_rate":0.42,"jobs_last_30_days":2400,"jobs_previous_30_days":1690,"skill_name":"Generative AI"}]}},"MarketTrendingTechnologiesResponse":{"properties":{"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope","description":"Fixed market window used by the trending response."},"technologies":{"items":{"$ref":"#/components/schemas/MarketTrendingTechnologyItem"},"type":"array","title":"Technologies"}},"type":"object","required":["technologies"],"title":"MarketTrendingTechnologiesResponse","example":{"scope":"last_30_days_vs_previous_30_days","technologies":[{"growth_rate":0.35,"jobs_last_30_days":1800,"jobs_previous_30_days":1335,"technology_name":"AWS"}]}},"MarketTrendingTechnologyItem":{"properties":{"technology_name":{"type":"string","title":"Technology Name"},"growth_rate":{"type":"number","title":"Growth Rate","description":"Relative growth between the last 30 days and the previous 30 days. A value of 1.0 can indicate a bootstrap condition where the current window has demand but the previous window was zero."},"jobs_last_30_days":{"type":"integer","title":"Jobs Last 30 Days"},"jobs_previous_30_days":{"type":"integer","title":"Jobs Previous 30 Days","description":"Distinct-job count for the preceding 30-day comparison window."}},"type":"object","required":["technology_name","growth_rate","jobs_last_30_days","jobs_previous_30_days"],"title":"MarketTrendingTechnologyItem"},"OccupationCandidate":{"properties":{"rank":{"type":"integer","title":"Rank"},"onet_code":{"type":"string","title":"Onet Code"},"title":{"type":"string","title":"Title"},"relevance_score":{"type":"number","title":"Relevance Score","description":"Ordering score within this response; not probability or confidence."},"match_reasons":{"items":{"type":"string"},"type":"array","title":"Match Reasons"},"evidence":{"anyOf":[{"$ref":"#/components/schemas/OccupationCandidateEvidence"},{"type":"null"}]},"provider_used":{"anyOf":[{"type":"string","enum":["local","openai","blend","local_fallback"]},{"type":"null"}],"title":"Provider Used"},"local_rank":{"anyOf":[{"type":"integer","maximum":10.0,"minimum":1.0},{"type":"null"}],"title":"Local Rank"},"terra_rank":{"anyOf":[{"type":"integer","maximum":5.0,"minimum":1.0},{"type":"null"}],"title":"Terra Rank"},"blend_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Blend Score","description":"Frozen B2 reciprocal-rank ordering score; not a calibrated probability."},"confidence":{"anyOf":[{"type":"string","enum":["HIGH","MEDIUM","LOW"]},{"type":"null"}],"title":"Confidence"},"rationale":{"anyOf":[{"type":"string","maxLength":600},{"type":"null"}],"title":"Rationale"}},"type":"object","required":["rank","onet_code","title","relevance_score"],"title":"OccupationCandidate"},"OccupationCandidateEvidence":{"properties":{"matched_title":{"type":"string","title":"Matched Title"},"title_match_type":{"type":"string","title":"Title Match Type"},"query_role_head":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query Role Head"},"candidate_role_head":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Candidate Role Head"},"role_head_agreement":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Role Head Agreement"},"description_term_matches":{"type":"integer","title":"Description Term Matches","default":0},"task_term_matches":{"type":"integer","title":"Task Term Matches","default":0}},"type":"object","required":["matched_title","title_match_type"],"title":"OccupationCandidateEvidence"},"OccupationCandidateQuery":{"properties":{"title":{"type":"string","title":"Title"},"description_used":{"type":"boolean","title":"Description Used"}},"type":"object","required":["title","description_used"],"title":"OccupationCandidateQuery"},"OccupationCandidatesRequest":{"properties":{"title":{"type":"string","maxLength":500,"minLength":1,"title":"Title"},"description":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}],"title":"Description"},"limit":{"type":"integer","maximum":10.0,"minimum":1.0,"title":"Limit","default":5},"country":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Country"},"subdivision":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Subdivision"}},"additionalProperties":false,"type":"object","required":["title"],"title":"OccupationCandidatesRequest"},"OccupationCandidatesResponse":{"properties":{"query":{"$ref":"#/components/schemas/OccupationCandidateQuery"},"candidates":{"items":{"$ref":"#/components/schemas/OccupationCandidate"},"type":"array","title":"Candidates"},"decision":{"type":"string","const":"candidates_only","title":"Decision","default":"candidates_only"},"mapping_selected":{"type":"boolean","const":false,"title":"Mapping Selected","default":false},"taxonomy_version":{"type":"string","title":"Taxonomy Version"},"policy":{"type":"string","title":"Policy"},"score_interpretation":{"type":"string","const":"ordering_only_not_probability","title":"Score Interpretation","default":"ordering_only_not_probability"},"attribution":{"type":"string","title":"Attribution"},"provider_requested":{"anyOf":[{"type":"string","enum":["local","openai","blend"]},{"type":"null"}],"title":"Provider Requested"},"provider_used":{"anyOf":[{"type":"string","enum":["local","openai","blend","local_fallback"]},{"type":"null"}],"title":"Provider Used"},"configuration_scope":{"anyOf":[{"type":"string","enum":["default","country","country_subdivision"]},{"type":"null"}],"title":"Configuration Scope"},"configuration_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Configuration Active"},"degraded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Degraded"},"fallback_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fallback Reason"},"auto_select":{"anyOf":[{"type":"boolean","const":false},{"type":"null"}],"title":"Auto Select"}},"type":"object","required":["query","candidates","taxonomy_version","policy","attribution"],"title":"OccupationCandidatesResponse"},"OccupationProfileItem":{"properties":{"name":{"type":"string","title":"Name"},"importance":{"type":"number","title":"Importance"},"level":{"type":"number","title":"Level"}},"type":"object","required":["name","importance","level"],"title":"OccupationProfileItem"},"OccupationProfileOccupation":{"properties":{"onet_code":{"type":"string","title":"Onet Code"},"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"}},"type":"object","required":["onet_code","title","description"],"title":"OccupationProfileOccupation"},"OccupationProfileResponse":{"properties":{"occupation":{"$ref":"#/components/schemas/OccupationProfileOccupation"},"skills":{"items":{"$ref":"#/components/schemas/OccupationProfileItem"},"type":"array","title":"Skills"},"technologies":{"items":{"$ref":"#/components/schemas/TechnologyItem"},"type":"array","title":"Technologies"},"tasks":{"items":{"type":"string"},"type":"array","title":"Tasks"},"related_occupations":{"items":{"$ref":"#/components/schemas/RelatedOccupationItem"},"type":"array","title":"Related Occupations"}},"type":"object","required":["occupation","skills","technologies","tasks","related_occupations"],"title":"OccupationProfileResponse"},"OccupationResponse":{"properties":{"onet_code":{"type":"string","title":"Onet Code"},"title":{"type":"string","title":"Title"},"top_skills":{"items":{"$ref":"#/components/schemas/TopSkill"},"type":"array","title":"Top Skills"}},"type":"object","required":["onet_code","title","top_skills"],"title":"OccupationResponse"},"PlatformApiKeyCreateRequest":{"properties":{"name":{"type":"string","maxLength":200,"minLength":1,"title":"Name"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"}},"type":"object","required":["name"],"title":"PlatformApiKeyCreateRequest"},"PlatformApiKeyRevokeRequest":{"properties":{"api_key_id":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Api Key Id","description":"Legacy compatibility identifier for an API key. Prefer the key name for customer-facing requests."},"name":{"type":"string","maxLength":200,"title":"Name","description":"Customer-facing API key name to revoke.","default":""}},"type":"object","title":"PlatformApiKeyRevokeRequest"},"PlatformFeedbackCommentResponse":{"properties":{"comment_id":{"type":"integer","title":"Comment Id"},"feedback_id":{"type":"integer","title":"Feedback Id"},"author_type":{"type":"string","title":"Author Type"},"author_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Author Email"},"comment_text":{"type":"string","title":"Comment Text"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["comment_id","feedback_id","author_type","author_email","comment_text","created_at"],"title":"PlatformFeedbackCommentResponse"},"PlatformFeedbackCreateRequest":{"properties":{"category":{"$ref":"#/components/schemas/FeedbackCategory","description":"Feedback category.","examples":["bug"]},"severity":{"$ref":"#/components/schemas/FeedbackSeverity","description":"User-assessed severity.","examples":["medium"]},"subject":{"type":"string","maxLength":250,"minLength":1,"title":"Subject","examples":["Classification issue"]},"message":{"type":"string","maxLength":10000,"minLength":1,"title":"Message","examples":["The occupation returned does not match the job description."]},"endpoint":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Endpoint","examples":["/api/v1/job/classify"]},"request_id":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Request Id","examples":["optional"]}},"type":"object","required":["category","severity","subject","message"],"title":"PlatformFeedbackCreateRequest"},"PlatformFeedbackResponse":{"properties":{"feedback_id":{"type":"integer","title":"Feedback Id"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Email"},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Type"},"category":{"$ref":"#/components/schemas/FeedbackCategory"},"severity":{"$ref":"#/components/schemas/FeedbackSeverity"},"subject":{"type":"string","title":"Subject"},"message":{"type":"string","title":"Message"},"endpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint"},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Id"},"client_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Ip"},"user_agent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Agent"},"status":{"$ref":"#/components/schemas/FeedbackStatus"},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"comments":{"items":{"$ref":"#/components/schemas/PlatformFeedbackCommentResponse"},"type":"array","title":"Comments"}},"type":"object","required":["feedback_id","category","severity","subject","message","status","created_at","updated_at"],"title":"PlatformFeedbackResponse"},"PlatformForgotPasswordRequest":{"properties":{"email":{"type":"string","maxLength":320,"minLength":3,"title":"Email"}},"type":"object","required":["email"],"title":"PlatformForgotPasswordRequest"},"PlatformLoginRequest":{"properties":{"email":{"type":"string","maxLength":320,"minLength":3,"title":"Email"},"password":{"type":"string","maxLength":200,"minLength":8,"title":"Password"}},"type":"object","required":["email","password"],"title":"PlatformLoginRequest"},"PlatformRegisterRequest":{"properties":{"email":{"type":"string","maxLength":320,"minLength":3,"title":"Email"},"password":{"type":"string","maxLength":200,"minLength":8,"title":"Password"},"full_name":{"type":"string","maxLength":200,"title":"Full Name","default":""},"company_name":{"type":"string","maxLength":200,"title":"Company Name","default":""}},"additionalProperties":true,"type":"object","required":["email","password"],"title":"PlatformRegisterRequest"},"PlatformResendVerificationRequest":{"properties":{"email":{"type":"string","maxLength":320,"minLength":3,"title":"Email"}},"type":"object","required":["email"],"title":"PlatformResendVerificationRequest"},"PlatformResetPasswordRequest":{"properties":{"token":{"type":"string","maxLength":4096,"minLength":10,"title":"Token"},"new_password":{"type":"string","maxLength":200,"minLength":8,"title":"New Password"}},"type":"object","required":["token","new_password"],"title":"PlatformResetPasswordRequest"},"PlatformVerifyEmailRequest":{"properties":{"email":{"type":"string","maxLength":320,"title":"Email","default":""},"token":{"type":"string","maxLength":4096,"minLength":10,"title":"Token"}},"type":"object","required":["token"],"title":"PlatformVerifyEmailRequest"},"ProfileItem":{"properties":{"name":{"type":"string","title":"Name"},"importance":{"type":"number","title":"Importance"}},"type":"object","required":["name","importance"],"title":"ProfileItem"},"RankingExplanation":{"properties":{"why_match":{"type":"string","title":"Why Match"},"key_factors":{"items":{"type":"string"},"type":"array","title":"Key Factors"},"score_summary":{"$ref":"#/components/schemas/ExplanationScoreSummary"}},"type":"object","required":["why_match","score_summary"],"title":"RankingExplanation"},"RankingResult":{"properties":{"onet_code":{"type":"string","title":"Onet Code"},"onet_family":{"type":"string","title":"Onet Family"},"title":{"type":"string","title":"Title"},"confidence":{"type":"number","title":"Confidence"},"confidence_raw":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence Raw"},"confidence_calibrated":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence Calibrated"},"gap_i":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Gap I"},"normalized_gap_i":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Normalized Gap I"},"confidence_raw_i":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence Raw I"},"confidence_calibrated_i":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence Calibrated I"},"realism_score":{"type":"number","title":"Realism Score","default":0.0},"quality_score":{"type":"number","title":"Quality Score","default":0.0},"quality_breakdown":{"additionalProperties":{"type":"number"},"type":"object","title":"Quality Breakdown"},"domain_grounding":{"type":"string","title":"Domain Grounding","description":"Indicates how strongly the classification is supported by inferred domain, intent, and semantic grounding signals.","default":"MEDIUM"},"domain_grounding_explanation":{"type":"string","title":"Domain Grounding Explanation","description":"Customer-facing explanation of the domain grounding result.","default":""},"domain_alignment":{"type":"string","title":"Domain Alignment","description":"Deprecated compatibility alias for domain_grounding.","default":"MEDIUM","deprecated":true},"quality_issues":{"items":{"type":"string"},"type":"array","title":"Quality Issues"},"suggested_improvements":{"items":{"type":"string"},"type":"array","title":"Suggested Improvements"},"heuristic_adjustment":{"type":"number","title":"Heuristic Adjustment","default":0.0},"skills":{"items":{"$ref":"#/components/schemas/TopSkill"},"type":"array","title":"Skills"},"knowledge":{"items":{"$ref":"#/components/schemas/ProfileItem"},"type":"array","title":"Knowledge"},"abilities":{"items":{"$ref":"#/components/schemas/ProfileItem"},"type":"array","title":"Abilities"},"tasks":{"items":{"type":"string"},"type":"array","title":"Tasks"},"technologies":{"items":{"$ref":"#/components/schemas/TechnologyItem"},"type":"array","title":"Technologies"},"matching_skills":{"items":{"type":"string"},"type":"array","title":"Matching Skills"},"matching_skills_source":{"type":"string","title":"Matching Skills Source","default":"derived"},"related_occupations":{"items":{"$ref":"#/components/schemas/RelatedOccupation"},"type":"array","title":"Related Occupations"},"explanation":{"$ref":"#/components/schemas/RankingExplanation"},"confidence_explanation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence Explanation"}},"type":"object","required":["onet_code","onet_family","title","confidence","skills","knowledge","abilities","tasks","technologies","matching_skills","related_occupations","explanation"],"title":"RankingResult"},"RelatedOccupation":{"properties":{"onet_code":{"type":"string","title":"Onet Code"},"title":{"type":"string","title":"Title"},"tier":{"type":"string","title":"Tier"},"score":{"type":"integer","title":"Score"}},"type":"object","required":["onet_code","title","tier","score"],"title":"RelatedOccupation"},"RelatedOccupationItem":{"properties":{"onet_code":{"type":"string","title":"Onet Code"},"title":{"type":"string","title":"Title"},"relatedness_tier":{"type":"string","title":"Relatedness Tier"}},"type":"object","required":["onet_code","title","relatedness_tier"],"title":"RelatedOccupationItem"},"TechnologyItem":{"properties":{"name":{"type":"string","title":"Name"},"is_hot":{"type":"boolean","title":"Is Hot"},"is_in_demand":{"type":"boolean","title":"Is In Demand"}},"type":"object","required":["name","is_hot","is_in_demand"],"title":"TechnologyItem"},"TopSkill":{"properties":{"skill_name":{"type":"string","title":"Skill Name"},"importance":{"type":"number","title":"Importance"},"level":{"type":"number","title":"Level"}},"type":"object","required":["skill_name","importance","level"],"title":"TopSkill"},"UncertaintyBreakdown":{"properties":{"aleatoric":{"type":"number","title":"Aleatoric","default":0.0},"epistemic":{"type":"number","title":"Epistemic","default":0.0},"total":{"type":"number","title":"Total","default":0.0}},"type":"object","title":"UncertaintyBreakdown"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WorkforceCapabilitiesResponse":{"properties":{"country_code":{"type":"string","const":"US","title":"Country Code"},"status":{"type":"string","const":"supported","title":"Status"},"service_status":{"type":"string","const":"controlled_beta","title":"Service Status"},"geographies":{"items":{"$ref":"#/components/schemas/WorkforceGeographyCapability"},"type":"array","title":"Geographies"},"occupation_taxonomy":{"$ref":"#/components/schemas/WorkforceOccupationTaxonomyCapability"},"features":{"$ref":"#/components/schemas/WorkforceFeatureCapabilities"},"evidence":{"$ref":"#/components/schemas/WorkforceEvidenceCapabilities"},"delivery_formats":{"items":{"type":"string"},"type":"array","title":"Delivery Formats"},"languages":{"items":{"type":"string","const":"en"},"type":"array","title":"Languages"}},"additionalProperties":false,"type":"object","required":["country_code","status","service_status","geographies","occupation_taxonomy","features","evidence","delivery_formats","languages"],"title":"WorkforceCapabilitiesResponse"},"WorkforceContextualHypothesis":{"properties":{"soc_code":{"type":"string","pattern":"^[0-9]{2}-[0-9]{4}$","title":"Soc Code"},"statement":{"type":"string","maxLength":500,"minLength":1,"title":"Statement"},"validation_required":{"type":"boolean","const":true,"title":"Validation Required"}},"additionalProperties":false,"type":"object","required":["soc_code","statement","validation_required"],"title":"WorkforceContextualHypothesis"},"WorkforceEvidenceCapabilities":{"properties":{"occupation_reference":{"type":"string","const":"available","title":"Occupation Reference"},"employment_and_wages":{"type":"string","const":"operator_snapshot_only","title":"Employment And Wages"},"industry_workforce_flows":{"type":"string","const":"operator_snapshot_only","title":"Industry Workforce Flows"}},"type":"object","required":["occupation_reference","employment_and_wages","industry_workforce_flows"],"title":"WorkforceEvidenceCapabilities"},"WorkforceEvidencePackCreateRequest":{"properties":{"country_code":{"type":"string","pattern":"^[A-Za-z]{2}$","title":"Country Code"},"region":{"$ref":"#/components/schemas/WorkforceEvidencePackRegionRequest"},"decision":{"type":"string","const":"workforce_investment","title":"Decision"},"industries":{"items":{"type":"string"},"type":"array","maxItems":25,"title":"Industries"},"occupations":{"items":{"type":"string"},"type":"array","maxItems":25,"minItems":1,"title":"Occupations"},"language":{"type":"string","const":"en","title":"Language","default":"en"},"include_onet_enrichment":{"type":"boolean","title":"Include Onet Enrichment","default":false},"contextual_relevance_hypotheses":{"items":{"$ref":"#/components/schemas/WorkforceContextualHypothesis"},"type":"array","maxItems":25,"title":"Contextual Relevance Hypotheses"},"workshop_rules":{"anyOf":[{"$ref":"#/components/schemas/WorkforceWorkshopRules"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["country_code","region","decision","occupations"],"title":"WorkforceEvidencePackCreateRequest"},"WorkforceEvidencePackDocumentResponse":{"properties":{"artifact_type":{"type":"string","const":"avelin.workforce_investment_evidence_pack","title":"Artifact Type"},"schema_version":{"type":"string","enum":["1.0","1.1"],"title":"Schema Version"},"evidence_pack_id":{"type":"string","pattern":"^wep_[0-9a-f]{32}$","title":"Evidence Pack Id"},"status":{"type":"string","const":"buyer_review_ready","title":"Status"},"country_code":{"type":"string","const":"US","title":"Country Code"},"region":{"$ref":"#/components/schemas/WorkforceEvidencePackRegion"},"decision":{"type":"string","const":"workforce_investment","title":"Decision"},"decision_question":{"type":"string","title":"Decision Question"},"recommended_next_decision":{"type":"string","title":"Recommended Next Decision"},"decision_summary":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Decision Summary"},"decision_readiness":{"type":"string","const":"not_ready","title":"Decision Readiness"},"language":{"type":"string","const":"en","title":"Language"},"created_at":{"type":"string","title":"Created At"},"request":{"additionalProperties":true,"type":"object","title":"Request"},"occupation_taxonomy":{"additionalProperties":true,"type":"object","title":"Occupation Taxonomy"},"source_lineage":{"items":{"$ref":"#/components/schemas/WorkforceSourceLineage"},"type":"array","title":"Source Lineage"},"source_interpretation":{"anyOf":[{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},{"type":"null"}],"title":"Source Interpretation"},"geography_disclosure":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Geography Disclosure"},"evidence":{"additionalProperties":true,"type":"object","title":"Evidence"},"employer_validation":{"additionalProperties":true,"type":"object","title":"Employer Validation"},"evidence_boundaries":{"items":{"type":"string"},"type":"array","title":"Evidence Boundaries"},"limitations":{"items":{"type":"string"},"type":"array","title":"Limitations"}},"additionalProperties":false,"type":"object","required":["artifact_type","schema_version","evidence_pack_id","status","country_code","region","decision","decision_question","recommended_next_decision","decision_readiness","language","created_at","request","occupation_taxonomy","source_lineage","evidence","employer_validation","evidence_boundaries","limitations"],"title":"WorkforceEvidencePackDocumentResponse"},"WorkforceEvidencePackRegion":{"properties":{"type":{"type":"string","const":"state","title":"Type"},"code":{"type":"string","title":"Code"},"name":{"type":"string","title":"Name"},"state_fips":{"type":"string","title":"State Fips"}},"additionalProperties":false,"type":"object","required":["type","code","name","state_fips"],"title":"WorkforceEvidencePackRegion"},"WorkforceEvidencePackRegionRequest":{"properties":{"type":{"type":"string","const":"state","title":"Type"},"code":{"type":"string","pattern":"^[A-Za-z]{2}$","title":"Code"}},"additionalProperties":false,"type":"object","required":["type","code"],"title":"WorkforceEvidencePackRegionRequest"},"WorkforceEvidencePackResourceResponse":{"properties":{"evidence_pack_id":{"type":"string","pattern":"^wep_[0-9a-f]{32}$","title":"Evidence Pack Id"},"status":{"type":"string","const":"buyer_review_ready","title":"Status"},"cache_status":{"type":"string","enum":["created","reused"],"title":"Cache Status"},"country_code":{"type":"string","const":"US","title":"Country Code"},"region":{"$ref":"#/components/schemas/WorkforceEvidencePackRegion"},"decision":{"type":"string","const":"workforce_investment","title":"Decision"},"decision_readiness":{"type":"string","const":"not_ready","title":"Decision Readiness"},"formats":{"items":{"type":"string","enum":["json","html"]},"type":"array","title":"Formats"},"created_at":{"type":"string","title":"Created At"},"source_lineage":{"items":{"$ref":"#/components/schemas/WorkforceSourceLineage"},"type":"array","title":"Source Lineage"}},"additionalProperties":false,"type":"object","required":["evidence_pack_id","status","cache_status","country_code","region","decision","decision_readiness","formats","created_at","source_lineage"],"title":"WorkforceEvidencePackResourceResponse"},"WorkforceFeatureCapabilities":{"properties":{"occupation_catalog":{"type":"string","const":"available","title":"Occupation Catalog"},"evidence_pack_creation":{"type":"string","enum":["available","not_available"],"title":"Evidence Pack Creation"}},"type":"object","required":["occupation_catalog","evidence_pack_creation"],"title":"WorkforceFeatureCapabilities"},"WorkforceGeographyCapability":{"properties":{"type":{"type":"string","const":"state","title":"Type"},"code_system":{"type":"string","const":"USPS","title":"Code System"},"supported":{"type":"boolean","const":true,"title":"Supported"}},"type":"object","required":["type","code_system","supported"],"title":"WorkforceGeographyCapability"},"WorkforceOccupationDetailResponse":{"properties":{"code":{"type":"string","pattern":"^[0-9]{2}-[0-9]{4}$","title":"Code"},"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"},"onet_codes":{"items":{"type":"string"},"type":"array","title":"Onet Codes"},"evidence_available":{"$ref":"#/components/schemas/WorkforceOccupationEvidenceAvailability"},"taxonomy":{"type":"string","const":"SOC","title":"Taxonomy"},"taxonomy_vintage":{"type":"string","const":"2018","title":"Taxonomy Vintage"},"country_code":{"type":"string","const":"US","title":"Country Code"},"reference_release":{"type":"string","const":"O*NET 30.3","title":"Reference Release"},"skills":{"items":{"$ref":"#/components/schemas/WorkforceOccupationSkill"},"type":"array","title":"Skills"},"tasks":{"items":{"type":"string"},"type":"array","title":"Tasks"}},"additionalProperties":false,"type":"object","required":["code","title","description","onet_codes","evidence_available","taxonomy","taxonomy_vintage","country_code","reference_release","skills","tasks"],"title":"WorkforceOccupationDetailResponse"},"WorkforceOccupationEvidenceAvailability":{"properties":{"tasks":{"type":"boolean","title":"Tasks"},"skills":{"type":"boolean","title":"Skills"},"employment":{"type":"boolean","title":"Employment"},"wages":{"type":"boolean","title":"Wages"}},"type":"object","required":["tasks","skills","employment","wages"],"title":"WorkforceOccupationEvidenceAvailability"},"WorkforceOccupationItem":{"properties":{"code":{"type":"string","pattern":"^[0-9]{2}-[0-9]{4}$","title":"Code"},"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"},"onet_codes":{"items":{"type":"string"},"type":"array","title":"Onet Codes"},"evidence_available":{"$ref":"#/components/schemas/WorkforceOccupationEvidenceAvailability"}},"type":"object","required":["code","title","description","onet_codes","evidence_available"],"title":"WorkforceOccupationItem"},"WorkforceOccupationListResponse":{"properties":{"taxonomy":{"type":"string","const":"SOC","title":"Taxonomy"},"taxonomy_vintage":{"type":"string","const":"2018","title":"Taxonomy Vintage"},"country_code":{"type":"string","const":"US","title":"Country Code"},"reference_release":{"type":"string","const":"O*NET 30.3","title":"Reference Release"},"items":{"items":{"$ref":"#/components/schemas/WorkforceOccupationItem"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"additionalProperties":false,"type":"object","required":["taxonomy","taxonomy_vintage","country_code","reference_release","items"],"title":"WorkforceOccupationListResponse"},"WorkforceOccupationSkill":{"properties":{"name":{"type":"string","title":"Name"},"importance":{"type":"number","title":"Importance"},"level":{"type":"number","title":"Level"}},"type":"object","required":["name","importance","level"],"title":"WorkforceOccupationSkill"},"WorkforceOccupationTaxonomyCapability":{"properties":{"name":{"type":"string","const":"SOC","title":"Name"},"vintage":{"type":"string","const":"2018","title":"Vintage"},"reference_release":{"type":"string","const":"O*NET 30.3","title":"Reference Release"},"official_reference_url":{"type":"string","title":"Official Reference Url"}},"type":"object","required":["name","vintage","reference_release","official_reference_url"],"title":"WorkforceOccupationTaxonomyCapability"},"WorkforceSourceLineage":{"properties":{"source_id":{"type":"string","title":"Source Id"},"artifact_type":{"type":"string","title":"Artifact Type"},"retrieved_at":{"type":"string","title":"Retrieved At"},"row_count":{"type":"integer","title":"Row Count"},"raw_sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","title":"Raw Sha256"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider"},"evidence_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evidence Role"},"api_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Version"},"reference_release":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Release"},"schema_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Schema Reference"},"schema_sha256":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{64}$"},{"type":"null"}],"title":"Schema Sha256"},"normalized_content_sha256":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{64}$"},{"type":"null"}],"title":"Normalized Content Sha256"},"request_scope":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Request Scope"}},"additionalProperties":false,"type":"object","required":["source_id","artifact_type","retrieved_at","row_count","raw_sha256"],"title":"WorkforceSourceLineage"},"WorkforceWorkshopRules":{"properties":{"decision_rule":{"anyOf":[{"type":"string","maxLength":1000,"minLength":1},{"type":"null"}],"title":"Decision Rule"},"minimum_validation_requirement":{"anyOf":[{"type":"string","maxLength":1000,"minLength":1},{"type":"null"}],"title":"Minimum Validation Requirement"}},"additionalProperties":false,"type":"object","title":"WorkforceWorkshopRules"}},"securitySchemes":{"RuntimeApiKey":{"type":"http","scheme":"bearer","bearerFormat":"runtime API key","description":"Use a customer runtime API key created via the platform API key management endpoints. Platform login bearer tokens are not accepted on runtime endpoints."},"ManagementBearerToken":{"type":"http","scheme":"bearer","bearerFormat":"management bearer token","description":"Use the management bearer token returned by POST /api/v1/platform/login for account, contract, usage, and API-key management operations. This token is not accepted on runtime product endpoints."}}}}