Skip to content

Automate browser based workflows with AI

SKY-16064: Fix Recipes docs navigation, API-key auth, and cookbook (#8517)

Shuchang Zhengd0c84407fb4b
diff --git a/docs/api-reference/openapi.json b/docs/api-reference/openapi.json
index d4545f83b..46bbda3b0 100644
--- a/docs/api-reference/openapi.json
+++ b/docs/api-reference/openapi.json
@@ -7693,7 +7693,7 @@
"/v1/recipes/jobs/extract": {
"post": {
"tags": [
- "Runs"
+ "Recipes"
],
"summary": "Extract a job application posting",
"description": "Start a workflow run that extracts structured details from a job posting.",
@@ -7747,13 +7747,18 @@
"description": "Workflow launch failed"
}
},
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
"x-fern-sdk-method-name": "extract_job_application"
}
},
"/v1/recipes/jobs/apply": {
"post": {
"tags": [
- "Runs"
+ "Recipes"
],
"summary": "Apply to a job",
"description": "Start a workflow run that applies to a job with a résumé and optional credentials.",
@@ -7961,17 +7966,27 @@
"description": "Credential service failed"
}
},
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
"x-fern-sdk-method-name": "apply_to_job"
}
},
"/v1/recipes/jobs/runs": {
"get": {
"tags": [
- "Runs"
+ "Recipes"
],
"summary": "List job recipe runs",
"description": "List workflow runs started by job recipe requests.",
"operationId": "list_job_recipe_runs_v1_recipes_jobs_runs_get",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
"parameters": [
{
"name": "page",
@@ -32123,6 +32138,14 @@
],
"title": "CredentialType"
}
+ },
+ "securitySchemes": {
+ "ApiKeyAuth": {
+ "type": "apiKey",
+ "description": "Your Skyvern API key from https://app.skyvern.com/settings.",
+ "in": "header",
+ "name": "x-api-key"
+ }
}
},
"servers": [
diff --git a/docs/cookbooks/job-application-filler.mdx b/docs/cookbooks/job-application-filler.mdx
index bfedf6a91..c248c4df9 100644
--- a/docs/cookbooks/job-application-filler.mdx
+++ b/docs/cookbooks/job-application-filler.mdx
@@ -1,1161 +1,201 @@
---
-title: Job Applications Pipeline
-subtitle: Search for jobs and automatically apply using your resume
-description: Build an agent that parses your resume, searches job portals, extracts listings, generates tailored answers with AI, and submits applications automatically.
+title: Job Application Recipes
+subtitle: Extract job details and apply with your resume
+description: Use Skyvern job recipes in the dashboard or API to extract a job posting, submit an application with a resume, and track each run.
slug: cookbooks/job-application-filler
keywords:
- job application
+ - recipes
- resume
- - cover letter
- - job search
+ - job extraction
- auto-apply
- form filling
- - AI-generated answers
---
-Automate job applications across multiple postings on any job portal.
+Use **Job Application Recipes** to extract details from a job posting or apply with your resume. Each request starts a workflow run that you can track in Skyvern.
-This cookbook creates an agent that logs into a job portal, searches for relevant positions based on your resume, extracts job listings, and applies to each one with AI-generated responses tailored to the role.
+You can use the [recipe page](https://app.skyvern.com/recipes/job-apps) or the API. Supply a direct job posting URL for each request.
----
-
-## What you'll build
+<Note>
+ Apply can submit an application on your behalf. Check the job URL, resume, and instructions before you start a run.
+</Note>
-An agent that:
+## Apply from the dashboard
-1. Parses your resume PDF to extract structured information
-2. Logs into a job portal using saved credentials
-3. Searches for relevant jobs based on your resume
-4. Extracts a list of matching job postings
-5. For each job: extracts details, generates tailored answers, and submits the application
+<Steps>
+ <Step title="Open Job Application Recipes">
+ Go to **Recipes → Job Applications** in [Skyvern Cloud](https://app.skyvern.com/recipes/job-apps).
+ </Step>
+ <Step title="Add the job and resume">
+ Paste the **Job URL**. Upload one PDF resume, up to 10 MiB, or select **Use a URL instead** to provide a publicly accessible resume URL.
+ </Step>
+ <Step title="Add instructions and facts">
+ Use **Instructions** to describe how Skyvern should complete the application. Use **Your information** for facts such as work authorization, location, or expected salary. Both fields are optional.
----
+ Skyvern parses your resume to help answer application questions. Values in **Your information** override matching values from the resume. You can enter text or JSON.
+ </Step>
+ <Step title="Add login details if needed">
+ Select **This job site requires a login** to enter a username and password. When you provide credentials, select **Save this login for future applications on this site** to allow Skyvern to store them.
-## Prerequisites
+ If the site uses two-factor authentication, enable **Uses 2FA?** and supply your configured 2FA identifier when needed.
+ </Step>
+ <Step title="Start and track the application">
+ Submit the form, then open the returned run link. The **Runs** panel lists applications and job extractions with their status.
+ </Step>
+</Steps>
-- **Skyvern Cloud API key**: Get one at [app.skyvern.com/settings](https://app.skyvern.com/settings) → API Keys
+To apply to several postings, enable **Bulk** and paste one job URL per line. Review the confirmation before sending. Each URL starts a separate run; the displayed credit estimate is not a maximum charge.
-Install the SDK:
+To extract a posting without applying, use the extraction form on the same page. Enter the job URL and open its run to view the result.
-<CodeGroup>
-```bash Python
-pip install skyvern
-```
+The page saves instructions and **Your information** in browser storage for the selected organization. Resume URLs are also saved while URL mode is active. Clear these fields or your browser's site data to remove saved values.
-```bash TypeScript
-npm install @skyvern/client
-```
-</CodeGroup>
+## Use the API
-Set your API key:
+Get your API key from [Settings](https://app.skyvern.com/settings) and set it in your shell:
```bash
export SKYVERN_API_KEY="your-api-key"
```
----
-
-## Sample Job Portal
-
-We'll use *Job Stash*, a fake job board website created for agent automation testing.
-Change `job_portal_url` to use your job portal's URL.
-
-| Field | Value |
-| -------------- | ---------------------------- |
-| URL | https://job-stash.vercel.app |
-| Login email | [email protected] |
-| Login password | helloworld |
-
-<img src="/images/cookbooks/job-stash.png" alt="Job Stash, a demo job portal" />
----
-
-## Step 1: Store credentials
-
-Before defining the agent, store the login email and password Skyvern will use.
-
-This makes sure your passwords are never stored in the shareable agent definition and never sent to LLMs.
-
-<Tabs>
- <Tab title="Cloud UI">
- <Steps>
- <Step title="Open Credentials">
- Go to **Credentials** in the sidebar. Choose **Password** after clicking on **+ Add**.
- <img src="/images/cookbooks/credentials.png" alt="Creating a password credential on Skyvern" />
- </Step>
- <Step title="Create a credential">
- Click **Create Credential**. Set the name to `Job Stash`, add login page URL, and enter the username (`[email protected]`) and password (`helloworld`). Click **Save**.
- <img src="/images/cookbooks/js-creds.png" alt="Fill username and password to add a credential to Skyvern" />
- </Step>
- <Step title="Copy the credential ID">
- Copy the credential ID (here: `cred_504284876895871734`). You'll use this when configuring the agent.
- <img src="/images/cookbooks/creds-id-copy.png" alt="Fill username and password to add a credential to Skyvern" />
- </Step>
- </Steps>
- </Tab>
- <Tab title="API / SDK">
- <CodeGroup>
- ```python Python
- import os
- import asyncio
- from skyvern import Skyvern
-
- async def main():
- client = Skyvern(api_key=os.getenv("SKYVERN_API_KEY"))
-
- credential = await client.create_credential(
- name="Job Portal",
- credential_type="password",
- credential={
- "username": "[email protected]",
- "password": "helloworld"
- }
- )
-
- print(f"Credential ID: {credential.credential_id}")
- # Save this ID for your workflow: cred_xxx
-
- asyncio.run(main())
- ```
-
- ```typescript TypeScript
- import { SkyvernClient } from "@skyvern/client";
-
- const client = new SkyvernClient({
- apiKey: process.env.SKYVERN_API_KEY,
- });
-
- const credential = await client.createCredential({
- name: "Job Portal",
- credential_type: "password",
- credential: {
- username: "[email protected]",
- password: "helloworld",
- },
- });
-
- console.log(`Credential ID: ${credential.credential_id}`);
- ```
-
- ```bash cURL
- curl -X POST "https://api.skyvern.com/v1/credentials" \
- -H "x-api-key: $SKYVERN_API_KEY" \
- -H "Content-Type: application/json" \
- -d '{
- "name": "Job Portal",
- "credential_type": "password",
- "credential": {
- "username": "[email protected]",
- "password": "helloworld"
- }
- }'
- ```
- </CodeGroup>
- </Tab>
-</Tabs>
-
----
-
-## Step 2: Create a new agent
-
-<Tabs>
- <Tab title="Cloud UI">
- <Steps>
- <Step title="Create the agent">
- Go to **Agents** → **Create Agent**. Name it "Search and Apply for Jobs Workflow".
- <img src="/images/cookbooks/create-workflow.png" alt="Create a new agent from Skyvern Dashboard" />
- </Step>
- </Steps>
- </Tab>
- <Tab title="API / SDK">
- An **agent definition** is a JSON or YAML file that describes your entire agent: its metadata, parameters, and blocks. Create a file called `job-application-workflow.yaml` (or `.json`) with the following template:
-
- <CodeGroup>
- ```json JSON
- {
- "title": "Search and Apply for Jobs Workflow",
- "description": "Search for jobs on any portal, extract listings, generate tailored answers with AI, and submit applications automatically.",
- "proxy_location": "RESIDENTIAL",
- "workflow_definition": {
- "version": 1,
- "parameters": [],
- "blocks": []
- }
- }
- ```
-
- ```yaml YAML
- title: Search and Apply for Jobs Workflow
- description: "Search for jobs on any portal, extract listings, generate tailored answers with AI, and submit applications automatically."
- proxy_location: RESIDENTIAL
- workflow_definition:
- version: 1
- parameters: [] # <-- filled in below
- blocks: [] # <-- filled in Step 3
- ```
- </CodeGroup>
-
- We'll populate `parameters` and `blocks` in the sections that follow.
- </Tab>
-</Tabs>
-
-### Set parameters
-
-Parameters are the inputs your agent accepts. Defining them upfront lets you reuse the same agent against different job portals.
-
-<Tabs>
- <Tab title="Cloud UI">
- On the **Start** node, add the following parameters:
-
- | Parameter | Type | Notes |
- |-----------|------|-------|
- | `resume` | File URL | URL to your resume PDF |
- | `credentials` | Credential ID | Select the credential you created in Step 1 |
- | `job_portal_url` | String | Job portal login URL |
- <img src="/images/cookbooks/add-params.png" alt="Setting input parameters in an agent in Skyvern" />
- </Tab>
- <Tab title="API / SDK">
- Replace the empty `parameters` array with the following:
-
- <CodeGroup>
- ```json JSON
- "parameters": [
- { "key": "resume", "parameter_type": "workflow", "workflow_parameter_type": "file_url" },
- {
- "key": "credentials",
- "parameter_type": "workflow",
- "workflow_parameter_type": "credential_id",
- "default_value": "your-credential-id"
- },
- {
- "key": "job_portal_url",
- "description": "URL of the job portal",
- "parameter_type": "workflow",
- "workflow_parameter_type": "string"
- }
- ]
- ```
-
- ```yaml YAML
- parameters:
- - key: resume
- parameter_type: workflow
- workflow_parameter_type: file_url
- - key: credentials
- parameter_type: workflow
- workflow_parameter_type: credential_id
- default_value: your-credential-id # <-- replace this
- - key: job_portal_url
- description: URL of the job portal
- parameter_type: workflow
- workflow_parameter_type: string
- ```
- </CodeGroup>
- </Tab>
-</Tabs>
-
----
-
-## Step 3: Add agent blocks
-
-The agent chains together several blocks to automate the full job application process:
-
-1. **PDF Parser block**: Extracts structured data from your resume
-2. **Login block**: Authenticates to the job portal using stored credentials
-3. **Navigation block**: Searches for relevant jobs based on your resume
-4. **Extraction block**: Extracts a list of job postings from search results
-5. **For loop** (Go to URL + Extraction + Action + Extraction + Text Prompt + Navigation): Iterates over each job to extract details, generates tailored answers using an LLM, and submits the application.
-
-In the Cloud UI, click the **+** button after the Start node to add blocks sequentially. For SDK users, add each block to the `blocks` array in your agent definition file.
-
-### PDF Parser block
-
-The `pdf_parser` block extracts structured information from your resume PDF. Skyvern uses AI to identify your name, contact info, work experience, education, and skills.
-
-<Tabs>
- <Tab title="Cloud UI">
- Add a **PDF Parser** block. Set **File URL** to the `resume` parameter.
- <img src="/images/cookbooks/add-block.png" alt="Adding a block in an agent in Skyvern" />
- </Tab>
- <Tab title="API / SDK">
- <CodeGroup>
- ```json JSON
- {
- "block_type": "pdf_parser",
- "label": "parsed_resume",
- "file_url": "{{ resume }}"
- }
- ```
-
- ```yaml YAML
- - block_type: pdf_parser
- label: parsed_resume
- file_url: "{{ resume }}"
- ```
- </CodeGroup>
- </Tab>
-</Tabs>
-
-The parsed data is accessible as `parsed_resume_output` in subsequent blocks.
-
-### Login block
-
-The `login` block authenticates using stored credentials. Skyvern injects the username/password directly into form fields without exposing them to the LLM.
-
-<Tabs>
- <Tab title="Cloud UI">
- Add a **Login** block. Configure it as follows:
-
- - **URL**: set to the `job_portal_url` parameter
- - **Credential**: Select the `credentials` parameter
- - **Goal**: "Log in using the provided credentials. Handle any cookie consent popups. COMPLETE when on the account dashboard or orders page."
-
- </Tab>
- <Tab title="API / SDK">
- <CodeGroup>
- ```json JSON
- {
- "block_type": "login",
- "label": "login_to_portal",
- "url": "{{ job_portal_url }}",
- "title": "login_to_portal",
- "parameter_keys": ["credentials"],
- "navigation_goal": "Log in using the provided credentials.\nHandle any cookie consent popups.\nCOMPLETE when on the account dashboard or orders page.",
- "max_retries": 0,
- "engine": "skyvern-1.0"
- }
- ```
-
- ```yaml YAML
- - block_type: login
- label: login_to_portal
- url: "{{ job_portal_url }}"
- title: login_to_portal
- parameter_keys:
- - credentials
- navigation_goal: |
- Log in using the provided credentials.
- Handle any cookie consent popups.
- COMPLETE when on the account dashboard or orders page.
- max_retries: 0
- engine: skyvern-1.0
- ```
- </CodeGroup>
- </Tab>
-</Tabs>
-
-### Search for jobs block
-
-Navigate to the job search and find relevant positions based on the parsed resume.
-
-<Tabs>
- <Tab title="Cloud UI">
- Add a **Navigation** block. Configure it as follows:
-
- - **URL**: Leave empty (continues from the current page after login)
- - **Goal**: "Search for a relevant job based on the parsed resume." The block will automatically reference the `parsed_resume_output` from the previous step.
-
- </Tab>
- <Tab title="API / SDK">
- <CodeGroup>
- ```json JSON
- {
- "block_type": "navigation",
- "label": "search_for_job",
- "url": "",
- "title": "search_for_job",
- "engine": "skyvern-1.0",
- "navigation_goal": "Search for a relevant job based on the parsed resume: {{parsed_resume_output}}",
- "max_retries": 0
- }
- ```
+Send the key in the `x-api-key` header on every request. The three job endpoints appear in the **Recipes** section of the API reference.
- ```yaml YAML
- - block_type: navigation
- label: search_for_job
- url: ""
- title: search_for_job
- engine: skyvern-1.0
- navigation_goal: "Search for a relevant job based on the parsed resume: {{parsed_resume_output}}"
- max_retries: 0
- ```
- </CodeGroup>
- </Tab>
-</Tabs>
+### Extract a job posting
-### Extract jobs list block
+[Extract a job application posting](/api-reference/recipes/extract-a-job-application-posting) accepts a JSON body with `job_url`:
-Extract job postings from the search results. The `data_schema` tells Skyvern exactly what structure to return.
-
-<Tabs>
- <Tab title="Cloud UI">
- Add an **Extraction** block. Configure it as follows:
-
- - **Goal**: "Extract all visible job profiles: job page url, title, employer, location, and type (full time, part time, etc)"
- - **Data Schema**: Paste the following JSON schema:
-
- ```json
- {
- "jobs": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "job_page_url": { "type": "string", "description": "Link to the apply page for the job" },
- "title": { "type": "string", "description": "Title of the role offered" },
- "employer": { "type": "string", "description": "Name of the company posting the job profile" },
- "location": { "type": "string", "description": "Where is the job role based. City and country," },
- "type": { "type": "string", "description": "Type for employment: full-time. part-time, contractual, internship etc." }
- },
- "required": ["job_page_url", "title", "employer", "location"]
- }
- }
- }
- ```
-
- </Tab>
- <Tab title="API / SDK">
- <CodeGroup>
- ```json JSON
- {
- "block_type": "extraction",
- "label": "jobs_list_extraction",
- "url": "",
- "title": "jobs_list_extraction",
- "data_extraction_goal": "Extract all visible job profiles: job page url, title, employer, location, and type (full time, part time, etc)",
- "data_schema": {
- "jobs": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "job_page_url": {
- "type": "string",
- "description": "Link to the apply page for the job"
- },
- "title": {
- "type": "string",
- "description": "Title of the role offered"
- },
- "employer": {
- "type": "string",
- "description": "Name of the company posting the job profile"
- },
- "location": {
- "type": "string",
- "description": "Where is the job role based. City and country,"
- },
- "type": {
- "type": "string",
- "description": "Type for employment: full-time. part-time, contractual, internship etc."
- }
- },
- "required": ["job_page_url", "title", "employer", "location"]
- }
- }
- },
- "max_retries": 0,
- "engine": "skyvern-1.0"
- }
- ```
-
- ```yaml YAML
- - block_type: extraction
- label: jobs_list_extraction
- url: ""
- title: jobs_list_extraction
- data_extraction_goal: "Extract all visible job profiles: job page url, title, employer, location, and type (full time, part time, etc)"
- data_schema:
- jobs:
- type: array
- items:
- type: object
- properties:
- job_page_url:
- type: string
- description: Link to the apply page for the job
- title:
- type: string
- description: Title of the role offered
- employer:
- type: string
- description: Name of the company posting the job profile
- location:
- type: string
- description: Where is the job role based. City and country,
- type:
- type: string
- description: "Type for employment: full-time. part-time, contractual, internship etc."
- required:
- - job_page_url
- - title
- - employer
- - location
- max_retries: 0
- engine: skyvern-1.0
- ```
- </CodeGroup>
- </Tab>
-</Tabs>
-
-The output is accessible as `jobs_list_extraction_output.jobs` in subsequent blocks.
-
-### Apply to jobs loop
+```bash
+curl --request POST 'https://api.skyvern.com/v1/recipes/jobs/extract' \
+ --header "x-api-key: $SKYVERN_API_KEY" \
+ --header 'Content-Type: application/json' \
+ --data '{
+ "job_url": "https://jobs.example.com/openings/software-engineer"
+ }'
+```
-Iterate over each job posting and complete the application. This loop contains multiple blocks that work together:
+The response contains the new run ID:
-1. **goto_url**: Navigate to the job page
-2. **extraction**: Extract detailed job information
-3. **action**: Click the Apply button
-4. **extraction**: Extract application form questions
-5. **text_prompt**: Generate tailored answers using AI
-6. **navigation**: Fill out and submit the application
+```json
+{
+ "workflow_run_id": "wr_123"
+}
+```
-<Tabs>
- <Tab title="Cloud UI">
- Add a **For Loop** block. Set the **Loop Variable** to `jobs_list_extraction_output.jobs`. Enable **Continue on Failure** and **Next Loop on Failure**.
+The run executes asynchronously. This response confirms that the run started; poll its status to get the extraction output.
- Inside the loop, add the following blocks in order:
+### Apply with a resume URL
- <Steps>
- <Step title="Go to URL block">
- Add a **Go to URL** block. Set **URL** to the `current_value.job_page_url` variable.
- </Step>
- <Step title="Extract job details">
- Add an **Extraction** block. Set **Goal** to: "Extract every detail about the job role present on the page."
- </Step>
- <Step title="Click Apply">
- Add an **Action** block. Set **Goal** to: "Find Apply button and click it. COMPLETE when the job application is visible on the screen."
- </Step>
- <Step title="Extract form questions">
- Add an **Extraction** block. Set **Goal** to: "Extract every question in the job application form as a list."
- </Step>
- <Step title="Generate answers">
- Add a **Text Prompt** block. Set the **Prompt** to reference the parsed resume, job details, and extracted questions so the AI generates tailored answers for each field.
- </Step>
- <Step title="Fill and submit">
- Add a **Navigation** block. Set **Goal** to: "Fill out all of the form fields using the generated answers, including optional fields. COMPLETE when the application form has been successfully submitted."
- </Step>
- </Steps>
+[Apply to a job](/api-reference/recipes/apply-to-a-job) accepts JSON with `job_url`, `resume_url`, and `custom_prompt`. Include `custom_prompt` even when you have no instructions; use an empty string.
- </Tab>
- <Tab title="API / SDK">
- <CodeGroup>
- ```json JSON
- {
- "block_type": "for_loop",
- "label": "for_each_job",
- "loop_variable_reference": "{{jobs_list_extraction_output.jobs}}",
- "continue_on_failure": true,
- "next_loop_on_failure": true,
- "complete_if_empty": true,
- "loop_blocks": [
- {
- "block_type": "goto_url",
- "label": "go_to_each_job",
- "url": "{{ current_value.job_page_url }}"
- },
- {
- "block_type": "extraction",
- "label": "extract_job_detail",
- "url": "",
- "title": "extract_job_detail",
- "data_extraction_goal": "Extract every detail about the job role present on the page",
- "max_retries": 0,
- "engine": "skyvern-1.0"
- },
- {
- "block_type": "action",
- "label": "click_apply",
- "url": "",
- "title": "click_apply",
- "navigation_goal": "Find Apply button and click it.\n\nCOMPLETE when the job application is visible on the screen",
- "max_retries": 0,
- "engine": "skyvern-1.0"
- },
- {
- "block_type": "extraction",
- "label": "extract_questions",
- "url": "",
- "title": "extract_questions",
- "data_extraction_goal": "Extract every question in the job application form as a list",
- "max_retries": 0,
- "engine": "skyvern-1.0"
- },
- {
- "block_type": "text_prompt",
- "label": "answer_form_questions",
- "prompt": "Given:\nresume: {{resume}}\nparsed resume: {{parsed_resume_output}}\ninformation about the job profile: {{extract_job_detail_output}}\napplication form questions: {{extract_questions_output}}\n\nYou are applying for {{ current_value.title }} at {{ current_value.employer }}.\n\nWrite thoughtful and impressive answers to each question using the information from resume and parsed resume output."
- },
- {
- "block_type": "navigation",
- "label": "apply_to_job",
- "url": "",
- "title": "apply_to_job",
- "engine": "skyvern-1.0",
- "navigation_goal": "Given:\n{{answer_form_questions_output}}\n\nFill out all of the form fields, including the optional fields.\n\nIf you dont know the answer to an optional question, leave it blank. If you dont know the answer to a required question such as referral name put N/A or something equivalent.\n\nCOMPLETE when the application form has been successfully submitted.\n\nMore context:\nresume: {{resume}}\nperson_information: {{parsed_resume_output}}",
- "max_retries": 0
- }
- ]
+```bash
+curl --request POST 'https://api.skyvern.com/v1/recipes/jobs/apply' \
+ --header "x-api-key: $SKYVERN_API_KEY" \
+ --header 'Content-Type: application/json' \
+ --data '{
+ "job_url": "https://jobs.example.com/openings/software-engineer",
+ "resume_url": "https://files.example.com/resume.pdf",
+ "custom_prompt": "",
+ "other_information": {
+ "location": "New York, NY",
+ "work_authorization": "Authorized to work in the United States"
}
- ```
-
- ```yaml YAML
- - block_type: for_loop
- label: for_each_job
- loop_variable_reference: "{{jobs_list_extraction_output.jobs}}"
- continue_on_failure: true
- next_loop_on_failure: true
- complete_if_empty: true
- loop_blocks:
- - block_type: goto_url
- label: go_to_each_job
- url: "{{ current_value.job_page_url }}"
-
- - block_type: extraction
- label: extract_job_detail
- url: ""
- title: extract_job_detail
- data_extraction_goal: Extract every detail about the job role present on the page
- max_retries: 0
- engine: skyvern-1.0
-
- - block_type: action
- label: click_apply
- url: ""
- title: click_apply
- navigation_goal: |
- Find Apply button and click it.
-
- COMPLETE when the job application is visible on the screen
- max_retries: 0
- engine: skyvern-1.0
-
- - block_type: extraction
- label: extract_questions
- url: ""
- title: extract_questions
- data_extraction_goal: Extract every question in the job application form as a list
- max_retries: 0
- engine: skyvern-1.0
-
- - block_type: text_prompt
- label: answer_form_questions
- prompt: |
- Given:
- resume: {{resume}}
- parsed resume: {{parsed_resume_output}}
- information about the job profile: {{extract_job_detail_output}}
- application form questions: {{extract_questions_output}}
-
- You are applying for {{ current_value.title }} at {{ current_value.employer }}.
-
- Write thoughtful and impressive answers to each question using the information from resume and parsed resume output.
-
- - block_type: navigation
- label: apply_to_job
- url: ""
- title: apply_to_job
- engine: skyvern-1.0
- navigation_goal: |
- Given:
- {{answer_form_questions_output}}
+ }'
+```
- Fill out all of the form fields, including the optional fields.
+Replace the example URLs and applicant facts with your own. Both URLs must use public HTTP or HTTPS addresses. Skyvern must be able to download the resume without an interactive login.
- If you dont know the answer to an optional question, leave it blank. If you dont know the answer to a required question such as referral name put N/A or something equivalent.
+### Apply with a file upload
- COMPLETE when the application form has been successfully submitted.
+Use `multipart/form-data` to upload a local resume. Supply `resume_file` instead of `resume_url`:
- More context:
- resume: {{resume}}
- person_information: {{parsed_resume_output}}
- max_retries: 0
- ```
- </CodeGroup>
- </Tab>
-</Tabs>
+```bash
+curl --request POST 'https://api.skyvern.com/v1/recipes/jobs/apply' \
+ --header "x-api-key: $SKYVERN_API_KEY" \
+ --form 'job_url=https://jobs.example.com/openings/software-engineer' \
+ --form 'custom_prompt=' \
+ --form '[email protected]' \
+ --form 'other_information={"location":"New York, NY"}'
+```
-**Key pattern:** `continue_on_failure: true` ensures that if one application fails, the agent continues to the next job. Inside the loop, `current_value` gives you the current job being processed.
+Let curl set the multipart `Content-Type` header and boundary. Send each field once, and use exactly one resume source per request.
----
+The API supports PDF, DOCX, and image resumes. The default upload limit is 10 MiB. Skyvern uses OCR when a PDF has no extractable text. If resume parsing fails, the application continues using the remaining inputs.
-## Complete agent definition
+Both Apply request formats return only `workflow_run_id`. Check the run result to determine whether the application was submitted.
-<Tabs>
- <Tab title="Cloud UI">
- Here's a summary of the complete agent you've built in the visual editor:
+### Supply credentials and a 2FA identifier
- <Steps>
- <Step title="Create the agent">
- Go to **Agents** → **Create Agent**. Name it "Search and Apply for Jobs Workflow." On the **Start** node, set **Proxy Location** to **Residential** and add the parameters: `resume`, `credentials`, and `job_portal_url`.
- </Step>
- <Step title="Block 1: PDF Parser">
- Add a **PDF Parser** block. Set **File URL** to the `resume` parameter.
- </Step>
- <Step title="Block 2: Login">
- Add a **Login** block. Set **URL** to the `job_portal_url` parameter. Select the `credentials` parameter. Set the goal: "Log in using the provided credentials. Handle any cookie consent popups. COMPLETE when on the account dashboard or orders page."
- </Step>
- <Step title="Block 3: Navigation (search for jobs)">
- Add a **Navigation** block. Leave **URL** empty. Set the goal: "Search for a relevant job based on the parsed resume."
- </Step>
- <Step title="Block 4: Extraction (job listings)">
- Add an **Extraction** block. Set the goal: "Extract all visible job profiles: job page url, title, employer, location, and type." Paste the jobs JSON schema into **Data Schema**.
- </Step>
- <Step title="Block 5: For Loop (apply to each job)">
- Add a **For Loop** block. Set **Loop Variable** to `jobs_list_extraction_output.jobs`. Enable **Continue on Failure** and **Next Loop on Failure**. Inside the loop, add six blocks in order: **Go to URL** (job page), **Extraction** (job details), **Action** (click Apply), **Extraction** (form questions), **Text Prompt** (generate answers), **Navigation** (fill and submit the form).
- </Step>
- </Steps>
- </Tab>
- <Tab title="API / SDK">
- Save this complete definition to `job-application-workflow.yaml` (or `.json`) before running.
+For a site that needs login, add these fields to the JSON Apply body:
- <CodeGroup>
-```json JSON
+```json
{
- "title": "Search and Apply for Jobs Workflow",
- "description": "Search for jobs on any portal, extract listings, generate tailored answers with AI, and submit applications automatically.",
- "proxy_location": "RESIDENTIAL",
- "workflow_definition": {
- "version": 1,
- "parameters": [
- { "key": "resume", "parameter_type": "workflow", "workflow_parameter_type": "file_url" },
- { "key": "credentials", "parameter_type": "workflow", "workflow_parameter_type": "credential_id", "default_value": "your-credential-id" },
- { "key": "job_portal_url", "description": "URL of the job portal", "parameter_type": "workflow", "workflow_parameter_type": "string" }
- ],
- "blocks": [
- {
- "block_type": "pdf_parser",
- "label": "parsed_resume",
- "file_url": "{{ resume }}"
- },
- {
- "block_type": "login",
- "label": "login_to_portal",
- "url": "{{ job_portal_url }}",
- "title": "login_to_portal",
- "parameter_keys": ["credentials"],
- "navigation_goal": "Log in using the provided credentials.\nHandle any cookie consent popups.\nCOMPLETE when on the account dashboard or orders page.",
- "max_retries": 0,
- "engine": "skyvern-1.0"
- },
- {
- "block_type": "navigation",
- "label": "search_for_job",
- "url": "",
- "title": "search_for_job",
- "engine": "skyvern-1.0",
- "navigation_goal": "Search for a relevant job based on the parsed resume: {{parsed_resume_output}}",
- "max_retries": 0
- },
- {
- "block_type": "extraction",
- "label": "jobs_list_extraction",
- "url": "",
- "title": "jobs_list_extraction",
- "data_extraction_goal": "Extract all visible job profiles: job page url, title, employer, location, and type (full time, part time, etc)",
- "data_schema": {
- "jobs": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "job_page_url": { "type": "string", "description": "Link to the apply page for the job" },
- "title": { "type": "string", "description": "Title of the role offered" },
- "employer": { "type": "string", "description": "Name of the company posting the job profile" },
- "location": { "type": "string", "description": "Where is the job role based. City and country," },
- "type": { "type": "string", "description": "Type for employment: full-time. part-time, contractual, internship etc." }
- },
- "required": ["job_page_url", "title", "employer", "location"]
- }
- }
- },
- "max_retries": 0,
- "engine": "skyvern-1.0"
- },
- {
- "block_type": "for_loop",
- "label": "for_each_job",
- "loop_variable_reference": "{{jobs_list_extraction_output.jobs}}",
- "continue_on_failure": true,
- "next_loop_on_failure": true,
- "complete_if_empty": true,
- "loop_blocks": [
- {
- "block_type": "goto_url",
- "label": "go_to_each_job",
- "url": "{{ current_value.job_page_url }}"
- },
- {
- "block_type": "extraction",
- "label": "extract_job_detail",
- "url": "",
- "title": "extract_job_detail",
- "data_extraction_goal": "Extract every detail about the job role present on the page",
- "max_retries": 0,
- "engine": "skyvern-1.0"
- },
- {
- "block_type": "action",
- "label": "click_apply",
- "url": "",
- "title": "click_apply",
- "navigation_goal": "Find Apply button and click it.\n\nCOMPLETE when the job application is visible on the screen",
- "max_retries": 0,
- "engine": "skyvern-1.0"
- },
- {
- "block_type": "extraction",
- "label": "extract_questions",
- "url": "",
- "title": "extract_questions",
- "data_extraction_goal": "Extract every question in the job application form as a list",
- "max_retries": 0,
- "engine": "skyvern-1.0"
- },
- {
- "block_type": "text_prompt",
- "label": "answer_form_questions",
- "prompt": "Given:\nresume: {{resume}}\nparsed resume: {{parsed_resume_output}}\ninformation about the job profile: {{extract_job_detail_output}}\napplication form questions: {{extract_questions_output}}\n\nYou are applying for {{ current_value.title }} at {{ current_value.employer }}.\n\nWrite thoughtful and impressive answers to each question using the information from resume and parsed resume output."
- },
- {
- "block_type": "navigation",
- "label": "apply_to_job",
- "url": "",
- "title": "apply_to_job",
- "engine": "skyvern-1.0",
- "navigation_goal": "Given:\n{{answer_form_questions_output}}\n\nFill out all of the form fields, including the optional fields.\n\nIf you dont know the answer to an optional question, leave it blank. If you dont know the answer to a required question such as referral name put N/A or something equivalent.\n\nCOMPLETE when the application form has been successfully submitted.\n\nMore context:\nresume: {{resume}}\nperson_information: {{parsed_resume_output}}",
- "max_retries": 0
- }
- ]
- }
- ]
- }
+ "username": "your-login",
+ "password": "your-password",
+ "persist_credentials": true,
+ "2fa_identifier": "your-configured-identifier"
}
```
-```yaml YAML
-title: Search and Apply for Jobs Workflow
-description: "Search for jobs on any portal, extract listings, generate tailored answers with AI, and submit applications automatically."
-proxy_location: RESIDENTIAL
-workflow_definition:
- version: 1
- parameters:
- - key: resume
- parameter_type: workflow
- workflow_parameter_type: file_url
- - key: credentials
- parameter_type: workflow
- workflow_parameter_type: credential_id
- default_value: your-credential-id # <-- replace this
- - key: job_portal_url
- description: URL of the job portal
- parameter_type: workflow
- workflow_parameter_type: string
-
- blocks:
- - block_type: pdf_parser
- label: parsed_resume
- file_url: "{{ resume }}"
-
- - block_type: login
- label: login_to_portal
- url: "{{ job_portal_url }}"
- title: login_to_portal
- parameter_keys:
- - credentials
- navigation_goal: |
- Log in using the provided credentials.
- Handle any cookie consent popups.
- COMPLETE when on the account dashboard or orders page.
- max_retries: 0
- engine: skyvern-1.0
-
- - block_type: navigation
- label: search_for_job
- url: ""
- title: search_for_job
- engine: skyvern-1.0
- navigation_goal: "Search for a relevant job based on the parsed resume: {{parsed_resume_output}}"
- max_retries: 0
+Provide `username` and `password` together. `persist_credentials: true` is required when you supply them and authorizes Skyvern to store the login for future use. Omit all three fields when no login is needed. `2fa_identifier` is optional.
- - block_type: extraction
- label: jobs_list_extraction
- url: ""
- title: jobs_list_extraction
- data_extraction_goal: "Extract all visible job profiles: job page url, title, employer, location, and type (full time, part time, etc)"
- data_schema:
- jobs:
- type: array
- items:
- type: object
- properties:
- job_page_url:
- type: string
- description: Link to the apply page for the job
- title:
- type: string
- description: Title of the role offered
- employer:
- type: string
- description: Name of the company posting the job profile
- location:
- type: string
- description: Where is the job role based. City and country,
- type:
- type: string
- description: "Type for employment: full-time. part-time, contractual, internship etc."
- required:
- - job_page_url
- - title
- - employer
- - location
- max_retries: 0
- engine: skyvern-1.0
+For multipart requests, send these values as text fields. Use the lowercase text `true` for `persist_credentials`:
- - block_type: for_loop
- label: for_each_job
- loop_variable_reference: "{{jobs_list_extraction_output.jobs}}"
- continue_on_failure: true
- next_loop_on_failure: true
- complete_if_empty: true
- loop_blocks:
- - block_type: goto_url
- label: go_to_each_job
- url: "{{ current_value.job_page_url }}"
-
- - block_type: extraction
- label: extract_job_detail
- url: ""
- title: extract_job_detail
- data_extraction_goal: Extract every detail about the job role present on the page
- max_retries: 0
- engine: skyvern-1.0
-
- - block_type: action
- label: click_apply
- url: ""
- title: click_apply
- navigation_goal: |
- Find Apply button and click it.
-
- COMPLETE when the job application is visible on the screen
- max_retries: 0
- engine: skyvern-1.0
-
- - block_type: extraction
- label: extract_questions
- url: ""
- title: extract_questions
- data_extraction_goal: Extract every question in the job application form as a list
- max_retries: 0
- engine: skyvern-1.0
-
- - block_type: text_prompt
- label: answer_form_questions
- prompt: |
- Given:
- resume: {{resume}}
- parsed resume: {{parsed_resume_output}}
- information about the job profile: {{extract_job_detail_output}}
- application form questions: {{extract_questions_output}}
-
- You are applying for {{ current_value.title }} at {{ current_value.employer }}.
-
- Write thoughtful and impressive answers to each question using the information from resume and parsed resume output.
-
- - block_type: navigation
- label: apply_to_job
- url: ""
- title: apply_to_job
- engine: skyvern-1.0
- navigation_goal: |
- Given:
- {{answer_form_questions_output}}
-
- Fill out all of the form fields, including the optional fields.
-
- If you dont know the answer to an optional question, leave it blank. If you dont know the answer to a required question such as referral name put N/A or something equivalent.
-
- COMPLETE when the application form has been successfully submitted.
-
- More context:
- resume: {{resume}}
- person_information: {{parsed_resume_output}}
- max_retries: 0
+```bash
+--form 'username=your-login' \
+--form 'password=your-password' \
+--form 'persist_credentials=true' \
+--form '2fa_identifier=your-configured-identifier'
```
-</CodeGroup>
- </Tab>
-</Tabs>
-
----
-
-## Step 4: Run and monitor
-Create the agent from your definition file and execute it.
+## Track runs and results
-<Tabs>
- <Tab title="Cloud UI">
- <Steps>
- <Step title="Run the agent">
- Click **Run** in the agent editor. Fill in the parameters:
+Use the returned ID with [Get run info by id](/api-reference/runs/get-run-info-by-id):
- - **resume**: URL to your resume PDF
- - **job_portal_url**: `https://job-stash.vercel.app`
- - **credentials**: Select the `Job Stash` credential
-
- </Step>
- <Step title="Monitor the run">
- Watch the run in real time. Each block shows its status as it executes. The for loop will iterate over each job posting, and you can see the AI filling out application forms in the browser recording.
-
- </Step>
- </Steps>
- </Tab>
- <Tab title="API / SDK">
- <CodeGroup>
- ```python Python
- import os
- import asyncio
- from skyvern import Skyvern
-
- async def main():
- client = Skyvern(api_key=os.getenv("SKYVERN_API_KEY"))
-
- # Create workflow from YAML file
- workflow = await client.create_workflow(
- yaml_definition=open("job-application-workflow.yaml").read()
- )
- print(f"Created workflow: {workflow.workflow_permanent_id}")
-
- # Run the workflow
- run = await client.run_workflow(
- workflow_id=workflow.workflow_permanent_id,
- parameters={
- "resume": "https://your-resume-url.com/resume.pdf", # <-- replace this
- "job_portal_url": "https://job-stash.vercel.app"
- }
- )
- print(f"Started run: {run.run_id}")
-
- # Poll for completion
- while True:
- result = await client.get_run(run.run_id)
- if result.status in ["completed", "failed", "terminated"]:
- break
- print(f"Status: {result.status}")
- await asyncio.sleep(10)
-
- print(f"Final status: {result.status}")
- if result.status == "completed":
- print("Job applications submitted successfully")
-
- asyncio.run(main())
- ```
-
- ```typescript TypeScript
- import { SkyvernClient } from "@skyvern/client";
- import * as fs from "fs";
+```bash
+curl 'https://api.skyvern.com/v1/runs/wr_123' \
+ --header "x-api-key: $SKYVERN_API_KEY"
+```
- async function main() {
- const client = new SkyvernClient({
- apiKey: process.env.SKYVERN_API_KEY,
- });
+Poll this endpoint while the run is active. When it finishes, inspect its status and output. A successful launch response alone does not confirm extraction or application completion.
- // Create workflow from YAML file
- const workflow = await client.createWorkflow({
- body: {
- yaml_definition: fs.readFileSync("job-application-workflow.yaml", "utf-8"),
- },
- });
- console.log(`Created workflow: ${workflow.workflow_permanent_id}`);
+To list recipe runs for your organization, use [List job recipe runs](/api-reference/recipes/list-job-recipe-runs):
- // Run the workflow
- const run = await client.runWorkflow({
- body: {
- workflow_id: workflow.workflow_permanent_id,
- parameters: {
- resume: "https://your-resume-url.com/resume.pdf", // <-- replace this
- job_portal_url: "https://job-stash.vercel.app",
- },
- },
- });
- console.log(`Started run: ${run.run_id}`);
+```bash
+curl 'https://api.skyvern.com/v1/recipes/jobs/runs?page=1&page_size=25' \
+ --header "x-api-key: $SKYVERN_API_KEY"
+```
- // Poll for completion
- while (true) {
- const result = await client.getRun(run.run_id);
- if (["completed", "failed", "terminated"].includes(result.status)) {
- console.log(`Final status: ${result.status}`);
- if (result.status === "completed") {
- console.log("Job applications submitted successfully");
- }
- break;
- }
- console.log(`Status: ${result.status}`);
- await new Promise((r) => setTimeout(r, 10000));
- }
- }
+Each entry includes the run ID, recipe (`apply` or `extract`), status, creation time, job URL, and failure reason when available. The response also includes `page`, `page_size`, and `has_next`. Increment `page` while `has_next` is `true`. Page size must be between 1 and 100.
- main();
- ```
+<Note>
+ Each Apply API request creates a new run. Repeating a request can submit another application, so check the original run before retrying.
+</Note>
- ```bash cURL
- # Create workflow
- WORKFLOW=$(curl -s -X POST "https://api.skyvern.com/v1/workflows" \
- -H "x-api-key: $SKYVERN_API_KEY" \
- -H "Content-Type: application/json" \
- -d "{\"yaml_definition\": $(cat job-application-workflow.yaml | jq -Rs .)}")
+## Credits
- WORKFLOW_ID=$(echo "$WORKFLOW" | jq -r '.workflow_permanent_id')
- echo "Created workflow: $WORKFLOW_ID"
+For organizations billed in recipe credits, each admitted execution attempt costs **50 credits ($0.05)**. Login, extraction, and application attempts are billed separately. Retries and fallback attempts also cost 50 credits each, including attempts that fail or are canceled after admission. Resume parsing has no separate recipe charge.
- # Run workflow (replace resume URL with your own)
- RUN=$(curl -s -X POST "https://api.skyvern.com/v1/run/workflows" \
- -H "x-api-key: $SKYVERN_API_KEY" \
- -H "Content-Type: application/json" \
- -d "{
- \"workflow_id\": \"$WORKFLOW_ID\",
- \"parameters\": {
- \"resume\": \"https://your-resume-url.com/resume.pdf\",
- \"job_portal_url\": \"https://job-stash.vercel.app\"
- }
- }")
+The launch check requires the following balance when overage is disabled:
- RUN_ID=$(echo "$RUN" | jq -r '.run_id')
- echo "Started run: $RUN_ID"
+| Request | Required credits |
+| ------------------- | ---------------: |
+| Extract | 50 |
+| Apply without login | 50–100 |
+| Apply with login | 100–150 |
- # Poll for completion
- while true; do
- RESULT=$(curl -s "https://api.skyvern.com/v1/runs/$RUN_ID" \
- -H "x-api-key: $SKYVERN_API_KEY")
- STATUS=$(echo "$RESULT" | jq -r '.status')
- echo "Status: $STATUS"
+The range depends on the execution path selected for the job site and your inputs. The launch check does not debit credits. These balances and the dashboard estimate are not maximum prices; the final charge depends on the attempts executed.
- if [[ "$STATUS" == "completed" || "$STATUS" == "failed" || "$STATUS" == "terminated" ]]; then
- echo "Workflow finished with status: $STATUS"
- break
- fi
- sleep 10
- done
- ```
- </CodeGroup>
- </Tab>
-</Tabs>
+## Handle request errors
----
+| Status | Check |
+| -----: | ------------------------------------------------------------------- |
+| 400 | Multipart fields must not be duplicated or malformed. |
+| 402 | Check your credit balance and billing settings. |
+| 403 | Check the `x-api-key` header and your organization's permissions. |
+| 413 | Reduce the uploaded resume size. |
+| 422 | Check URLs, required fields, resume source, and credential pairing. |
+| 429 | Wait before sending more launch requests. |
-## Resources
+Request validation rejects unknown fields. JSON credentials require the boolean `true` for `persist_credentials`; multipart credentials require the text `true`.
-<CardGroup cols={2}>
- <Card title="Agent Blocks Reference" icon="cube" href="/cloud/building-agents/configure-blocks">
- Complete parameter reference for all block types
- </Card>
- <Card title="Credential Management" icon="key" href="/sdk-reference/credentials/create-credential">
- Securely store and use login credentials
- </Card>
- <Card title="File Operations" icon="file" href="/cloud/building-agents/configure-blocks">
- Upload and parse files in agents
- </Card>
- <Card title="Error Handling" icon="triangle-exclamation" href="/developers/going-to-production/error-handling">
- Handle failures and retries in production
- </Card>
-</CardGroup>
+Use the [Recipes API reference](/api-reference/recipes/apply-to-a-job) for the full request and response schemas.
diff --git a/docs/cookbooks/overview.mdx b/docs/cookbooks/overview.mdx
index 5f4dda52d..f748875ac 100644
--- a/docs/cookbooks/overview.mdx
+++ b/docs/cookbooks/overview.mdx
@@ -12,9 +12,9 @@ keywords:
- use case
---
-Cookbooks are complete, production-ready agent examples that demonstrate how to use Skyvern Browser Automation agent in real-world use-cases.
+Cookbooks show how to complete common tasks with Skyvern recipes and custom agents.
-Each cookbook walks through the agent step-by-step, explaining design decisions and showing you how to adapt it for your use case.
+Each cookbook walks through the dashboard or API steps, explains the required inputs, and shows how to track the results.
---
@@ -29,11 +29,11 @@ Each cookbook walks through the agent step-by-step, explaining design decisions
Download invoices from vendor portals, parse PDFs to extract amounts, and email a summary with attachments.
</Card>
<Card
- title="Job Applications Pipeline"
+ title="Job Application Recipes"
icon="briefcase"
href="/cookbooks/job-application-filler"
>
- Search for jobs on any portal, extract listings, generate tailored answers with AI, and submit applications automatically.
+ Extract job details, apply with your resume, and track applications through the recipe page or API.
</Card>
<Card
title="Healthcare Portal Data Extraction"
@@ -48,7 +48,7 @@ Each cookbook walks through the agent step-by-step, explaining design decisions
## Getting your API key
-All cookbooks require a Skyvern API key. Here's how to get one:
+API examples require a Skyvern API key. Here's how to get one:
<Steps>
<Step title="Create an account">
diff --git a/docs/docs.json b/docs/docs.json
index a9030e094..747c98e6f 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -428,6 +428,18 @@
}
},
"redirects": [
+ {
+ "source": "/api-reference/runs/extract-a-job-application-posting",
+ "destination": "/api-reference/recipes/extract-a-job-application-posting"
+ },
+ {
+ "source": "/api-reference/runs/apply-to-a-job",
+ "destination": "/api-reference/recipes/apply-to-a-job"
+ },
+ {
+ "source": "/api-reference/runs/list-job-recipe-runs",
+ "destination": "/api-reference/recipes/list-job-recipe-runs"
+ },
{
"source": "/going-to-production/captcha-bot-detection",
"destination": "/developers/features/captcha-and-bot-bypass"
diff --git a/docs/llms.txt b/docs/llms.txt
index 6a285583e..02e035c38 100644
--- a/docs/llms.txt
+++ b/docs/llms.txt
@@ -182,9 +182,9 @@
## Cookbooks
-- [Cookbooks Overview](https://skyvern.com/docs/cookbooks/overview.md): End-to-end workflow examples for common browser automation scenarios
+- [Cookbooks Overview](https://skyvern.com/docs/cookbooks/overview.md): Guides to common browser automation tasks using recipes and custom agents
- [Bulk Invoice Downloader](https://skyvern.com/docs/cookbooks/bulk-invoice-downloader.md): Build a workflow that logs into vendor portals, finds invoices by date, and downloads them as PDFs
-- [Job Application Pipeline](https://skyvern.com/docs/cookbooks/job-application-filler.md): Search for jobs and automatically fill out applications using stored credentials and resume data
+- [Job Application Recipes](https://skyvern.com/docs/cookbooks/job-application-filler.md): Extract job details, apply with a resume, and track runs through the recipe page or authenticated API
- [Healthcare Portal Data Extraction](https://skyvern.com/docs/cookbooks/healthcare-portal-data.md): Extract patient demographics and billing data from OpenEMR using the Python SDK
## Cloud UI
@@ -193,7 +193,7 @@ For visual dashboard documentation; running tasks, building workflows, managing
## API Reference
-- [OpenAPI Specification](https://skyvern.com/docs/api-reference/openapi.json): Full OpenAPI 3.x spec for all Skyvern REST API endpoints; tasks, workflows, browser sessions, browser profiles, credentials, and artifacts
+- [OpenAPI Specification](https://skyvern.com/docs/api-reference/openapi.json): Full OpenAPI 3.x spec for all Skyvern REST API endpoints; tasks, workflows, recipes, browser sessions, browser profiles, credentials, and artifacts
## Changelog
diff --git a/tests/unit/test_api_docs_taxonomy.py b/tests/unit/test_api_docs_taxonomy.py
index ddab6a23c..c522b372e 100644
--- a/tests/unit/test_api_docs_taxonomy.py
+++ b/tests/unit/test_api_docs_taxonomy.py
@@ -37,6 +37,7 @@ APPROVED_TAGS = {
"Server",
"SDK",
"Runs",
+ "Recipes",
}
# Pre-rebrand / internal tags that must never render a public section again.
RETIRED_TAGS = {
@@ -69,6 +70,9 @@ RETAGGED_PATH_TAGS = {
"/v1/runs/cancel": "Runs",
"/v1/agents/runs": "Runs",
"/v1/agents/{workflow_id}/runs": "Runs",
+ "/v1/recipes/jobs/extract": "Recipes",
+ "/v1/recipes/jobs/apply": "Recipes",
+ "/v1/recipes/jobs/runs": "Recipes",
}