> For the complete documentation index, see [llms.txt](https://help.supplyd.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.supplyd.co/api/request-response-pagination-and-error-formats.md).

# Request, Response, Pagination, and Error formats

Supply'd's API exchanges data in JSON format, where:

1. all requests should include an `Accept: application/json` header
2. all responses will include a `Content-Type: application/json` header

POST/PUT requests expect JSON in the HTTP message body, and you must specify the `Content-Type` header in your request.

## Pagination

If an API call requires pagination the response will include a link header for the next page of results:

`Link: </v1/path/to/resource?page=X>; rel=next`

The final page of results will not have a link header.

## Errors

Depending on your request's `Accept` header, the error will be returned as plain-text or JSON.

Plain-text errors are just the message as a string.

JSON errors return the message, and may include  the following format:

```
{
    "error": "<message>",
    "data": null|object
}
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.supplyd.co/api/request-response-pagination-and-error-formats.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
