Skip to content

Skyvern: Extract a job application posting

Skyvern recipes.extractJobApplication: arguments, response, policy and SDK examples.

← Recipes operations · Get started

Operation skyvern.extract_job_application_v1_recipes_jobs_extract_post

Provider route: POST /v1/recipes/jobs/extract. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";
async function execute(input: Parameters<SkyvernIntegration["recipes"]["extractJobApplication"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.recipes.extractJobApplication(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.recipes.extract_job_application(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectRequired within parentAdditional keys: not allowed
body.job_urlstringRequired within parentFormat: uri
body.proxy_locationJSONOptionalGeographic 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:8080”&#125;. 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.
body.proxy_location (anyOf 1)stringAlternativeOne of: 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
body.proxy_location (anyOf 2)ModelAlternativeExpand Update an agent — response body — proxy location city, country, is ISP, subdivision
body.proxy_location (anyOf 3)objectAlternativeAdditional keys: allowed
body.proxy_location (anyOf 4)nullAlternative
body.webhook_urlJSONOptionalAfter a run is finished, send an update to this URL. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for more details.
Format: uri
body.webhook_url (anyOf 1)stringAlternative
body.webhook_url (anyOf 2)nullAlternative

Referenced models: Update an agent — response body — proxy location city, country, is ISP, subdivision

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Apply to a job — response body

Referenced models: Apply to a job — response body

Update an agent — response body — proxy location city, country, is ISP, subdivision
FieldTypePresenceDescription and constraints
$objectRootGranular proxy geo-targeting request with country, optional subdivision, and optional city.
cityJSONOptionalCity name in English from GeoNames (e.g., 'New York', 'Los Angeles', 'London')
city (anyOf 1)stringAlternativeMaximum length: 100
city (anyOf 2)nullAlternative
countrystringRequired within parentISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'DE')
Maximum length: 2
Minimum length: 2
isISPbooleanOptionalWhether this geo target is marked as an ISP proxy location.
Default: false
subdivisionJSONOptionalISO 3166-2 subdivision code without country prefix (e.g., 'CA' for California, 'NY' for New York)
subdivision (anyOf 1)stringAlternativeMaximum length: 10
subdivision (anyOf 2)nullAlternative
Apply to a job — response body
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
workflow_run_idstringRequired within parentPattern: ^wr_

SDK function policy ID: skyvern.extract_job_application_v1_recipes_jobs_extract_post. Catalog operation: extract_job_application_v1_recipes_jobs_extract_post. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.