Recipes

Apply to a job

Start a workflow run that applies to a job with a résumé and optional credentials.

post/v1/recipes/jobs/apply

Request body

job_urlstring uri required
custom_promptstring required
resume_urlstring uri required
{"stackTrail":"paths:/v1/recipes/jobs/apply:post:requestBody:content:application/json:schema:properties:other_information","oasType":"schema","type":"unknown","title":"Other Information"}
terminate_criterionstring nullable

Condition that stops Apply. Omit to use the recipe default; null or empty text disables it.

error_code_mappingobject nullable

Error codes and descriptions. Omit for the recipe default; null or {} disables mapping. A supplied mapping replaces the default independently of terminate_criterion.

usernamestring nullable
passwordstring nullable
persist_credentialsboolean nullable
2fa_identifierstring nullable

Response

Successfully started job application

workflow_run_idstring required

Changes

Changed in 3 of the 101 revisions of this API.8

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: multipart/form-data)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: multipart/form-data)

      new-optional-request-property

    • ○

      the endpoint scheme security ApiKeyAuth was added to the API

      api-security-added

    • ○

      api tag Recipes added

      api-tag-added

    • ○

      api tag Runs removed

      api-tag-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      endpoint added

      endpoint-added