Apply to a job

curl --request POST \
  --url https://api.skyvern.com/v1/recipes/jobs/apply \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "job_url": "<string>",
  "custom_prompt": "<string>",
  "resume_url": "<string>",
  "webhook_url": "https://my-site.com/webhook",
  "other_information": "<unknown>",
  "terminate_criterion": "Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.",
  "error_code_mapping": {
    "job_expired": "The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications."
  },
  "username": "<string>",
  "password": "<string>",
  "persist_credentials": true,
  "2fa_identifier": "<string>"
}
'

import requests

url = "https://api.skyvern.com/v1/recipes/jobs/apply"

payload = {
    "job_url": "<string>",
    "custom_prompt": "<string>",
    "resume_url": "<string>",
    "webhook_url": "https://my-site.com/webhook",
    "other_information": "<unknown>",
    "terminate_criterion": "Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.",
    "error_code_mapping": { "job_expired": "The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications." },
    "username": "<string>",
    "password": "<string>",
    "persist_credentials": True,
    "2fa_identifier": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    job_url: '<string>',
    custom_prompt: '<string>',
    resume_url: '<string>',
    webhook_url: 'https://my-site.com/webhook',
    other_information: '<unknown>',
    terminate_criterion: 'Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.',
    error_code_mapping: {
      job_expired: 'The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.'
    },
    username: '<string>',
    password: '<string>',
    persist_credentials: true,
    '2fa_identifier': '<string>'
  })
};

fetch('https://api.skyvern.com/v1/recipes/jobs/apply', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.skyvern.com/v1/recipes/jobs/apply",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'job_url' => '<string>',
    'custom_prompt' => '<string>',
    'resume_url' => '<string>',
    'webhook_url' => 'https://my-site.com/webhook',
    'other_information' => '<unknown>',
    'terminate_criterion' => 'Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.',
    'error_code_mapping' => [
        'job_expired' => 'The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.'
    ],
    'username' => '<string>',
    'password' => '<string>',
    'persist_credentials' => true,
    '2fa_identifier' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.skyvern.com/v1/recipes/jobs/apply"

	payload := strings.NewReader("{\n  \"job_url\": \"<string>\",\n  \"custom_prompt\": \"<string>\",\n  \"resume_url\": \"<string>\",\n  \"webhook_url\": \"https://my-site.com/webhook\",\n  \"other_information\": \"<unknown>\",\n  \"terminate_criterion\": \"Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.\",\n  \"error_code_mapping\": {\n    \"job_expired\": \"The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.\"\n  },\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"persist_credentials\": true,\n  \"2fa_identifier\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.skyvern.com/v1/recipes/jobs/apply")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"job_url\": \"<string>\",\n  \"custom_prompt\": \"<string>\",\n  \"resume_url\": \"<string>\",\n  \"webhook_url\": \"https://my-site.com/webhook\",\n  \"other_information\": \"<unknown>\",\n  \"terminate_criterion\": \"Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.\",\n  \"error_code_mapping\": {\n    \"job_expired\": \"The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.\"\n  },\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"persist_credentials\": true,\n  \"2fa_identifier\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skyvern.com/v1/recipes/jobs/apply")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"job_url\": \"<string>\",\n  \"custom_prompt\": \"<string>\",\n  \"resume_url\": \"<string>\",\n  \"webhook_url\": \"https://my-site.com/webhook\",\n  \"other_information\": \"<unknown>\",\n  \"terminate_criterion\": \"Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.\",\n  \"error_code_mapping\": {\n    \"job_expired\": \"The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.\"\n  },\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"persist_credentials\": true,\n  \"2fa_identifier\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "workflow_run_id": "<string>"
}

POST

recipes

jobs

apply

Apply to a job

curl --request POST \
  --url https://api.skyvern.com/v1/recipes/jobs/apply \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "job_url": "<string>",
  "custom_prompt": "<string>",
  "resume_url": "<string>",
  "webhook_url": "https://my-site.com/webhook",
  "other_information": "<unknown>",
  "terminate_criterion": "Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.",
  "error_code_mapping": {
    "job_expired": "The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications."
  },
  "username": "<string>",
  "password": "<string>",
  "persist_credentials": true,
  "2fa_identifier": "<string>"
}
'

import requests

url = "https://api.skyvern.com/v1/recipes/jobs/apply"

payload = {
    "job_url": "<string>",
    "custom_prompt": "<string>",
    "resume_url": "<string>",
    "webhook_url": "https://my-site.com/webhook",
    "other_information": "<unknown>",
    "terminate_criterion": "Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.",
    "error_code_mapping": { "job_expired": "The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications." },
    "username": "<string>",
    "password": "<string>",
    "persist_credentials": True,
    "2fa_identifier": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    job_url: '<string>',
    custom_prompt: '<string>',
    resume_url: '<string>',
    webhook_url: 'https://my-site.com/webhook',
    other_information: '<unknown>',
    terminate_criterion: 'Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.',
    error_code_mapping: {
      job_expired: 'The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.'
    },
    username: '<string>',
    password: '<string>',
    persist_credentials: true,
    '2fa_identifier': '<string>'
  })
};

