# Response

Your response will be a JSON object.

Every successful response will include a `placekey` and a `query_id`. If matching fails, the response will contain an `error` field instead (see [Error Codes](/documentation/api-overview/error-codes.md)). All other fields are optional and must be requested via the `options.fields` parameter. See [Optional Responses](/documentation/placekey-api/response/optional-responses.md) for details.

When accessing the /placekey endpoint, your response will contain the following:

| Field     | Description                                                                          | Example               |
| --------- | ------------------------------------------------------------------------------------ | --------------------- |
| query\_id | An ID for this query. If you passed in a `query_id` this will be echoed back to you. | 4                     |
| placekey  | The Placekey for the request you make                                                | `227-223@5vg-82n-pgk` |

When accessing the /placekeys endpoint, your response will be a list of the above.


---

# Agent Instructions: 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:

```
GET https://docs.placekey.io/documentation/placekey-api/response.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
