ProfileClaw

API guide

Similar Paths API

Similar Paths API returns similar-path samples and matching factors.

Path: /api/v1/similar-paths
Format: AI-first docs
Info

Contract-backed page

This page is generated from the current OpenAPI contract summary so docs stay aligned with the formal API surface.

GET /api/v1/similar-paths

Find similar anonymized career paths

Returns anonymized career paths that are similar to the authenticated user's profile.

Required scopes

  • read:similar_paths

Request

  • targetRole (query): Filter for transitions relevant to a target role
  • minSimilarity (query): Minimum similarity score (0-1)
  • limit (query): Maximum number of results

Responses

  • 200: OK
  • 400: Bad request
  • 401:
  • 403:
  • 404:
  • 429:
  • 500:

Errors

  • similar_paths.invalid_min_similarity
  • similar_paths.invalid_limit

Examples

Code sample (curl)
1curl "https://api.profileclaw.com/api/v1/similar-paths?targetRole=Product%20Manager&minSimilarity=0.6&limit=5" -H "Authorization: Bearer $PROFILECLAW_API_KEY"

Related surfaces

Use these surfaces when you need deeper inspection or automation.

Open Reference
Open OpenAPI