fetch('https://api.skyvern.com/v1/recipes/jobs/apply', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.skyvern.com/v1/recipes/jobs/apply",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'job_url' => '<string>',
    'custom_prompt' => '<string>',
    'resume_url' => '<string>',
    'webhook_url' => 'https://my-site.com/webhook',
    'other_information' => '<unknown>',
    'terminate_criterion' => 'Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.',
    'error_code_mapping' => [
        'job_expired' => 'The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.'
    ],
    'username' => '<string>',
    'password' => '<string>',
    'persist_credentials' => true,
    '2fa_identifier' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.skyvern.com/v1/recipes/jobs/apply"

	payload := strings.NewReader("{\n  \"job_url\": \"<string>\",\n  \"custom_prompt\": \"<string>\",\n  \"resume_url\": \"<string>\",\n  \"webhook_url\": \"https://my-site.com/webhook\",\n  \"other_information\": \"<unknown>\",\n  \"terminate_criterion\": \"Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.\",\n  \"error_code_mapping\": {\n    \"job_expired\": \"The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.\"\n  },\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"persist_credentials\": true,\n  \"2fa_identifier\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.skyvern.com/v1/recipes/jobs/apply")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"job_url\": \"<string>\",\n  \"custom_prompt\": \"<string>\",\n  \"resume_url\": \"<string>\",\n  \"webhook_url\": \"https://my-site.com/webhook\",\n  \"other_information\": \"<unknown>\",\n  \"terminate_criterion\": \"Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.\",\n  \"error_code_mapping\": {\n    \"job_expired\": \"The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.\"\n  },\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"persist_credentials\": true,\n  \"2fa_identifier\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skyvern.com/v1/recipes/jobs/apply")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"job_url\": \"<string>\",\n  \"custom_prompt\": \"<string>\",\n  \"resume_url\": \"<string>\",\n  \"webhook_url\": \"https://my-site.com/webhook\",\n  \"other_information\": \"<unknown>\",\n  \"terminate_criterion\": \"Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.\",\n  \"error_code_mapping\": {\n    \"job_expired\": \"The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.\"\n  },\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"persist_credentials\": true,\n  \"2fa_identifier\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "workflow_run_id": "<string>"
}

Authorizations

x-api-key

string

header

required

Your Skyvern API key from https://app.skyvern.com/settings.

Body

job_url

string<uri>

required

custom_prompt

string

required

resume_url

string<uri>

required

webhook_url

string<uri>

After a run is finished, send an update to this URL. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for more details.

Example:

"https://my-site.com/webhook"

proxy_location

Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.

Available geotargeting options:

RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.
RESIDENTIAL_ES: Spain
RESIDENTIAL_IE: Ireland
RESIDENTIAL_GB: United Kingdom
RESIDENTIAL_IN: India
RESIDENTIAL_JP: Japan
RESIDENTIAL_FR: France
RESIDENTIAL_DE: Germany
RESIDENTIAL_NZ: New Zealand
RESIDENTIAL_PH: Philippines
RESIDENTIAL_KR: South Korea
RESIDENTIAL_SA: Saudi Arabia
RESIDENTIAL_ZA: South Africa
RESIDENTIAL_AR: Argentina
RESIDENTIAL_AU: Australia
RESIDENTIAL_BR: Brazil
RESIDENTIAL_TR: Turkey
RESIDENTIAL_CA: Canada
RESIDENTIAL_MX: Mexico
RESIDENTIAL_IT: Italy
RESIDENTIAL_NL: Netherlands
RESIDENTIAL_ISP: ISP proxy
US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
NONE: No proxy

For self-hosted deployments, you can pass a custom proxy URL as a dict: {"url": "http://user:password@proxy.example.com:8080"} [blocked]. This routes the browser through your own proxy server and takes precedence over any globally configured proxy pool. Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}. Omit it or send null to use the default; Skyvern Cloud then uses RESIDENTIAL.

Available options:

RESIDENTIAL,

US-CA,

US-NY,

US-TX,

US-FL,

US-WA,

RESIDENTIAL_ES,

RESIDENTIAL_IE,

RESIDENTIAL_GB,

RESIDENTIAL_IN,

RESIDENTIAL_JP,

RESIDENTIAL_FR,

RESIDENTIAL_DE,

RESIDENTIAL_NZ,

RESIDENTIAL_ZA,

RESIDENTIAL_AR,

RESIDENTIAL_AU,

RESIDENTIAL_BR,

RESIDENTIAL_TR,

RESIDENTIAL_CA,

RESIDENTIAL_MX,

RESIDENTIAL_IT,

RESIDENTIAL_NL,

RESIDENTIAL_PH,

RESIDENTIAL_KR,

RESIDENTIAL_SA,

RESIDENTIAL_ISP,

NONE

other_information

any

terminate_criterion

string | null

default:Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button, redirect, or HTTP 404 alone is insufficient.

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

error_code_mapping

Error Code Mapping · object | null

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

Show child attributes

username

string | null

Minimum string length: 1

password

string | null

persist_credentials

boolean | null

2fa_identifier

string | null

Response

Successfully started job application

workflow_run_id

string

required

Pattern: ^wr_

Agents

Runs

Folders

Server

Artifacts

Files

Browser Profiles

Browser Sessions

Credentials

Schedules

Recipes

Apply to a job

Authorizations

Body

Response