SKskyvern-ai
Recipes

Apply to a job

Changed on

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

post/v1/recipes/jobs/apply

Request

  • Base URL
    https://api.skyvern.com
  • URL
    https://api.skyvern.com/v1/recipes/jobs/apply
  • Auth
    API key in header x-api-key

Request body

job_urlstring uri required
custom_promptstring required
resume_urlstring uri required
other_informationunknown
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

  • 89fc67079375Revision changes
    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: multipart/form-data)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: multipart/form-data)

  • 7b0a0c6ac6c7Revision changes
    • info

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

    • info

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

    • info

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

    • info

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