API reference
API reference

candidates

  • GET/v1/candidates

    List candidates in your tenant.

    Standard JSON response. Authenticated with an API key scoped to your tenant. Rate limits and pagination apply.

    Example
    curl -H "Authorization: Bearer $JINZAI_API_KEY" "https://api.jinzai.dev/v1/candidates"
  • POST/v1/candidates

    Create a candidate.

    Standard JSON response. Authenticated with an API key scoped to your tenant. Rate limits and pagination apply.

    Example
    curl -H "Authorization: Bearer $JINZAI_API_KEY" "https://api.jinzai.dev/v1/candidates"
  • GET/v1/candidates/{id}

    Fetch a candidate with intelligence.

    Standard JSON response. Authenticated with an API key scoped to your tenant. Rate limits and pagination apply.

    Example
    curl -H "Authorization: Bearer $JINZAI_API_KEY" "https://api.jinzai.dev/v1/candidates/{id}"
  • PATCH/v1/candidates/{id}

    Update candidate fields.

    Standard JSON response. Authenticated with an API key scoped to your tenant. Rate limits and pagination apply.

    Example
    curl -H "Authorization: Bearer $JINZAI_API_KEY" "https://api.jinzai.dev/v1/candidates/{id}"
  • POST/v1/candidates/{id}/enrich

    Queue re-parsing and re-enrichment.

    Standard JSON response. Authenticated with an API key scoped to your tenant. Rate limits and pagination apply.

    Example
    curl -H "Authorization: Bearer $JINZAI_API_KEY" "https://api.jinzai.dev/v1/candidates/{id}/enrich"
  • GET/v1/candidates/{id}/similar

    Get candidates similar to this one.

    Standard JSON response. Authenticated with an API key scoped to your tenant. Rate limits and pagination apply.

    Example
    curl -H "Authorization: Bearer $JINZAI_API_KEY" "https://api.jinzai.dev/v1/candidates/{id}/similar"