New Prompt

post

https://api.repliers.io/nlp

This endpoint translates natural language search queries into structured API requests for the Repliers listings endpoint. For example, the prompt `find me properties in new york`` would be converted to the equivalent API call: https://api.repliers.io/listings?city=New York

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nlpVersion

string

enum

Defaults to 3

NLP Model version

Allowed:

Body Params

prompt

string

required

The natural language prompt to be processed.

nlpId

string

Unique identifier for maintaining context-aware interactions across multiple prompts.

If omitted or blank: A new session is created, and the system processes the prompt independently without any prior context.
If provided: The prompt is added to the existing session associated with the given nlpId, allowing the system to consider the conversation history when generating the API request.

When you send a prompt to the /nlp endpoint, the system returns an nlpId in the response. You can include this nlpId in subsequent requests to build upon previous interactions and maintain continuity within the same conversation thread.

clientId

integer

The clientId of the client that the NLP prompt is for. Must be an existing client in your account, otherwise a 404 error is returned.

listings

boolean

Defaults to false

If true, the endpoint will return listings according to the generated urlQueryString parameters, the same way as GET /lisitngs endpoint would treat those parameters. Default is false.

boardId

integer

≥ 1

Restricts the prompt to a single board. Only relevant for API keys with access to multiple boards.

The NLP model uses the acceptable values (aggregates) of the boards available to your API key when translating a prompt. On a multi-board key, values from several boards are combined, which can result in a generated query that uses a value belonging to a different board. Supplying boardId narrows the model to that one board, so the values it produces are always valid for it.

If the supplied boardId is not accessible with your API key, a 403 response is returned.

fields

string

Use if you want to limit the listings response object to containing certain fields only. For example: fields=listPrice,soldPrice would limit the response to contain listPrice and soldPrice only. You can also specify the amount of images to return, for example if a listing has 40 images total and you specify fields=images[5] it will only return the first 5 images.

useLocationId

boolean

Defaults to false

When set to true, any locations identified in the prompt will be returned as locationId values instead of being split into separate area, city, and neighborhood parameters.

locationsSource

array of objects

Specify which location sources to use when interpreting the prompt. This can help improve accuracy by providing the NLP model with the location data source most suitable for the query.

MLS - Locations sourced from MLS (Multiple Listing Service) data.
UserDefined - Custom locations created and defined by users.
LiveBy - Locations sourced from LiveBy, a third-party neighborhood and community data provider.
PublicRecord - Locations sourced from Public Records Data.

locationsSource

Allowed:

Responses

400

Bad Request - Invalid input.

403

Forbidden - returned when either:

your account does not have access to the NLP feature, or
the supplied boardId is not accessible with your API key.

404

Not Found - the supplied clientId does not exist in your account, or the supplied nlpId does not match an existing session.

406

Not accepted - If the input is not relevant to a listings search a 406 response will be returned. For example, "why is the sky blue" would return a 406 response.

500

Internal Server Error - An error occurred while processing the request.

200Successful response with processed data.

401The API key was not recognized by the API server, or the key is not active.