> For the complete documentation index, see [llms.txt](https://docs.vsat.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vsat.dev/reference/envelope.md).

# Response envelope

Every solve returns JSON. On success `ok` is `true` and the surface-specific fields carry the result; on failure `ok` is `false` with a machine-readable `code`.

## Success

| field     | endpoints    | meaning                                                         |
| --------- | ------------ | --------------------------------------------------------------- |
| `ok`      | all          | `true`                                                          |
| `payload` | all          | the string to submit to DataDome (form body, or tags body)      |
| `headers` | interstitial | client-hint headers to replay on the target                     |
| `plv3`    | slider       | the `plv3` value to submit with the payload to `/captcha/check` |

## Failure

```json
{ "ok": false, "code": "…", "retryable": false, "error": "…" }
```

Retry **only** when `retryable` is `true`. See [Errors & retries](/reference/errors.md) for the code table.

## The headers rule

When an endpoint returns a `headers` object, replay those exact headers on your request to the target. They describe the same browser as the payload; hardcoding or omitting them contradicts the payload and is a common block cause. See [Integration tips](/reference/tips.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.vsat.dev/reference/envelope.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.