Alfa

Job setup

Write a job advert

POST/v1/job-setup/generate-description

Grounds the advert on the recruiter's current draft and the job's fields when they are sent.

Requires the session token of a signed-in Alfa user as a bearer token.

Request body

  • jobTitlestringrequired

    at least 1 characters

  • languageCodestring
  • descriptionstring
  • jobDataobject

    The job fields the advert describes

Responses

  • 200Success.
  • 400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
  • 401The bearer token is missing, expired or invalid. Problem details
  • 403The caller may not perform this operation, or has no active organisation. Problem details
  • 404The resource does not exist or is not visible to the caller. Problem details
  • 422The request failed validation; `errors` lists each invalid field. Problem details
  • 429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
  • 500An unexpected error. Quote the `correlationId` to support. Problem details