playwright Documentation

1. Project Overview & Quickstart (microsoft/playwright) Copy Chapter

File: README.md Copy Chapter

🎭 Playwright

[Documentation](https://playwright.dev) | [API reference](https://playwright.dev/docs/api/class-playwright) Copy Chapter

Playwright is a framework for web automation and testing. It drives Chromium, Firefox, and WebKit with a single API — in your tests, in your scripts, and as a tool for AI agents.

Get Started Copy Chapter

Choose the path that fits your workflow:

Playwright Test Copy Chapter

Playwright Test is a full-featured test runner built for end-to-end testing. It runs tests across Chromium, Firefox, and WebKit with full browser isolation, auto-waiting, and web-first assertions.

Install Copy Section

npm init playwright@latest

Or add manually:

npm i -D @playwright/test
npx playwright install

Write a test Copy Section

import { test, expect } from '@playwright/test';

test('has title', async ({ page }) => {
  await page.goto('https://playwright.dev/');
  await expect(page).toHaveTitle(/Playwright/);
});

test('get started link', async ({ page }) => {
  await page.goto('https://playwright.dev/');
  await page.getByRole('link', { name: 'Get started' }).click();
  await expect(page.getByRole('heading', { name: 'Installation' })).toBeVisible();
});

Run tests Copy Section

npx playwright test

Tests run in parallel across all configured browsers, in headless mode by default. Each test gets a fresh browser context — full isolation with near-zero overhead.

Key capabilities Copy Section

Auto-wait and web-first assertions. No artificial timeouts. Playwright waits for elements to be actionable, and assertions automatically retry until conditions are met.

Locators. Find elements with resilient locators that mirror how users see the page:

page.getByRole('button', { name: 'Submit' })
page.getByLabel('Email')
page.getByPlaceholder('Search...')
page.getByTestId('login-form')

Test isolation. Each test runs in its own browser context — equivalent to a fresh browser profile. Save authentication state once and reuse it across tests:

// Save state after login
await page.context().storageState({ path: 'auth.json' });

// Reuse in other tests
test.use({ storageState: 'auth.json' });

Tracing. Capture execution traces, screenshots, and videos on failure. Inspect every action, DOM snapshot, network request, and console message in the Trace Viewer:

// playwright.config.ts
export default defineConfig({
  use: {
    trace: 'on-first-retry',
  },
});

npx playwright show-trace trace.zip

Parallelism. Tests run in parallel by default across all configured browsers.

Full testing documentation

Playwright CLI Copy Chapter

Playwright CLI is a command-line interface for browser automation designed for coding agents. It's more token-efficient than MCP — commands avoid loading large tool schemas and accessibility trees into the model context.

Install Copy Section

npm install @playwright/cli@latest

Optionally install skills for richer agent integration:

playwright-cli install --skills

Usage Copy Section

Point your coding agent at a task:

Test the "add todo" flow on https://demo.playwright.dev/todomvc using playwright-cli.
Take screenshots for all successful and failing scenarios.

Or run commands directly:

playwright-cli open https://demo.playwright.dev/todomvc/ --headed
playwright-cli type "Buy groceries"
playwright-cli press Enter
playwright-cli screenshot

Session monitoring Copy Section

Use playwright-cli show to open a visual dashboard with live screencast previews of all running browser sessions. Click any session to zoom in and take remote control.

playwright-cli show

Full CLI documentation | GitHub

Playwright MCP Copy Chapter

The Playwright MCP server gives AI agents full browser control through the Model Context Protocol. Agents interact with pages using structured accessibility snapshots — no vision models or screenshots required.

Setup Copy Section

Add to your MCP client (VS Code, Cursor, Claude Desktop, Windsurf, etc.):

{
  "mcpServers": {
    "playwright": {
      "command": "npx",
      "args": ["@playwright/mcp@latest"]
    }
  }
}

One-click install for VS Code:

For Claude Code:

claude mcp add playwright npx @playwright/mcp@latest

How it works Copy Section

Ask your AI assistant to interact with any web page:

Navigate to https://demo.playwright.dev/todomvc and add a few todo items.

The agent sees the page as a structured accessibility tree:

- heading "todos" [level=1]
- textbox "What needs to be done?" [ref=e5]
- listitem:
  - checkbox "Toggle Todo" [ref=e10]
  - text: "Buy groceries"

It uses element refs like e5 and e10 to click, type, and interact — deterministically and without visual ambiguity. Tools cover navigation, form filling, screenshots, network mocking, storage management, and more.

Full MCP documentation | GitHub

Playwright Library Copy Chapter

Use playwright as a library for browser automation scripts — web scraping, PDF generation, screenshot capture, and any workflow that needs programmatic browser control without a test runner.

Install Copy Section

npm i playwright

Examples Copy Section

Take a screenshot:

import { chromium } from 'playwright';

const browser = await chromium.launch();
const page = await browser.newPage();
await page.goto('https://playwright.dev/');
await page.screenshot({ path: 'screenshot.png' });
await browser.close();

Generate a PDF:

import { chromium } from 'playwright';

const browser = await chromium.launch();
const page = await browser.newPage();
await page.goto('https://playwright.dev/');
await page.pdf({ path: 'page.pdf', format: 'A4' });
await browser.close();

Emulate a mobile device:

import { chromium, devices } from 'playwright';

const browser = await chromium.launch();
const context = await browser.newContext(devices['iPhone 15']);
const page = await context.newPage();
await page.goto('https://playwright.dev/');
await page.screenshot({ path: 'mobile.png' });
await browser.close();

Intercept network requests:

import { chromium } from 'playwright';

const browser = await chromium.launch();
const page = await browser.newPage();
await page.route('**/*.{png,jpg,jpeg}', route => route.abort());
await page.goto('https://playwright.dev/');
await browser.close();

Library documentation | API reference

VS Code Extension Copy Chapter

The Playwright VS Code extension brings test running, debugging, and code generation directly into your editor.

Run and debug tests from the editor with a single click. Set breakpoints, inspect variables, and step through test execution with a live browser view.

Generate tests with CodeGen. Click "Record new" to open a browser — navigate and interact with your app while Playwright writes the test code for you.

Pick locators. Hover over any element in the browser to see the best available locator, then click to copy it to your clipboard.

Trace Viewer integration. Enable "Show Trace Viewer" in the sidebar to get a full execution trace after each test run — DOM snapshots, network requests, console logs, and screenshots at every step.

Install the extension | VS Code guide

Cross-Browser Support Copy Chapter

Headless and headed execution on all platforms. ¹ Uses Chrome for Testing by default.

Other Languages Copy Chapter

Playwright is also available for Python, .NET, and Java.

Resources Copy Chapter

• Documentation
• API reference
• MCP server
• CLI for coding agents
• VS Code extension
• Contribution guide
• Changelog
• Discord

File: browser_patches/winldd/README.md Copy Chapter

Tool for printing .exe and .dll dependencies on Windows

This is similar to ldd on linux in that loads specified files and tries to
resolve all DLLs referenced by it, printing in the formar <lib name> => <full path> | "no found"
To minimize dependencies we link all C runtime libraries statically, there is
still one dynamic dependency on dbghelp.dll which is supposed to be preinstalled
on all Windows machines.

Build instructions Copy Chapter

Open PrintDeps.sln solution in Visual Studio 2019 and build x64/Release configuration. We
currently commit output binary into bin/PrintDeps.exe and bundle it in every npm.

File: docs/src/api/class-apirequest.md Copy Chapter

class: APIRequest

• since: v1.16

Exposes API that can be used for the Web API testing. This class is used for creating
[APIRequestContext] instance which in turn can be used for sending web requests. An instance
of this class can be obtained via [property: Playwright.request]. For more information
see [APIRequestContext].

async method: APIRequest.newContext Copy Chapter

• since: v1.16

• returns: <[APIRequestContext]>

Creates new instances of [APIRequestContext].

option: APIRequest.newContext.clientCertificates = %%-context-option-clientCertificates-%% Copy Section

• since: 1.46

option: APIRequest.newContext.useragent = %%-context-option-useragent-%% Copy Section

• since: v1.16

option: APIRequest.newContext.extraHTTPHeaders = %%-context-option-extrahttpheaders-%% Copy Section

• since: v1.16

option: APIRequest.newContext.failOnStatusCode Copy Section

• since: v1.51

• failOnStatusCode <[boolean]>

Whether to throw on response codes other than 2xx and 3xx. By default response object is returned
for all status codes.

option: APIRequest.newContext.httpCredentials = %%-context-option-httpcredentials-%% Copy Section

• since: v1.16

option: APIRequest.newContext.proxy = %%-browser-option-proxy-%% Copy Section

• since: v1.16

option: APIRequest.newContext.ignoreHTTPSErrors = %%-context-option-ignorehttpserrors-%% Copy Section

• since: v1.16

option: APIRequest.newContext.maxRedirects Copy Section

• since: v1.52

• maxRedirects <[int]>

Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded.
Defaults to 20. Pass 0 to not follow redirects. This can be overwritten for each request individually.

option: APIRequest.newContext.timeout Copy Section

• since: v1.16

• timeout <[float]>

Maximum time in milliseconds to wait for the response. Defaults to
30000 (30 seconds). Pass 0 to disable timeout.

option: APIRequest.newContext.baseURL Copy Section

• since: v1.16

• baseURL <[string]>

Methods like [method: APIRequestContext.get] take the base URL into consideration by using the URL() constructor for building the corresponding URL. Examples:

• baseURL: http://localhost:3000 and sending request to /bar.html results in http://localhost:3000/bar.html
• baseURL: http://localhost:3000/foo/ and sending request to ./bar.html results in http://localhost:3000/foo/bar.html
• baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html

option: APIRequest.newContext.storageState Copy Section

• since: v1.16
• langs: js, python

• storageState <[path]|[Object]>
  • cookies <[Array]<[Object]>>
    • name <[string]>
    • value <[string]>
    • domain <[string]>
    • path <[string]>
    • expires <[float]> Unix time in seconds.
    • httpOnly <[boolean]>
    • secure <[boolean]>
    • sameSite <[SameSiteAttribute]<"Strict"|"Lax"|"None">>
  • origins <[Array]<[Object]>>
    • origin <[string]>
    • localStorage <[Array]<[Object]>>
      • name <[string]>
      • value <[string]>

Populates context with given storage state. This option can be used to initialize context with logged-in information
obtained via [method: BrowserContext.storageState] or [method: APIRequestContext.storageState]. Either a path to the
file with saved storage, or the value returned by one of [method: BrowserContext.storageState] or
[method: APIRequestContext.storageState] methods.

option: APIRequest.newContext.storageState Copy Section

• since: v1.16
• langs: java, csharp

• storageState <[string]>

Populates context with given storage state. This option can be used to initialize context with logged-in information
obtained via [method: BrowserContext.storageState] or [method: APIRequestContext.storageState]. Either a path to the
file with saved storage, or the value returned by one of [method: BrowserContext.storageState] or
[method: APIRequestContext.storageState] methods.

option: APIRequest.newContext.storageStatePath = %%-csharp-java-context-option-storage-state-path-%% Copy Section

• since: v1.18

File: docs/src/api/class-apirequestcontext.md Copy Chapter

class: APIRequestContext

• since: v1.16

This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
environment or the service to your e2e test.

Each Playwright browser context has an associated [APIRequestContext], accessible via
[property: BrowserContext.request] or [property: Page.request] (these return the
same instance — page.request is a shortcut for page.context().request).
You can also create a standalone, isolated instance with [method: APIRequest.newContext].

Cookie management

The [APIRequestContext] returned by [property: BrowserContext.request] and
[property: Page.request] uses the same cookie jar as its [BrowserContext]:

• Every outgoing API request automatically includes the context's cookies in the
  Cookie header — you do not need to read cookies from the context and attach them manually.
• Any Set-Cookie headers in API responses are written back to the [BrowserContext],
  so subsequent page navigations and API calls pick them up.
• Logging in via the API logs in the browser, and vice versa.

If you want API requests that do not share cookies with the browser, create an
isolated context via [method: APIRequest.newContext]. Such APIRequestContext
object will have its own isolated cookie storage.

import os
import asyncio
from playwright.async_api import async_playwright, Playwright

REPO = "test-repo-1"
USER = "github-username"
API_TOKEN = os.getenv("GITHUB_API_TOKEN")

async def run(playwright: Playwright):
    # This will launch a new browser, create a context and page. When making HTTP
    # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)
    # it will automatically set the cookies to the browser page and vice versa.
    browser = await playwright.chromium.launch()
    context = await browser.new_context(base_url="https://api.github.com")
    api_request_context = context.request
    page = await context.new_page()

    # Alternatively you can create a APIRequestContext manually without having a browser context attached:
    # api_request_context = await playwright.request.new_context(base_url="https://api.github.com")

    # Create a repository.
    response = await api_request_context.post(
        "/user/repos",
        headers={
            "Accept": "application/vnd.github.v3+json",
            # Add GitHub personal access token.
            "Authorization": f"token {API_TOKEN}",
        },
        data={"name": REPO},
    )
    assert response.ok
    assert response.json()["name"] == REPO

    # Delete a repository.
    response = await api_request_context.delete(
        f"/repos/{USER}/{REPO}",
        headers={
            "Accept": "application/vnd.github.v3+json",
            # Add GitHub personal access token.
            "Authorization": f"token {API_TOKEN}",
        },
    )
    assert response.ok
    assert await response.body() == '{"status": "ok"}'

async def main():
    async with async_playwright() as playwright:
        await run(playwright)

asyncio.run(main())

import os
from playwright.sync_api import sync_playwright

REPO = "test-repo-1"
USER = "github-username"
API_TOKEN = os.getenv("GITHUB_API_TOKEN")

with sync_playwright() as p:
    # This will launch a new browser, create a context and page. When making HTTP
    # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)
    # it will automatically set the cookies to the browser page and vice versa.
    browser = p.chromium.launch()
    context = browser.new_context(base_url="https://api.github.com")
    api_request_context = context.request
    page = context.new_page()

    # Alternatively you can create a APIRequestContext manually without having a browser context attached:
    # api_request_context = p.request.new_context(base_url="https://api.github.com")


    # Create a repository.
    response = api_request_context.post(
        "/user/repos",
        headers={
            "Accept": "application/vnd.github.v3+json",
            # Add GitHub personal access token.
            "Authorization": f"token {API_TOKEN}",
        },
        data={"name": REPO},
    )
    assert response.ok
    assert response.json()["name"] == REPO

    # Delete a repository.
    response = api_request_context.delete(
        f"/repos/{USER}/{REPO}",
        headers={
            "Accept": "application/vnd.github.v3+json",
            # Add GitHub personal access token.
            "Authorization": f"token {API_TOKEN}",
        },
    )
    assert response.ok
    assert await response.body() == '{"status": "ok"}'

method: APIRequestContext.createFormData Copy Chapter

• since: v1.23
• langs: csharp

• returns: <[FormData]>

Creates a new [FormData] instance which is used for providing form and multipart data when making HTTP requests.

async method: APIRequestContext.delete Copy Chapter

• since: v1.16

• returns: <[APIResponse]>

Sends HTTP(S) DELETE request and returns its response.
The method will populate request cookies from the context and update
context cookies from the response. The method will automatically follow redirects.

param: APIRequestContext.delete.url = %%-fetch-param-url-%% Copy Section

• since: v1.16

option: APIRequestContext.delete.params = %%-js-fetch-option-params-%% Copy Section

• since: v1.16

param: APIRequestContext.delete.params = %%-java-fetch-params-%% Copy Section

• since: v1.18

option: APIRequestContext.delete.params = %%-python-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.delete.params = %%-csharp-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.delete.paramsString = %%-csharp-fetch-option-paramsString-%% Copy Section

• since: v1.47

option: APIRequestContext.delete.headers = %%-js-python-csharp-fetch-option-headers-%% Copy Section

• since: v1.16

option: APIRequestContext.delete.data = %%-js-python-csharp-fetch-option-data-%% Copy Section

• since: v1.17

option: APIRequestContext.delete.form = %%-js-fetch-option-form-%% Copy Section

• since: v1.17

option: APIRequestContext.delete.form = %%-python-fetch-option-form-%% Copy Section

• since: v1.17

option: APIRequestContext.delete.form = %%-csharp-fetch-option-form-%% Copy Section

• since: v1.17

option: APIRequestContext.delete.multipart = %%-js-fetch-option-multipart-%% Copy Section

• since: v1.17

option: APIRequestContext.delete.multipart = %%-python-fetch-option-multipart-%% Copy Section

• since: v1.17

option: APIRequestContext.delete.multipart = %%-csharp-fetch-option-multipart-%% Copy Section

• since: v1.17

option: APIRequestContext.delete.timeout = %%-js-python-csharp-fetch-option-timeout-%% Copy Section

• since: v1.16

option: APIRequestContext.delete.signal = %%-input-signal-%% Copy Section

option: APIRequestContext.delete.failOnStatusCode = %%-js-python-csharp-fetch-option-failonstatuscode-%% Copy Section

• since: v1.16

option: APIRequestContext.delete.ignoreHTTPSErrors = %%-js-python-csharp-fetch-option-ignorehttpserrors-%% Copy Section

• since: v1.16

option: APIRequestContext.delete.maxRedirects = %%-js-python-csharp-fetch-option-maxredirects-%% Copy Section

• since: v1.26

option: APIRequestContext.delete.maxRetries = %%-js-python-csharp-fetch-option-maxretries-%% Copy Section

• since: v1.46

async method: APIRequestContext.dispose Copy Chapter

• since: v1.16

All responses returned by [method: APIRequestContext.get] and similar methods are stored in the memory, so that you can later call [method: APIResponse.body].This method discards all its resources, calling any method on disposed [APIRequestContext] will throw an exception.

option: APIRequestContext.dispose.reason Copy Section

• since: v1.45

• reason <[string]>

The reason to be reported to the operations interrupted by the context disposal.

async method: APIRequestContext.fetch Copy Chapter

• since: v1.16

• returns: <[APIResponse]>

Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update
context cookies from the response. The method will automatically follow redirects.

Usage

JSON objects can be passed directly to the request:

await request.fetch('https://example.com/api/createBook', {
  method: 'post',
  data: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

Map<String, Object> data = new HashMap();
data.put("title", "Book Title");
data.put("body", "John Doe");
request.fetch("https://example.com/api/createBook", RequestOptions.create().setMethod("post").setData(data));

data = {
    "title": "Book Title",
    "body": "John Doe",
}
api_request_context.fetch("https://example.com/api/createBook", method="post", data=data)

var data = new Dictionary<string, object>() {
  { "title", "Book Title" },
  { "body", "John Doe" }
};
await Request.FetchAsync("https://example.com/api/createBook", new() { Method = "post", DataObject = data });

The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data encoding, by specifiying the multipart parameter:

const form = new FormData();
form.set('name', 'John');
form.append('name', 'Doe');
// Send two file fields with the same name.
form.append('file', new File(['console.log(2024);'], 'f1.js', { type: 'text/javascript' }));
form.append('file', new File(['hello'], 'f2.txt', { type: 'text/plain' }));
await request.fetch('https://example.com/api/uploadForm', {
  multipart: form
});

// Pass file path to the form data constructor:
Path file = Paths.get("team.csv");
APIResponse response = request.fetch("https://example.com/api/uploadTeamList",
  RequestOptions.create().setMethod("post").setMultipart(
    FormData.create().set("fileField", file)));

// Or you can pass the file content directly as FilePayload object:
FilePayload filePayload = new FilePayload("f.js", "text/javascript",
      "console.log(2022);".getBytes(StandardCharsets.UTF_8));
APIResponse response = request.fetch("https://example.com/api/uploadScript",
  RequestOptions.create().setMethod("post").setMultipart(
    FormData.create().set("fileField", filePayload)));

api_request_context.fetch(
  "https://example.com/api/uploadScript",  method="post",
  multipart={
    "fileField": {
      "name": "f.js",
      "mimeType": "text/javascript",
      "buffer": b"console.log(2022);",
    },
  })

var file = new FilePayload()
{
    Name = "f.js",
    MimeType = "text/javascript",
    Buffer = System.Text.Encoding.UTF8.GetBytes("console.log(2022);")
};
var multipart = Context.APIRequest.CreateFormData();
multipart.Set("fileField", file);
await Request.FetchAsync("https://example.com/api/uploadScript", new() { Method = "post", Multipart = multipart });

param: APIRequestContext.fetch.urlOrRequest Copy Section

• since: v1.16

• urlOrRequest <[string]|[Request]>

Target URL or Request to get all parameters from.

option: APIRequestContext.fetch.params = %%-js-fetch-option-params-%% Copy Section

• since: v1.16

param: APIRequestContext.fetch.params = %%-java-fetch-params-%% Copy Section

• since: v1.18

option: APIRequestContext.fetch.params = %%-python-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.params = %%-csharp-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.paramsString = %%-csharp-fetch-option-paramsString-%% Copy Section

• since: v1.47

option: APIRequestContext.fetch.method Copy Section

• since: v1.16
• langs: js, python, csharp

• method <[string]>

If set changes the fetch method (e.g. PUT or
POST). If not specified, GET method is used.

option: APIRequestContext.fetch.headers = %%-js-python-csharp-fetch-option-headers-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.data = %%-js-python-csharp-fetch-option-data-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.form = %%-js-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.form = %%-python-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.form = %%-csharp-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.multipart = %%-js-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.multipart = %%-python-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.multipart = %%-csharp-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.timeout = %%-js-python-csharp-fetch-option-timeout-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.signal = %%-input-signal-%% Copy Section

option: APIRequestContext.fetch.failOnStatusCode = %%-js-python-csharp-fetch-option-failonstatuscode-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.ignoreHTTPSErrors = %%-js-python-csharp-fetch-option-ignorehttpserrors-%% Copy Section

• since: v1.16

option: APIRequestContext.fetch.maxRedirects = %%-js-python-csharp-fetch-option-maxredirects-%% Copy Section

• since: v1.26

option: APIRequestContext.fetch.maxRetries = %%-js-python-csharp-fetch-option-maxretries-%% Copy Section

• since: v1.46

async method: APIRequestContext.get Copy Chapter

• since: v1.16

• returns: <[APIResponse]>

Sends HTTP(S) GET request and returns its response.
The method will populate request cookies from the context and update
context cookies from the response. The method will automatically follow redirects.

Usage

Request parameters can be configured with params option, they will be serialized into the URL search parameters:

// Passing params as object
await request.get('https://example.com/api/getText', {
  params: {
    'isbn': '1234',
    'page': 23,
  }
});

// Passing params as URLSearchParams
const searchParams = new URLSearchParams();
searchParams.set('isbn', '1234');
searchParams.append('page', 23);
searchParams.append('page', 24);
await request.get('https://example.com/api/getText', { params: searchParams });

// Passing params as string
const queryString = 'isbn=1234&page=23&page=24';
await request.get('https://example.com/api/getText', { params: queryString });

request.get("https://example.com/api/getText", RequestOptions.create()
  .setQueryParam("isbn", "1234")
  .setQueryParam("page", 23));

query_params = {
  "isbn": "1234",
  "page": "23"
}
api_request_context.get("https://example.com/api/getText", params=query_params)

var queryParams = new Dictionary<string, object>()
{
  { "isbn", "1234" },
  { "page", 23 },
};
await request.GetAsync("https://example.com/api/getText", new() { Params = queryParams });

param: APIRequestContext.get.url = %%-fetch-param-url-%% Copy Section

• since: v1.16

option: APIRequestContext.get.params = %%-js-fetch-option-params-%% Copy Section

• since: v1.16

param: APIRequestContext.get.params = %%-java-fetch-params-%% Copy Section

• since: v1.18

option: APIRequestContext.get.params = %%-python-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.get.params = %%-csharp-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.get.paramsString = %%-csharp-fetch-option-paramsString-%% Copy Section

• since: v1.47

option: APIRequestContext.get.headers = %%-js-python-csharp-fetch-option-headers-%% Copy Section

• since: v1.16

option: APIRequestContext.get.data = %%-js-python-csharp-fetch-option-data-%% Copy Section

• since: v1.26

option: APIRequestContext.get.form = %%-js-fetch-option-form-%% Copy Section

• since: v1.26

option: APIRequestContext.get.form = %%-python-fetch-option-form-%% Copy Section

• since: v1.26

option: APIRequestContext.get.form = %%-csharp-fetch-option-form-%% Copy Section

• since: v1.26

option: APIRequestContext.get.multipart = %%-js-fetch-option-multipart-%% Copy Section

• since: v1.26

option: APIRequestContext.get.multipart = %%-python-fetch-option-multipart-%% Copy Section

• since: v1.26

option: APIRequestContext.get.multipart = %%-csharp-fetch-option-multipart-%% Copy Section

• since: v1.26

option: APIRequestContext.get.timeout = %%-js-python-csharp-fetch-option-timeout-%% Copy Section

• since: v1.16

option: APIRequestContext.get.signal = %%-input-signal-%% Copy Section

option: APIRequestContext.get.failOnStatusCode = %%-js-python-csharp-fetch-option-failonstatuscode-%% Copy Section

• since: v1.16

option: APIRequestContext.get.ignoreHTTPSErrors = %%-js-python-csharp-fetch-option-ignorehttpserrors-%% Copy Section

• since: v1.16

option: APIRequestContext.get.maxRedirects = %%-js-python-csharp-fetch-option-maxredirects-%% Copy Section

• since: v1.26

option: APIRequestContext.get.maxRetries = %%-js-python-csharp-fetch-option-maxretries-%% Copy Section

• since: v1.46

async method: APIRequestContext.head Copy Chapter

• since: v1.16

• returns: <[APIResponse]>

Sends HTTP(S) HEAD request and returns its response.
The method will populate request cookies from the context and update
context cookies from the response. The method will automatically follow redirects.

param: APIRequestContext.head.url = %%-fetch-param-url-%% Copy Section

• since: v1.16

option: APIRequestContext.head.params = %%-js-fetch-option-params-%% Copy Section

• since: v1.16

param: APIRequestContext.head.params = %%-java-fetch-params-%% Copy Section

• since: v1.18

option: APIRequestContext.head.params = %%-python-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.head.params = %%-csharp-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.head.paramsString = %%-csharp-fetch-option-paramsString-%% Copy Section

• since: v1.47

option: APIRequestContext.head.headers = %%-js-python-csharp-fetch-option-headers-%% Copy Section

• since: v1.16

option: APIRequestContext.head.data = %%-js-python-csharp-fetch-option-data-%% Copy Section

• since: v1.26

option: APIRequestContext.head.form = %%-python-fetch-option-form-%% Copy Section

• since: v1.26

option: APIRequestContext.head.form = %%-js-fetch-option-form-%% Copy Section

• since: v1.26

option: APIRequestContext.head.form = %%-csharp-fetch-option-form-%% Copy Section

• since: v1.26

option: APIRequestContext.head.multipart = %%-js-fetch-option-multipart-%% Copy Section

• since: v1.26

option: APIRequestContext.head.multipart = %%-python-fetch-option-multipart-%% Copy Section

• since: v1.26

option: APIRequestContext.head.multipart = %%-csharp-fetch-option-multipart-%% Copy Section

• since: v1.26

option: APIRequestContext.head.timeout = %%-js-python-csharp-fetch-option-timeout-%% Copy Section

• since: v1.16

option: APIRequestContext.head.signal = %%-input-signal-%% Copy Section

option: APIRequestContext.head.failOnStatusCode = %%-js-python-csharp-fetch-option-failonstatuscode-%% Copy Section

• since: v1.16

option: APIRequestContext.head.ignoreHTTPSErrors = %%-js-python-csharp-fetch-option-ignorehttpserrors-%% Copy Section

• since: v1.16

option: APIRequestContext.head.maxRedirects = %%-js-python-csharp-fetch-option-maxredirects-%% Copy Section

• since: v1.26

option: APIRequestContext.head.maxRetries = %%-js-python-csharp-fetch-option-maxretries-%% Copy Section

• since: v1.46

async method: APIRequestContext.patch Copy Chapter

• since: v1.16

• returns: <[APIResponse]>

Sends HTTP(S) PATCH request and returns its response.
The method will populate request cookies from the context and update
context cookies from the response. The method will automatically follow redirects.

param: APIRequestContext.patch.url = %%-fetch-param-url-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.params = %%-js-fetch-option-params-%% Copy Section

• since: v1.16

param: APIRequestContext.patch.params = %%-java-fetch-params-%% Copy Section

• since: v1.18

option: APIRequestContext.patch.params = %%-python-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.params = %%-csharp-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.paramsString = %%-csharp-fetch-option-paramsString-%% Copy Section

• since: v1.47

option: APIRequestContext.patch.headers = %%-js-python-csharp-fetch-option-headers-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.data = %%-js-python-csharp-fetch-option-data-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.form = %%-js-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.form = %%-python-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.form = %%-csharp-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.multipart = %%-js-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.multipart = %%-python-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.multipart = %%-csharp-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.timeout = %%-js-python-csharp-fetch-option-timeout-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.signal = %%-input-signal-%% Copy Section

option: APIRequestContext.patch.failOnStatusCode = %%-js-python-csharp-fetch-option-failonstatuscode-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.ignoreHTTPSErrors = %%-js-python-csharp-fetch-option-ignorehttpserrors-%% Copy Section

• since: v1.16

option: APIRequestContext.patch.maxRedirects = %%-js-python-csharp-fetch-option-maxredirects-%% Copy Section

• since: v1.26

option: APIRequestContext.patch.maxRetries = %%-js-python-csharp-fetch-option-maxretries-%% Copy Section

• since: v1.46

async method: APIRequestContext.post Copy Chapter

• since: v1.16

• returns: <[APIResponse]>

Sends HTTP(S) POST request and returns its response.
The method will populate request cookies from the context and update
context cookies from the response. The method will automatically follow redirects.

Usage

JSON objects can be passed directly to the request:

await request.post('https://example.com/api/createBook', {
  data: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

Map<String, Object> data = new HashMap();
data.put("title", "Book Title");
data.put("body", "John Doe");
request.post("https://example.com/api/createBook", RequestOptions.create().setData(data));

data = {
    "title": "Book Title",
    "body": "John Doe",
}
api_request_context.post("https://example.com/api/createBook", data=data)

var data = new Dictionary<string, object>() {
  { "firstName", "John" },
  { "lastName", "Doe" }
};
await request.PostAsync("https://example.com/api/createBook", new() { DataObject = data });

To send form data to the server use form option. Its value will be encoded into the request body with application/x-www-form-urlencoded encoding (see below how to use multipart/form-data form encoding to send files):

await request.post('https://example.com/api/findBook', {
  form: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

request.post("https://example.com/api/findBook", RequestOptions.create().setForm(
    FormData.create().set("title", "Book Title").set("body", "John Doe")
));

formData = {
    "title": "Book Title",
    "body": "John Doe",
}
api_request_context.post("https://example.com/api/findBook", form=formData)

var formData = Context.APIRequest.CreateFormData();
formData.Set("title", "Book Title");
formData.Set("body", "John Doe");
await request.PostAsync("https://example.com/api/findBook", new() { Form = formData });

The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data encoding. Use [FormData] to construct request body and pass it to the request as multipart parameter:

const form = new FormData();
form.set('name', 'John');
form.append('name', 'Doe');
// Send two file fields with the same name.
form.append('file', new File(['console.log(2024);'], 'f1.js', { type: 'text/javascript' }));
form.append('file', new File(['hello'], 'f2.txt', { type: 'text/plain' }));
await request.post('https://example.com/api/uploadForm', {
  multipart: form
});

// Pass file path to the form data constructor:
Path file = Paths.get("team.csv");
APIResponse response = request.post("https://example.com/api/uploadTeamList",
  RequestOptions.create().setMultipart(
    FormData.create().set("fileField", file)));

// Or you can pass the file content directly as FilePayload object:
FilePayload filePayload1 = new FilePayload("f1.js", "text/javascript",
      "console.log(2022);".getBytes(StandardCharsets.UTF_8));
APIResponse response = request.post("https://example.com/api/uploadScript",
  RequestOptions.create().setMultipart(
    FormData.create().set("fileField", filePayload)));

api_request_context.post(
  "https://example.com/api/uploadScript'",
  multipart={
    "fileField": {
      "name": "f.js",
      "mimeType": "text/javascript",
      "buffer": b"console.log(2022);",
    },
  })

var file = new FilePayload()
{
    Name = "f.js",
    MimeType = "text/javascript",
    Buffer = System.Text.Encoding.UTF8.GetBytes("console.log(2022);")
};
var multipart = Context.APIRequest.CreateFormData();
multipart.Set("fileField", file);
await request.PostAsync("https://example.com/api/uploadScript", new() { Multipart = multipart });

param: APIRequestContext.post.url = %%-fetch-param-url-%% Copy Section

• since: v1.16

option: APIRequestContext.post.params = %%-js-fetch-option-params-%% Copy Section

• since: v1.16

param: APIRequestContext.post.params = %%-java-fetch-params-%% Copy Section

• since: v1.18

option: APIRequestContext.post.params = %%-python-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.post.params = %%-csharp-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.post.paramsString = %%-csharp-fetch-option-paramsString-%% Copy Section

• since: v1.47

option: APIRequestContext.post.headers = %%-js-python-csharp-fetch-option-headers-%% Copy Section

• since: v1.16

option: APIRequestContext.post.data = %%-js-python-csharp-fetch-option-data-%% Copy Section

• since: v1.16

option: APIRequestContext.post.form = %%-js-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.post.form = %%-python-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.post.form = %%-csharp-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.post.multipart = %%-js-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.post.multipart = %%-python-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.post.multipart = %%-csharp-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.post.timeout = %%-js-python-csharp-fetch-option-timeout-%% Copy Section

• since: v1.16

option: APIRequestContext.post.signal = %%-input-signal-%% Copy Section

option: APIRequestContext.post.failOnStatusCode = %%-js-python-csharp-fetch-option-failonstatuscode-%% Copy Section

• since: v1.16

option: APIRequestContext.post.ignoreHTTPSErrors = %%-js-python-csharp-fetch-option-ignorehttpserrors-%% Copy Section

• since: v1.16

option: APIRequestContext.post.maxRedirects = %%-js-python-csharp-fetch-option-maxredirects-%% Copy Section

• since: v1.26

option: APIRequestContext.post.maxRetries = %%-js-python-csharp-fetch-option-maxretries-%% Copy Section

• since: v1.46

async method: APIRequestContext.put Copy Chapter

• since: v1.16

• returns: <[APIResponse]>

Sends HTTP(S) PUT request and returns its response.
The method will populate request cookies from the context and update
context cookies from the response. The method will automatically follow redirects.

param: APIRequestContext.put.url = %%-fetch-param-url-%% Copy Section

• since: v1.16

option: APIRequestContext.put.params = %%-js-fetch-option-params-%% Copy Section

• since: v1.16

param: APIRequestContext.put.params = %%-java-fetch-params-%% Copy Section

• since: v1.18

option: APIRequestContext.put.params = %%-python-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.put.params = %%-csharp-fetch-option-params-%% Copy Section

• since: v1.16

option: APIRequestContext.put.paramsString = %%-csharp-fetch-option-paramsString-%% Copy Section

• since: v1.47

option: APIRequestContext.put.headers = %%-js-python-csharp-fetch-option-headers-%% Copy Section

• since: v1.16

option: APIRequestContext.put.data = %%-js-python-csharp-fetch-option-data-%% Copy Section

• since: v1.16

option: APIRequestContext.put.form = %%-python-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.put.form = %%-js-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.put.form = %%-csharp-fetch-option-form-%% Copy Section

• since: v1.16

option: APIRequestContext.put.multipart = %%-js-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.put.multipart = %%-python-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.put.multipart = %%-csharp-fetch-option-multipart-%% Copy Section

• since: v1.16

option: APIRequestContext.put.timeout = %%-js-python-csharp-fetch-option-timeout-%% Copy Section

• since: v1.16

option: APIRequestContext.put.signal = %%-input-signal-%% Copy Section

option: APIRequestContext.put.failOnStatusCode = %%-js-python-csharp-fetch-option-failonstatuscode-%% Copy Section

• since: v1.16

option: APIRequestContext.put.ignoreHTTPSErrors = %%-js-python-csharp-fetch-option-ignorehttpserrors-%% Copy Section

• since: v1.16

option: APIRequestContext.put.maxRedirects = %%-js-python-csharp-fetch-option-maxredirects-%% Copy Section

• since: v1.26

option: APIRequestContext.put.maxRetries = %%-js-python-csharp-fetch-option-maxretries-%% Copy Section

• since: v1.46

async method: APIRequestContext.storageState Copy Chapter

• since: v1.16

• returns: <[Object]>
  • cookies <[Array]<[Object]>>
    • name <[string]>
    • value <[string]>
    • domain <[string]>
    • path <[string]>
    • expires <[float]> Unix time in seconds.
    • httpOnly <[boolean]>
    • secure <[boolean]>
    • sameSite <[SameSiteAttribute]<"Strict"|"Lax"|"None">>
  • origins <[Array]<[Object]>>
    • origin <[string]>
    • localStorage <[Array]<[Object]>>
      • name <[string]>
      • value <[string]>

Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.

async method: APIRequestContext.storageState Copy Chapter

• since: v1.16
• langs: java, csharp

• returns: <[string]>

option: APIRequestContext.storageState.path = %%-storagestate-option-path-%% Copy Section

• since: v1.16

option: APIRequestContext.storageState.indexedDB Copy Section

• since: v1.51

• indexedDB ?

Set to true to include IndexedDB in the storage state snapshot.

property: APIRequestContext.tracing Copy Chapter

• since: v1.60

• type: <[Tracing]>

Tracing recorder for requests made through this API request context.

2. Official Technical Reference & Guides (microsoft/microsoft.github.io) Copy Chapter

[microsoft.github.io](https://microsoft.github.io)

Many open source projects released by Microsoft products, services and teams also have
deployments powered by GitHub Pages on this domain.

To discover Microsoft-released open source projects, learn about Microsoft's open source
approach and other information, check us out online at opensource.microsoft.com.

If we can help answer questions about the open source program at Microsoft, you can
contact opensource at microsoft com - although we are not able to provide support
for projects through this mechanism.

Microsoft GitHub resources Copy Chapter

• Default repo templates including SECURITY.MD and code of conduct files: microsoft/repo-templates
• Code of Conduct (FAQ)

Microsoft open source resources Copy Chapter

• Open Source Blog
• The Open Source Show on Channel 9
• https://opensource.microsoft.com/

Resources for Microsoft employees Copy Chapter

• docs.opensource.microsoft.com
• Link your GitHub Account and join GitHub organizations automatically

How to identify an official Microsoft organization on GitHub Copy Chapter

• Official Microsoft GitHub orgs have a professional avatar and include a web address at Microsoft.com or an associated official domain
• Official Microsoft orgs are Verified on GitHub - look for the domain verification indicator on GitHub