For the complete documentation index, see llms.txt. This page is also available as Markdown.

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). All other fields are optional and must be requested via the options.fields parameter. See Optional Responses 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.

Last updated