Skyvern: Apply to a job

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

Operation skyvern.apply_to_job_v1_recipes_jobs_apply_post

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

Call through Alter

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"]["applyToJob"]>[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.applyToJob(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.apply_to_job(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`body`	object	Required within parent	OpenAPI representation of the text and file parts accepted by Apply. Additional keys: not allowed
`body.2fa_identifier`	JSON	Optional
`body.2fa_identifier (anyOf 1)`	string	Alternative
`body.2fa_identifier (anyOf 2)`	null	Alternative
`body.custom_prompt`	string	Required within parent
`body.error_code_mapping`	JSON	Optional	JSON text containing an object of error codes and descriptions. Omit for the recipe default; JSON null or {} disables mapping. A supplied mapping replaces the default independently of terminate_criterion. Default: {“job_expired”: “The requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications.”}
`body.error_code_mapping (anyOf 1)`	string	Alternative
`body.error_code_mapping (anyOf 2)`	null	Alternative
`body.job_url`	string	Required within parent	Format: uri
`body.other_information`	JSON	Optional
`body.other_information (anyOf 1)`	string	Alternative
`body.other_information (anyOf 2)`	null	Alternative
`body.password`	JSON	Optional
`body.password (anyOf 1)`	string	Alternative
`body.password (anyOf 2)`	null	Alternative
`body.persist_credentials`	JSON	Optional
`body.persist_credentials (anyOf 1)`	string	Alternative	Pattern: ^true$
`body.persist_credentials (anyOf 2)`	null	Alternative
`body.proxy_location`	JSON	Optional	A ProxyLocation name such as RESIDENTIAL_GB, or JSON text for a GeoTarget or custom proxy object. Omit it or send blank text to use the default; Skyvern Cloud then uses RESIDENTIAL.
`body.proxy_location (anyOf 1)`	string	Alternative
`body.proxy_location (anyOf 2)`	null	Alternative
`body.resume_file`	object	Required within parent	Additional keys: not allowed
`body.resume_file.filename`	string	Required within parent	Minimum length: 1
`body.resume_file.content_type`	string	Required within parent	Minimum length: 1
`body.resume_file.content_base64`	string	Required within parent
`body.terminate_criterion`	JSON	Optional	Condition that stops Apply. Omit for the recipe default; empty text disables it. Default: Terminate when the requested job posting explicitly states that it is expired, closed, filled, or no longer accepting applications. A missing Apply button or redirect alone is insufficient.
`body.terminate_criterion (anyOf 1)`	string	Alternative
`body.terminate_criterion (anyOf 2)`	null	Alternative
`body.username`	JSON	Optional
`body.username (anyOf 1)`	string	Alternative	Minimum length: 1
`body.username (anyOf 2)`	null	Alternative
`body.webhook_url`	JSON	Optional	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. Format: uri
`body.webhook_url (anyOf 1)`	string	Alternative
`body.webhook_url (anyOf 2)`	null	Alternative

Response

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

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Apply to a job — response body

Referenced models: Apply to a job — response body

Schemas

Apply to a job — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`workflow_run_id`	string	Required within parent	Pattern: ^wr_

Policy, approvals and errors

SDK function policy ID: skyvern.apply_to_job_v1_recipes_jobs_apply_post. Catalog operation: apply_to_job_v1_recipes_jobs_apply_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