Back to All Demos

Apartment Hunting Demo

Watch our AI agent find rental properties matching your criteria

1

Task Setup

Create a new task or use an existing Task ID

API Request Preview

POST /api/tasks
Content-Type: application/json

{
  "task": "Find me available-to-rent flats in Edinburgh with 3 bedrooms below £2000. Give me the address, description, and link to more information. Just search flats that are let by the Southside Management agency (https://southsidemanagement.com/), you don't need to check any other sites. All the information you need is available on the Southside Management site alone. As soon as you've found the list of 3 bedroom flats, your task is complete.",
  "website": "https://southsidemanagement.com/",
  "input_schema": {
    "type": "object",
    "properties": {
      "num_bedrooms_min": {"type": "integer"},
      "num_bedrooms_max": {"type": "integer"}, 
      "max_rent_cost": {"type": "number"}
    }
  },
  "output_schema": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "property_id": {"type": "string"},
        "address": {"type": "string"},
        "description": {"type": "string"},
        "bedrooms": {"type": "integer"},
        "bathrooms": {"type": "integer"},
        "rental_cost": {"type": "number"},
        "cost_period": {"type": "string"},
        "available_to_rent_from": {"type": "string"}
      }
    }
  }
}

End-to-End API Workflow

Step 1 - Task Creation (POST /tasks): Define the scraping task and target website. There will be a delay before the task is ready for usage, while our platform analyses the site to create a reusable task.

Step 2 - Task Execution (POST /runs): Execute the created task with specific search parameters.

Step 3 - Results Processing: Structured data is returned via the API, which you can process as appropriate.

💡 Pro Tip: Tasks are reusable! Once created, you can execute them multiple times with different parameters.