Skip to content

capture_page_screenshot

Capture one published page and return an inline PNG plus a temporary artifact link.

Pass application_session (a consumer access token of this application) to capture the page as that signed-in consumer; it is validated against the persisted session. See https://docs.merofoundry.app/recipes/tool-capture-page-screenshot for the artifact lifetime and the viewport presets.

{
"additionalProperties": false,
"properties": {
"application_id": {
"format": "uuid",
"type": "string"
},
"application_session": {
"type": [
"string",
"null"
],
"writeOnly": true
},
"full_page": {
"type": [
"boolean",
"null"
]
},
"page_id": {
"format": "uuid",
"type": [
"string",
"null"
]
},
"path": {
"type": [
"string",
"null"
]
},
"viewport": {
"enum": [
"desktop",
"mobile",
null
],
"type": [
"string",
"null"
]
}
},
"required": [
"application_id"
],
"type": "object"
}
{
"additionalProperties": false,
"properties": {
"artifact_link": {
"format": "uri",
"type": "string"
},
"result": {
"type": "object"
}
},
"required": [
"result"
],
"type": "object"
}