Skip to content
AvelinLabs

AvelinLabs API Examples

Complete executable examples are maintained in the official AvelinLabs API examples repository.

These pages provide short explanations and links to public example resources. Full runnable scripts, payload libraries, sample response files, Postman assets, and integration templates are maintained in the examples repository.

If you are using examples to test fit in a product workflow, follow Evaluate AvelinLabs in your workflow alongside the sample payloads and responses.

For practical strong, weak, ambiguous, vague, and noisy input comparisons, see Input quality examples.

The examples are designed to show AvelinLabs as the workforce intelligence layer for AI-native hiring systems: structured occupation alignment, skill evidence, confidence and uncertainty signals, weak-signal analysis, ambiguity detection, review routing, and market context where available. They are not job-board examples, raw job-data feeds, ATS workflows, recruiting-agency playbooks, or generic AI prompts.

During beta, onboarding is API-first: register through the Platform API, verify your email, create a runtime API key, and use that key on product endpoints.

Example Categories

Section titled “Example Categories”

Current and planned public beta examples may cover:

  • platform onboarding
  • runtime API key usage
  • job analysis
  • job classification
  • occupation intelligence
  • occupation alignment
  • skill evidence
  • confidence, uncertainty, and review-routing signals
  • weak-signal and ambiguity handling
  • labor market intelligence
  • market context where available
  • runtime authentication patterns
  • API error handling
  • readiness checks

Current Public Example Files

Section titled “Current Public Example Files”

How to Read AvelinLabs Output

Section titled “How to Read AvelinLabs Output”

confidence

Section titled “confidence”
  • Meaning: Overall confidence signal for the top result.
  • Use it for: Routing and review, not as absolute truth.

trust_score

Section titled “trust_score”
  • Meaning: Trust-oriented score combining result strength and quality support.
  • Use it for: Deciding whether the selected output has enough evidence behind it.

uncertainty.total

Section titled “uncertainty.total”
  • Meaning: Combined uncertainty signal.
  • Use it for: Identifying inputs or matches that may need review.

decision.decision

Section titled “decision.decision”
  • Meaning: Routing label such as AUTO_ACCEPT, REVIEW, REJECT, or AMBIGUOUS.
  • Use it for: Deciding whether to display, review, reject, or request more input.

job_signals

Section titled “job_signals”
  • Meaning: Skill, tool, task, or domain signals detected from the input.
  • Use it for: Seeing what evidence the analysis used.

results[].onet_code

Section titled “results[].onet_code”
  • Meaning: Standard O*NET occupation code for a ranked candidate.
  • Use it for: Storing, comparing, or enriching the occupation consistently.

matching_skills

Section titled “matching_skills”
  • Meaning: Skills or capabilities supporting the selected match.
  • Use it for: Helping reviewers and client-facing teams explain why the result is relevant.

explanation.why_match

Section titled “explanation.why_match”
  • Meaning: Plain-English explanation for the candidate match.
  • Use it for: Reviewing and presenting the output in context.

For a fuller field-by-field walkthrough, read docs/annotated-job-analyze-response.md.

For practical field-by-field usage guidance in the public docs, see the Response Field Reference.

For practical batch and workflow measurements, see Metrics you can derive from AvelinLabs responses.

Beta Guidance

Section titled “Beta Guidance”

Some examples may be planned or upcoming while the beta evolves. Public docs should link only to files that exist. Until a specific example file is available, use the repository root:

https://github.com/AvelinLabs/avelinlabs-api-examples

Contract Rule

Section titled “Contract Rule”

Examples should not invent fields, endpoints, or response shapes. If an API area is early-stage or subject to change, the example should say so directly.

Section titled “Related Guides”