{"openapi":"3.1.0","info":{"title":"URLpipe API","version":"1","summary":"Turn any URL into clean data: Markdown, HTML, screenshots, PDFs, metadata, summaries, keywords, structured extraction, Lighthouse, console output and the technologies it is built with.","description":"Every endpoint takes a JSON body with a `url`. Requests are asynchronous by default: the response is a token, and the result is delivered to `report_to` (or the project's default webhook) and can be fetched with GET /result/{token}. Send `sync: true` to get the result in the response instead. Full documentation: https://urlpipe.dev/docs","contact":{"email":"contact@urlpipe.dev","url":"https://urlpipe.dev"},"termsOfService":"https://urlpipe.dev/terms"},"servers":[{"url":"https://urlpipe.dev"}],"externalDocs":{"url":"https://urlpipe.dev/docs"},"security":[{"bearerAuth":[]}],"paths":{"/html":{"post":{"operationId":"html","summary":"Rendered HTML of a page","description":"1 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/html","externalDocs":{"url":"https://urlpipe.dev/docs/html"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/Accepted"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/screenshot":{"post":{"operationId":"screenshot","summary":"Screenshot of a page","description":"1 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/screenshot","externalDocs":{"url":"https://urlpipe.dev/docs/screenshot"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenshotRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"text/plain":{"schema":{"type":"string","contentEncoding":"base64","description":"The image, Base64-encoded."}},"application/json":{"schema":{"$ref":"#/components/schemas/Accepted"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/markdown":{"post":{"operationId":"markdown","summary":"A page's main content as Markdown","description":"1 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/markdown","externalDocs":{"url":"https://urlpipe.dev/docs/markdown"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/Accepted"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/meta":{"post":{"operationId":"meta","summary":"A page's metadata","description":"1 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/meta","externalDocs":{"url":"https://urlpipe.dev/docs/meta"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/summarize":{"post":{"operationId":"summarize","summary":"AI summary of a page","description":"17 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/summarize","externalDocs":{"url":"https://urlpipe.dev/docs/summarize"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"$ref":"#/components/schemas/Accepted"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/keywords":{"post":{"operationId":"keywords","summary":"Keywords of a page","description":"15 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/keywords","externalDocs":{"url":"https://urlpipe.dev/docs/keywords"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/lighthouse":{"post":{"operationId":"lighthouse","summary":"Lighthouse audit of a page","description":"2 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/lighthouse","externalDocs":{"url":"https://urlpipe.dev/docs/lighthouse"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LighthouseRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LighthouseResult"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/console":{"post":{"operationId":"console","summary":"JavaScript console output of a page","description":"1 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/console","externalDocs":{"url":"https://urlpipe.dev/docs/console"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConsoleEntry"}}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/technologies":{"post":{"operationId":"technologies","summary":"Technologies a page is built with","description":"1 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/technologies","externalDocs":{"url":"https://urlpipe.dev/docs/technologies"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Technologies"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/pdf":{"post":{"operationId":"pdf","summary":"A page as a PDF","description":"1 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/pdf","externalDocs":{"url":"https://urlpipe.dev/docs/pdf"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PdfRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"text/plain":{"schema":{"type":"string","contentEncoding":"base64","contentMediaType":"application/pdf","description":"The PDF, Base64-encoded."}},"application/json":{"schema":{"$ref":"#/components/schemas/Accepted"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/extract":{"post":{"operationId":"extract","summary":"Structured data from a page, in a schema you define","description":"24 credit(s) per successful, uncached call. Documentation: https://urlpipe.dev/docs/extract","externalDocs":{"url":"https://urlpipe.dev/docs/extract"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extraction"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/scrape":{"post":{"operationId":"scrape","summary":"Several operations from one page visit","description":"The sum of the operations it runs. Documentation: https://urlpipe.dev/docs/scrape","externalDocs":{"url":"https://urlpipe.dev/docs/scrape"},"parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeRequest"}}}},"responses":{"200":{"description":"With `sync: true`, the result. Without it, the request was accepted: a token to collect the result with.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeResult"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is valid, but the email address on the account hasn't been confirmed yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The URL or an option is invalid, or the page could not be fetched (the error says which). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the plan's parallel-request limit (`concurrency_limit`), sending too fast (`rate_limited`), or — Free plan only — out of credits (`quota_exceeded`). Spends nothing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A sync request took longer than 60 seconds; the work continues — collect it with GET /result/{token}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/result/{token}":{"get":{"operationId":"getResult","summary":"Collect a result by its token","description":"Results are kept for 30 days. Documentation: https://urlpipe.dev/docs/results","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The result, in the operation's own format — the same body a sync request returns.","headers":{"X-Result-Token":{"description":"The request's token, for GET /result/{token}.","schema":{"type":"string"}},"X-Cache":{"description":"`hit` or `miss`.","schema":{"type":"string"}},"X-Final-Url":{"description":"The address the page ended on, after its redirects.","schema":{"type":"string"}},"X-Quota-Cost":{"description":"Credits this request spent.","schema":{"type":"integer"}},"X-Quota-Limit":{"description":"The monthly credit allowance included in the plan.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Remaining":{"description":"Credits left of that allowance, after this request.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}},"X-Quota-Overage":{"description":"Credits spent beyond the allowance this month: 0 until it runs out, uncapped after.","schema":{"type":"integer"}},"X-Quota-Reset":{"description":"When the monthly period rolls over.","schema":{"type":"string","format":"date-time"}},"X-Concurrency-Limit":{"description":"Requests this plan may run in parallel.","schema":{"oneOf":[{"type":"integer"},{"type":"string","enum":["unlimited"]}]}}}},"202":{"description":"Still being generated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Processing"}}}},"404":{"description":"No result for this token under this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"The result is older than 30 days.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The analysis ran and failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/auth_profiles":{"get":{"operationId":"listAuthProfiles","summary":"List the project's auth profiles","externalDocs":{"url":"https://urlpipe.dev/docs/auth-profiles"},"responses":{"200":{"description":"Every auth profile of the project.","content":{"application/json":{"schema":{"type":"object","properties":{"auth_profiles":{"type":"array","items":{"$ref":"#/components/schemas/AuthProfile"}}}}}}}}},"post":{"operationId":"createAuthProfile","summary":"Upload a signed-in visitor's state","description":"Upload once what a browser holds after logging in, then name the profile's id as `auth_profile` on any request. Documentation: https://urlpipe.dev/docs/auth-profiles","externalDocs":{"url":"https://urlpipe.dev/docs/auth-profiles"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProfileRequest"}}}},"responses":{"201":{"description":"The profile. Its state is never returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProfile"}}}},"422":{"description":"The state or the domains are invalid (`invalid_auth_profile`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/auth_profiles/{id}":{"get":{"operationId":"getAuthProfile","summary":"Read an auth profile","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The profile's id, ap_…"}],"responses":{"200":{"description":"The profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProfile"}}}},"404":{"description":"No auth profile with this id under this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"updateAuthProfile","summary":"Rename an auth profile, change its domains, or replace its state","description":"A new storage_state starts a new session: results stored under the old one are deleted.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The profile's id, ap_…"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":100},"storage_state":{"oneOf":[{"$ref":"#/components/schemas/StorageState"},{"type":"string"}],"description":"What Playwright's storageState() writes, as an object or as the file's contents."},"domains":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"The hosts the profile is used for, each with the hosts under it. Default: the one site the state holds cookies for; required when it holds several."}}}}}},"responses":{"200":{"description":"The profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProfile"}}}},"404":{"description":"No auth profile with this id under this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The state or the domains are invalid (`invalid_auth_profile`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteAuthProfile","summary":"Delete an auth profile and the results stored for it","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The profile's id, ap_…"}],"responses":{"204":{"description":"Deleted."},"404":{"description":"No auth profile with this id under this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A project API key."}},"parameters":{"IdempotencyKey":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string"},"description":"Makes a retry safe: the same key returns the first request's token and result instead of running again. https://urlpipe.dev/docs/retries"}},"schemas":{"PageRequest":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"The page to fetch: a public http(s) URL."},"sync":{"type":"boolean","default":false,"description":"Return the result in the response instead of a token."},"report_to":{"type":"string","format":"uri","description":"Webhook URL the result is POSTed to (async requests)."},"max_age":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"How fresh a cached result must be: seconds, or a duration like \"3 days\". Default 7 days, maximum 30; 0 bypasses the cache."},"labels":{"type":"object","maxProperties":16,"additionalProperties":{"type":"string","maxLength":256},"description":"Your own ids for this request, returned with the result and the webhook."},"residential":{"type":"boolean","default":false,"description":"Fetch from a home broadband address. +25 credits per page visit."},"auth_profile":{"type":"string","description":"Visit the page as this auth profile's signed-in visitor (its id, ap_…). https://urlpipe.dev/docs/auth-profiles"},"page_options":{"$ref":"#/components/schemas/PageOptions"}}},"ScreenshotRequest":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"The page to fetch: a public http(s) URL."},"sync":{"type":"boolean","default":false,"description":"Return the result in the response instead of a token."},"report_to":{"type":"string","format":"uri","description":"Webhook URL the result is POSTed to (async requests)."},"max_age":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"How fresh a cached result must be: seconds, or a duration like \"3 days\". Default 7 days, maximum 30; 0 bypasses the cache."},"labels":{"type":"object","maxProperties":16,"additionalProperties":{"type":"string","maxLength":256},"description":"Your own ids for this request, returned with the result and the webhook."},"residential":{"type":"boolean","default":false,"description":"Fetch from a home broadband address. +25 credits per page visit."},"auth_profile":{"type":"string","description":"Visit the page as this auth profile's signed-in visitor (its id, ap_…). https://urlpipe.dev/docs/auth-profiles"},"page_options":{"$ref":"#/components/schemas/PageOptions"},"screenshot_options":{"$ref":"#/components/schemas/ScreenshotOptions"}}},"PdfRequest":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"The page to fetch: a public http(s) URL."},"sync":{"type":"boolean","default":false,"description":"Return the result in the response instead of a token."},"report_to":{"type":"string","format":"uri","description":"Webhook URL the result is POSTed to (async requests)."},"max_age":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"How fresh a cached result must be: seconds, or a duration like \"3 days\". Default 7 days, maximum 30; 0 bypasses the cache."},"labels":{"type":"object","maxProperties":16,"additionalProperties":{"type":"string","maxLength":256},"description":"Your own ids for this request, returned with the result and the webhook."},"residential":{"type":"boolean","default":false,"description":"Fetch from a home broadband address. +25 credits per page visit."},"auth_profile":{"type":"string","description":"Visit the page as this auth profile's signed-in visitor (its id, ap_…). https://urlpipe.dev/docs/auth-profiles"},"page_options":{"$ref":"#/components/schemas/PageOptions"},"pdf_options":{"$ref":"#/components/schemas/PdfOptions"}}},"ExtractRequest":{"type":"object","required":["url","fields"],"properties":{"url":{"type":"string","format":"uri","description":"The page to fetch: a public http(s) URL."},"sync":{"type":"boolean","default":false,"description":"Return the result in the response instead of a token."},"report_to":{"type":"string","format":"uri","description":"Webhook URL the result is POSTed to (async requests)."},"max_age":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"How fresh a cached result must be: seconds, or a duration like \"3 days\". Default 7 days, maximum 30; 0 bypasses the cache."},"labels":{"type":"object","maxProperties":16,"additionalProperties":{"type":"string","maxLength":256},"description":"Your own ids for this request, returned with the result and the webhook."},"residential":{"type":"boolean","default":false,"description":"Fetch from a home broadband address. +25 credits per page visit."},"auth_profile":{"type":"string","description":"Visit the page as this auth profile's signed-in visitor (its id, ap_…). https://urlpipe.dev/docs/auth-profiles"},"page_options":{"$ref":"#/components/schemas/PageOptions"},"fields":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ExtractField"},"description":"The fields to extract, at most 50 in all."},"instructions":{"type":"string","maxLength":1000,"description":"Guidance that applies to every field."}}},"ExtractField":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]{0,63}$","description":"The key in the result."},"type":{"type":"string","enum":["string","number","integer","boolean","date","datetime","url","email","object","array"]},"description":{"type":"string","maxLength":300,"description":"What to take from the page."},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ExtractField"},"description":"An object's fields."},"items":{"description":"What an array holds: a type name, or a field without a name.","oneOf":[{"type":"string","enum":["string","number","integer","boolean","date","datetime","url","email","object"]},{"$ref":"#/components/schemas/ExtractField"}]}}},"Extraction":{"type":"object","additionalProperties":true,"description":"One key per requested field, in the order requested. A value the page does not give is null."},"LighthouseRequest":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"The page to fetch: a public http(s) URL."},"sync":{"type":"boolean","default":false,"description":"Return the result in the response instead of a token."},"report_to":{"type":"string","format":"uri","description":"Webhook URL the result is POSTed to (async requests)."},"max_age":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"How fresh a cached result must be: seconds, or a duration like \"3 days\". Default 7 days, maximum 30; 0 bypasses the cache."},"labels":{"type":"object","maxProperties":16,"additionalProperties":{"type":"string","maxLength":256},"description":"Your own ids for this request, returned with the result and the webhook."},"residential":{"type":"boolean","default":false,"description":"Fetch from a home broadband address. +25 credits per page visit."},"device":{"type":"string","enum":["mobile","desktop"],"default":"mobile"},"include_audits":{"oneOf":[{"type":"boolean"},{"type":"string"}],"default":false,"description":"Include the full audits object."}}},"ScrapeRequest":{"type":"object","required":["url","operations"],"properties":{"url":{"type":"string","format":"uri","description":"The page to fetch: a public http(s) URL."},"sync":{"type":"boolean","default":false,"description":"Return the result in the response instead of a token."},"report_to":{"type":"string","format":"uri","description":"Webhook URL the result is POSTed to (async requests)."},"max_age":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"How fresh a cached result must be: seconds, or a duration like \"3 days\". Default 7 days, maximum 30; 0 bypasses the cache."},"labels":{"type":"object","maxProperties":16,"additionalProperties":{"type":"string","maxLength":256},"description":"Your own ids for this request, returned with the result and the webhook."},"residential":{"type":"boolean","default":false,"description":"Fetch from a home broadband address. +25 credits per page visit."},"auth_profile":{"type":"string","description":"Visit the page as this auth profile's signed-in visitor (its id, ap_…). https://urlpipe.dev/docs/auth-profiles"},"page_options":{"$ref":"#/components/schemas/PageOptions"},"operations":{"type":"array","minItems":1,"items":{"type":"string","enum":["html","screenshot","markdown","meta","summarize","keywords","lighthouse","console","technologies","pdf","extract"]}},"screenshot_options":{"$ref":"#/components/schemas/ScreenshotOptions"},"pdf_options":{"$ref":"#/components/schemas/PdfOptions"},"device":{"type":"string","enum":["mobile","desktop"],"default":"mobile"},"include_audits":{"oneOf":[{"type":"boolean"},{"type":"string"}],"default":false,"description":"Include the full audits object."},"fields":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ExtractField"},"description":"The fields to extract, at most 50 in all."},"instructions":{"type":"string","maxLength":1000,"description":"Guidance that applies to every field."}}},"PageOptions":{"type":"object","properties":{"wait_for_selector":{"type":"string","description":"Wait for this CSS selector, up to 10 seconds."},"scroll_to_bottom":{"type":"boolean","default":false,"description":"Scroll down the page before reading it, for as long as scrolling loads more, up to 25 seconds."},"delay":{"type":"integer","minimum":0,"maximum":10000,"description":"Milliseconds to wait after the page settles."},"block_ads":{"type":"boolean","default":false},"block_cookie_banners":{"type":"boolean","default":false},"block_popups":{"type":"boolean","default":false,"description":"Remove newsletter, app-install and promotional popups laid over the page."},"remove_selectors":{"type":"array","items":{"type":"string"},"maxItems":50}}},"ScreenshotOptions":{"type":"object","properties":{"full_page":{"type":"boolean","default":true},"full_page_max_height":{"type":"integer","minimum":100,"maximum":16384},"viewport_width":{"type":"integer","minimum":320,"maximum":1920,"default":1350},"viewport_height":{"type":"integer","minimum":240,"maximum":1080,"default":797},"device_scale_factor":{"type":"integer","minimum":1,"maximum":3,"default":1},"selector":{"type":"string","description":"Capture only this element."},"format":{"type":"string","enum":["png","jpeg","webp"],"default":"png"},"quality":{"type":"integer","minimum":1,"maximum":100,"default":80,"description":"JPEG and WebP only."},"omit_background":{"type":"boolean","default":false},"dark_mode":{"type":"boolean","default":false},"hide_selectors":{"type":"array","items":{"type":"string"},"maxItems":50},"styles":{"type":"string","maxLength":20000,"description":"CSS injected before the capture."}}},"PdfOptions":{"type":"object","properties":{"paper_size":{"type":"string","enum":["letter","legal","tabloid","a3","a4","a5"],"default":"a4"},"landscape":{"type":"boolean","default":false},"print_background":{"type":"boolean","default":true},"scale":{"type":"integer","minimum":10,"maximum":200,"default":100,"description":"Percent."},"margin":{"type":"integer","minimum":0,"maximum":50,"default":10,"description":"Millimetres, every side."},"media":{"type":"string","enum":["print","screen"],"default":"print","description":"print uses the page's print stylesheet; screen prints it as a browser shows it."},"single_page":{"type":"boolean","default":false,"description":"One page as wide as the window and as tall as the document, instead of sheets."}}},"AuthProfileRequest":{"type":"object","required":["name","storage_state"],"properties":{"name":{"type":"string","maxLength":100},"storage_state":{"oneOf":[{"$ref":"#/components/schemas/StorageState"},{"type":"string"}],"description":"What Playwright's storageState() writes, as an object or as the file's contents."},"domains":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"The hosts the profile is used for, each with the hosts under it. Default: the one site the state holds cookies for; required when it holds several."}}},"AuthProfile":{"type":"object","required":["id","name","domains","signed_out_at","last_used_at","state_updated_at","created_at"],"properties":{"id":{"type":"string","description":"What a request names as auth_profile."},"name":{"type":"string"},"domains":{"type":"array","items":{"type":"string"}},"signed_out_at":{"type":["string","null"],"format":"date-time","description":"When a visit made as this profile was last met with a sign-in form instead of the page."},"last_used_at":{"type":["string","null"],"format":"date-time"},"state_updated_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"}}},"StorageState":{"type":"object","properties":{"cookies":{"type":"array","maxItems":500,"items":{"type":"object","required":["name","value","domain"],"properties":{"name":{"type":"string"},"value":{"type":"string"},"domain":{"type":"string"},"path":{"type":"string"},"expires":{"type":"number","description":"Seconds since the epoch; -1 for a session cookie."},"httpOnly":{"type":"boolean"},"secure":{"type":"boolean"},"sameSite":{"type":"string","enum":["Strict","Lax","None"]}}}},"origins":{"type":"array","maxItems":20,"items":{"type":"object","required":["origin"],"properties":{"origin":{"type":"string"},"localStorage":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}}},"Accepted":{"type":"object","required":["token","status"],"properties":{"token":{"type":"string"},"status":{"type":"string","const":"accepted"},"labels":{"type":"object"}}},"Processing":{"type":"object","required":["token","status"],"properties":{"token":{"type":"string"},"status":{"type":"string","const":"processing"},"labels":{"type":"object"}}},"Error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"token":{"type":"string"}}},"Metadata":{"type":"object","required":["final_url","canonical_url","title","description","site_name","type","language","locale","authors","published_at","modified_at","image","video","favicon_url","icons","logo_url","feeds","keywords","theme_color","generator","manifest_url","robots","open_graph","twitter","alternates","oembed_url","structured_data_types"],"additionalProperties":false,"properties":{"final_url":{"type":["string","null"],"description":"The address the page ended on, after its redirects."},"canonical_url":{"type":["string","null"],"description":"The page's canonical URL, absolute."},"title":{"type":["string","null"],"description":"The page's own title, without the site's name around it."},"description":{"type":["string","null"]},"site_name":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["article","website","profile","book","product","video","music","place","event","recipe",null],"description":"The kind of page, as the page declares it."},"language":{"type":["string","null"],"description":"ISO 639-1 code of the language the content is written in."},"locale":{"type":["string","null"],"description":"The most specific language tag the page declares for that language, BCP 47 (en-US)."},"authors":{"type":"array","items":{"type":"object","required":["name","url","profiles"],"additionalProperties":false,"properties":{"name":{"type":"string"},"url":{"type":["string","null"]},"profiles":{"type":"array","items":{"type":"string"}}}}},"published_at":{"type":["string","null"],"description":"ISO 8601: a date (2024-05-01) or a moment with its offset."},"modified_at":{"type":["string","null"],"description":"ISO 8601, as published_at."},"image":{"type":["object","null"],"required":["url","width","height","alt","type"],"additionalProperties":false,"properties":{"url":{"type":"string"},"width":{"type":["integer","null"]},"height":{"type":["integer","null"]},"alt":{"type":["string","null"]},"type":{"type":["string","null"]}}},"video":{"type":["object","null"],"required":["url","type","width","height"],"additionalProperties":false,"properties":{"url":{"type":"string"},"type":{"type":["string","null"]},"width":{"type":["integer","null"]},"height":{"type":["integer","null"]}}},"favicon_url":{"type":["string","null"]},"icons":{"type":"array","items":{"type":"object","required":["url","rel","sizes","type"],"additionalProperties":false,"properties":{"url":{"type":"string"},"rel":{"type":"string"},"sizes":{"type":["string","null"]},"type":{"type":["string","null"]}}}},"logo_url":{"type":["string","null"]},"feeds":{"type":"array","items":{"type":"object","required":["url","type","title"],"additionalProperties":false,"properties":{"url":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]}}}},"keywords":{"type":"array","items":{"type":"string"}},"theme_color":{"type":["string","null"]},"generator":{"type":["string","null"]},"manifest_url":{"type":["string","null"]},"robots":{"type":"object","required":["index","follow"],"additionalProperties":false,"properties":{"index":{"type":"boolean"},"follow":{"type":"boolean"}}},"open_graph":{"type":"object","required":["title","description","image","url","type","site_name","locale"],"additionalProperties":false,"properties":{"title":{"type":["string","null"]},"description":{"type":["string","null"]},"image":{"type":["string","null"]},"url":{"type":["string","null"]},"type":{"type":["string","null"]},"site_name":{"type":["string","null"]},"locale":{"type":["string","null"]}},"description":"The page's og: tags as declared."},"twitter":{"type":"object","required":["card","site","creator","title","description","image"],"additionalProperties":false,"properties":{"card":{"type":["string","null"]},"site":{"type":["string","null"]},"creator":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"image":{"type":["string","null"]}},"description":"The page's twitter: tags as declared."},"alternates":{"type":"array","items":{"type":"object","required":["hreflang","url"],"additionalProperties":false,"properties":{"hreflang":{"type":"string"},"url":{"type":"string"}}}},"oembed_url":{"type":["string","null"]},"structured_data_types":{"type":"array","items":{"type":"string"}}}},"Technologies":{"type":"object","required":["final_url","technologies"],"additionalProperties":false,"properties":{"final_url":{"type":["string","null"],"description":"The address the page ended on, after its redirects."},"technologies":{"type":"array","items":{"type":"object","required":["name","slug","version","confidence","categories","website","description","cpe","detected_by","implied_by"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"The technology's name, e.g. WordPress."},"slug":{"type":"string","description":"A stable identifier for the technology, e.g. wordpress."},"version":{"type":["string","null"],"description":"The version, when the page gives it away."},"confidence":{"type":"integer","minimum":0,"maximum":100,"description":"How sure the detection is, 0–100. Most are 100."},"categories":{"type":"array","items":{"type":"object","required":["slug","name"],"additionalProperties":false,"properties":{"slug":{"type":"string"},"name":{"type":"string"}}}},"website":{"type":["string","null"]},"description":{"type":["string","null"]},"cpe":{"type":["string","null"],"description":"The CPE 2.3 name, for looking the technology up in vulnerability databases."},"detected_by":{"type":"array","items":{"type":"string"},"description":"Which signals gave it away: html, meta, headers, cookies, js, dom, script_src, scripts, css, text, url, xhr, cert_issuer, dns, robots. Empty for a technology only implied by another."},"implied_by":{"type":"array","items":{"type":"string"},"description":"The detected technologies that imply this one (WordPress implies PHP)."}}},"description":"Every technology detected, most certain first."}}},"ConsoleEntry":{"type":"object","properties":{"type":{"type":"string","enum":["error","warning","exception"]},"text":{"type":"string"}}},"LighthouseResult":{"type":"object","properties":{"url":{"type":"string"},"fetchTime":{"type":"string"},"device":{"type":"string"},"categories":{"type":"object"},"metrics":{"type":"object"},"audits":{"type":"object"}}},"ScrapeResult":{"type":"object","properties":{"url":{"type":"string"},"final_url":{"type":["string","null"],"description":"The address the page ended on, after its redirects."},"operations":{"type":"object","description":"One key per operation requested, in the order asked for.","additionalProperties":{"type":"object","properties":{"success":{"type":"boolean"},"result":{},"error":{"type":"string"},"cached":{"type":"boolean"}}}}}}}}}