> **For AI agents:** this page is a focused, LLM-optimized view of a
> single Fiber AI operation. Before calling it, fetch the routing
> instructions at [`https://api.fiber.ai/llms.txt`](https://api.fiber.ai/llms.txt) and the full operation
> index at [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md).

# fetchRealEstateListings

`POST /v1/real-estate/listings`

**Tags:** `Market intelligence`

Fetch real estate listings

**Endpoint:** `https://api.fiber.ai/v1/real-estate/listings`

## Description

Fetches real estate listings by location and optional filters such as listing status, price ranges, home types, and property features. Data is available for all 50 US states, D.C., Puerto Rico, and all 13 Canadian provinces and territories.

⚡ Rate limit: 300 requests per 1 minute

💰 Cost: 2 credits per page of results ⓘ

⏱ Recommended timeout: 30 seconds ⓘ

## Request body (JSON Schema)

```json
{
  "type": "object",
  "properties": {
    "apiKey": {
      "type": "string",
      "description": "Your Fiber API key"
    },
    "location": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "raw"
              ]
            },
            "rawQuery": {
              "type": "string",
              "minLength": 1,
              "description": "Free-form location text. Accepts city, city + state/province, ZIP/postal code, or full address (e.g., 'Toronto, ON', 'Brooklyn NY', '10001', 'Trois-Rivières, QC'). Resolved via geocoding to a city + state/province before searching."
            }
          },
          "required": [
            "type",
            "rawQuery"
          ]
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "structured"
              ]
            },
            "city": {
              "type": "string",
              "minLength": 1,
              "description": "City name (e.g., 'Toronto', 'Trois-Rivières')."
            },
            "stateCode": {
              "type": "string",
              "pattern": "^[A-Za-z]{2}$",
              "description": "Two-letter US state code or Canadian province code (e.g., 'NY', 'CA', 'QC', 'ON')."
            }
          },
          "required": [
            "type",
            "city",
            "stateCode"
          ]
        }
      ],
      "description": "Location input for listing search. Use `raw` for user-provided text and `structured` for exact city/state precision."
    },
    "nextPageToken": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "description": "Pagination token from a previous response. Omit for the first page."
    },
    "sortBy": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "relevance",
        "newest",
        "priceAscending",
        "priceDescending",
        "paymentAscending",
        "paymentDescending",
        "bedroomCountDescending",
        "bathroomCountDescending",
        "floorAreaSqFtDescending",
        "lotAreaSqFtDescending",
        "estimatedPriceDescending",
        "estimatedPriceAscending",
        null
      ],
      "description": "Sort order for search results."
    },
    "listingStatus": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "forSale",
        "forRent",
        "sold",
        null
      ],
      "description": "Listing category to search."
    },
    "homeTypes": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string",
        "enum": [
          "house",
          "condo",
          "townhouse",
          "multi_family",
          "apartment",
          "land",
          "manufactured"
        ]
      },
      "description": "Property types to include."
    },
    "price": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "min": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        },
        "max": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        }
      },
      "description": "Price range filter for sale and sold listings. Values must use the local market currency for the location (for example, CAD for Canada and USD for the United States)."
    },
    "rent": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "min": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        },
        "max": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        }
      },
      "description": "Monthly rent range filter for rental listings. Values must use the local market currency for the location (for example, CAD for Canada and USD for the United States)."
    },
    "bedrooms": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "min": {
          "type": "integer",
          "minimum": 1,
          "maximum": 5
        }
      },
      "required": [
        "min"
      ],
      "description": "Bedroom count filter. Use `min` to set the lower bound."
    },
    "bathrooms": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "min": {
          "type": "number",
          "minimum": 1,
          "maximum": 4
        }
      },
      "required": [
        "min"
      ],
      "description": "Bathroom count filter. Use `min` to set the lower bound."
    },
    "floorAreaSqFt": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "min": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        },
        "max": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        }
      },
      "description": "Interior living-area range in square feet."
    },
    "lotAreaSqFt": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "min": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        },
        "max": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        }
      },
      "description": "Lot-size range in square feet."
    },
    "yearBuilt": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "min": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1800
        },
        "max": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1800
        }
      },
      "description": "Year-built range."
    },
    "parkingSpots": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "min": {
          "type": "integer",
          "minimum": 1,
          "description": "Minimum number of parking spots."
        }
      },
      "required": [
        "min"
      ],
      "description": "Parking spots filter."
    },
    "keywords": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "description": "Additional keyword terms to match in listing text. For broader matching, separate terms with commas (for example: 'pool,garage')."
    },
    "features": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "hasPool": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "hasGarage": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "hasAirConditioning": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "isWaterfront": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "isSingleStory": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "hasOpenHouse": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "includeUnderContract": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "description": "Optional property feature filters."
    }
  },
  "required": [
    "apiKey",
    "location"
  ]
}
```

## Response — success (JSON Schema)

```json
{
  "type": "object",
  "properties": {
    "output": {
      "type": "object",
      "properties": {
        "runId": {
          "type": "string",
          "description": "Unique identifier for this search request."
        },
        "totalResultCount": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Total number of matching listings."
        },
        "regionName": {
          "type": [
            "string",
            "null"
          ],
          "description": "Region name interpreted for this search query."
        },
        "nextPageToken": {
          "type": [
            "string",
            "null"
          ],
          "description": "Token for retrieving the next page. Pass this exact value as `nextPageToken` in the next request. Null if no more pages."
        },
        "properties": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "price": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "usd": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "ISO 4217 currency code for the listing price."
                      },
                      "amount": {
                        "type": [
                          "number",
                          "null"
                        ],
                        "description": "Numeric listing price amount."
                      }
                    },
                    "description": "Listing price converted to USD when conversion data is available."
                  },
                  "local": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "ISO 4217 currency code for the listing price."
                      },
                      "amount": {
                        "type": [
                          "number",
                          "null"
                        ],
                        "description": "Numeric listing price amount."
                      }
                    },
                    "description": "Listing price in the local market currency."
                  }
                },
                "required": [
                  "usd",
                  "local"
                ],
                "description": "Price represented in both USD and local listing currency."
              },
              "position": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Result position on this page."
              },
              "listingId": {
                "type": "string",
                "description": "Unique listing identifier."
              },
              "address": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Full property address."
              },
              "street": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Street address."
              },
              "city": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "City name."
              },
              "state": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "State or province code."
              },
              "postalCode": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Postal or ZIP code."
              },
              "unitNumber": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Unit or apartment number, when the listing is part of a multi-unit building."
              },
              "bedroomCount": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Number of bedrooms."
              },
              "bathroomCount": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Number of bathrooms."
              },
              "estimatedPrice": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "usd": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "ISO 4217 currency code for the listing price."
                      },
                      "amount": {
                        "type": [
                          "number",
                          "null"
                        ],
                        "description": "Numeric listing price amount."
                      }
                    },
                    "description": "Listing price converted to USD when conversion data is available."
                  },
                  "local": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "ISO 4217 currency code for the listing price."
                      },
                      "amount": {
                        "type": [
                          "number",
                          "null"
                        ],
                        "description": "Numeric listing price amount."
                      }
                    },
                    "description": "Listing price in the local market currency."
                  }
                },
                "required": [
                  "usd",
                  "local"
                ],
                "description": "Estimated property value in USD and local currency."
              },
              "estimatedMonthlyRent": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "usd": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "ISO 4217 currency code for the listing price."
                      },
                      "amount": {
                        "type": [
                          "number",
                          "null"
                        ],
                        "description": "Numeric listing price amount."
                      }
                    },
                    "description": "Listing price converted to USD when conversion data is available."
                  },
                  "local": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "ISO 4217 currency code for the listing price."
                      },
                      "amount": {
                        "type": [
                          "number",
                          "null"
                        ],
                        "description": "Numeric listing price amount."
                      }
                    },
                    "description": "Listing price in the local market currency."
                  }
                },
                "required": [
                  "usd",
                  "local"
                ],
                "description": "Estimated monthly rent in USD and local currency."
              },
              "priceChangeAmount": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "usd": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "ISO 4217 currency code for the listing price."
                      },
                      "amount": {
                        "type": [
                          "number",
                          "null"
                        ],
                        "description": "Numeric listing price amount."
                      }
                    },
                    "description": "Listing price converted to USD when conversion data is available."
                  },
                  "local": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "ISO 4217 currency code for the listing price."
                      },
                      "amount": {
                        "type": [
                          "number",
                          "null"
                        ],
                        "description": "Numeric listing price amount."
                      }
                    },
                    "description": "Listing price in the local market currency."
                  }
                },
                "required": [
                  "usd",
                  "local"
                ],
                "description": "Latest absolute price change in USD and local currency."
              },
              "priceReductionNote": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Formatted price-reduction note."
              },
              "taxAssessedValue": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "usd": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "ISO 4217 currency code for the listing price."
                      },
                      "amount": {
                        "type": [
                          "number",
                          "null"
                        ],
                        "description": "Numeric listing price amount."
                      }
                    },
                    "description": "Listing price converted to USD when conversion data is available."
                  },
                  "local": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "ISO 4217 currency code for the listing price."
                      },
                      "amount": {
                        "type": [
                          "number",
                          "null"
                        ],
                        "description": "Numeric listing price amount."
                      }
                    },
                    "description": "Listing price in the local market currency."
                  }
                },
                "required": [
                  "usd",
                  "local"
                ],
                "description": "Tax-assessed property value in USD and local currency."
              },
              "floorAreaSqFt": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Living area in square feet."
              },
              "lotAreaSqFt": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Lot size in square feet."
              },
              "homeType": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Property type label."
              },
              "listingLifecycleStatus": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Listing lifecycle status."
              },
              "listingStatusLabel": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Human-readable listing status label."
              },
              "listingType": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Listing type."
              },
              "dateSold": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Sold date."
              },
              "datePriceChanged": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Latest price-change date."
              },
              "newConstructionType": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "New-construction type."
              },
              "timeOnMarketDays": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Number of days this listing has been on market."
              },
              "url": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Listing URL."
              },
              "thumbnailUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Listing thumbnail URL."
              },
              "imageUrls": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                },
                "description": "Listing image URLs."
              },
              "streetViewUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Street-view URL."
              },
              "has3dModel": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "Whether a 3D model is available."
              },
              "brokerName": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Listing broker name."
              },
              "builderName": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Builder name."
              },
              "isShowcaseListing": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "Whether the listing is marked as showcase."
              },
              "isFeaturedListing": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "Whether the listing is marked as featured."
              },
              "primaryTag": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "type": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "text": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "description": "Primary listing tag."
              },
              "listingTags": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "text": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  }
                },
                "description": "Additional listing tags."
              },
              "contactPhone": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Listing contact phone number."
              },
              "openHouse": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "description": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "startDate": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "endDate": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "description": "Open-house details."
              },
              "buildingName": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Building name."
              },
              "rentalUnits": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "price": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "properties": {
                        "usd": {
                          "type": "object",
                          "properties": {
                            "currency": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "description": "ISO 4217 currency code for the listing price."
                            },
                            "amount": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Numeric listing price amount."
                            }
                          },
                          "description": "Listing price converted to USD when conversion data is available."
                        },
                        "local": {
                          "type": "object",
                          "properties": {
                            "currency": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "description": "ISO 4217 currency code for the listing price."
                            },
                            "amount": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Numeric listing price amount."
                            }
                          },
                          "description": "Listing price in the local market currency."
                        }
                      },
                      "required": [
                        "usd",
                        "local"
                      ],
                      "description": "Unit asking price in USD and local currency."
                    },
                    "bedroomCount": {
                      "type": [
                        "integer",
                        "null"
                      ],
                      "description": "Number of bedrooms in the unit. 0 indicates a studio."
                    },
                    "isRoomForRent": {
                      "type": [
                        "boolean",
                        "null"
                      ],
                      "description": "Whether the unit is a single room for rent."
                    }
                  }
                },
                "description": "Individual rental units available in a multi-unit building."
              },
              "availabilityCount": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Count of available units."
              },
              "baseRent": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "min": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "usd": {
                        "type": "object",
                        "properties": {
                          "currency": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "ISO 4217 currency code for the listing price."
                          },
                          "amount": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "description": "Numeric listing price amount."
                          }
                        },
                        "description": "Listing price converted to USD when conversion data is available."
                      },
                      "local": {
                        "type": "object",
                        "properties": {
                          "currency": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "ISO 4217 currency code for the listing price."
                          },
                          "amount": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "description": "Numeric listing price amount."
                          }
                        },
                        "description": "Listing price in the local market currency."
                      }
                    },
                    "required": [
                      "usd",
                      "local"
                    ],
                    "description": "Minimum base rent in USD and local currency."
                  },
                  "max": {
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "usd": {
                        "type": "object",
                        "properties": {
                          "currency": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "ISO 4217 currency code for the listing price."
                          },
                          "amount": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "description": "Numeric listing price amount."
                          }
                        },
                        "description": "Listing price converted to USD when conversion data is available."
                      },
                      "local": {
                        "type": "object",
                        "properties": {
                          "currency": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "ISO 4217 currency code for the listing price."
                          },
                          "amount": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "description": "Numeric listing price amount."
                          }
                        },
                        "description": "Listing price in the local market currency."
                      }
                    },
                    "required": [
                      "usd",
                      "local"
                    ],
                    "description": "Maximum base rent in USD and local currency."
                  }
                },
                "description": "Base-rent range in USD and local currency."
              },
              "availabilityDate": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Availability date."
              },
              "isInstantTourEnabled": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "Whether instant tour is enabled."
              },
              "factsAndFeatures": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": {},
                "description": "Additional facts and features."
              },
              "countryCode": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "ISO 3166-1 alpha-3 country code (for example: 'CAN')."
              },
              "latitude": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Latitude coordinate."
              },
              "longitude": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Longitude coordinate."
              }
            },
            "required": [
              "listingId"
            ]
          },
          "description": "Properties returned for this page."
        },
        "warnings": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "Non-fatal advisories about how this page was served. For example, 'Sort \\'priceAscending\\' is applied from page 2 onwards.' when the requested sort cannot be honored on page 1. Omitted or null when there's nothing to flag."
        }
      },
      "required": [
        "runId",
        "properties"
      ]
    },
    "chargeInfo": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "method": {
              "type": "string",
              "enum": [
                "charged-now"
              ]
            },
            "creditsCharged": {
              "type": "number"
            },
            "lowCreditAlert": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "getMoreCreditsUrl": {
                  "type": "string",
                  "format": "uri",
                  "description": "URL to top up credits or restart billing cycle to get fresh credits."
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable credits warning."
                },
                "availableCredits": {
                  "type": "number",
                  "description": "Number of credits remaining in the current billing period."
                }
              },
              "required": [
                "getMoreCreditsUrl",
                "message",
                "availableCredits"
              ],
              "description": "Contains a link to get more credits, a warning message, and the remaining credit count."
            }
          },
          "required": [
            "method",
            "creditsCharged"
          ],
          "description": "Credits were charged immediately for this operation"
        },
        {
          "type": "object",
          "properties": {
            "method": {
              "type": "string",
              "enum": [
                "charging-later"
              ]
            },
            "message": {
              "type": "string"
            },
            "lowCreditAlert": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "getMoreCreditsUrl": {
                  "type": "string",
                  "format": "uri",
                  "description": "URL to top up credits or restart billing cycle to get fresh credits."
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable credits warning."
                },
                "availableCredits": {
                  "type": "number",
                  "description": "Number of credits remaining in the current billing period."
                }
              },
              "required": [
                "getMoreCreditsUrl",
                "message",
                "availableCredits"
              ],
              "description": "Contains a link to get more credits, a warning message, and the remaining credit count."
            }
          },
          "required": [
            "method",
            "message"
          ],
          "description": "Credits will be charged after the operation completes"
        },
        {
          "type": "object",
          "properties": {
            "method": {
              "type": "string",
              "enum": [
                "charged-for-async-process"
              ]
            },
            "creditsCharged": {
              "type": "number"
            },
            "message": {
              "type": "string"
            },
            "lowCreditAlert": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "getMoreCreditsUrl": {
                  "type": "string",
                  "format": "uri",
                  "description": "URL to top up credits or restart billing cycle to get fresh credits."
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable credits warning."
                },
                "availableCredits": {
                  "type": "number",
                  "description": "Number of credits remaining in the current billing period."
                }
              },
              "required": [
                "getMoreCreditsUrl",
                "message",
                "availableCredits"
              ],
              "description": "Contains a link to get more credits, a warning message, and the remaining credit count."
            }
          },
          "required": [
            "method",
            "creditsCharged",
            "message"
          ],
          "description": "Credits that were charged for an asynchronous operation"
        },
        {
          "type": "object",
          "properties": {
            "method": {
              "type": "string",
              "enum": [
                "free"
              ]
            },
            "message": {
              "type": "string"
            },
            "lowCreditAlert": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "getMoreCreditsUrl": {
                  "type": "string",
                  "format": "uri",
                  "description": "URL to top up credits or restart billing cycle to get fresh credits."
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable credits warning."
                },
                "availableCredits": {
                  "type": "number",
                  "description": "Number of credits remaining in the current billing period."
                }
              },
              "required": [
                "getMoreCreditsUrl",
                "message",
                "availableCredits"
              ],
              "description": "Contains a link to get more credits, a warning message, and the remaining credit count."
            }
          },
          "required": [
            "method",
            "message"
          ],
          "description": "No credits were charged for this operation"
        },
        {
          "type": "object",
          "properties": {
            "method": {
              "type": "string",
              "enum": [
                "credits-refunded"
              ]
            },
            "creditsRefunded": {
              "type": "number"
            },
            "message": {
              "type": "string"
            },
            "lowCreditAlert": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "getMoreCreditsUrl": {
                  "type": "string",
                  "format": "uri",
                  "description": "URL to top up credits or restart billing cycle to get fresh credits."
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable credits warning."
                },
                "availableCredits": {
                  "type": "number",
                  "description": "Number of credits remaining in the current billing period."
                }
              },
              "required": [
                "getMoreCreditsUrl",
                "message",
                "availableCredits"
              ],
              "description": "Contains a link to get more credits, a warning message, and the remaining credit count."
            }
          },
          "required": [
            "method",
            "creditsRefunded",
            "message"
          ],
          "description": "Credits were refunded for this operation"
        }
      ]
    },
    "warnings": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Full path to extraneous field (e.g., 'searchParams.ExtraField')"
          },
          "message": {
            "type": "string",
            "description": "Warning message"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Warnings about extraneous fields in request"
    },
    "advice": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      },
      "description": "Tips, recommendations, and suggestions for using this API effectively."
    }
  },
  "required": [
    "output",
    "chargeInfo"
  ],
  "additionalProperties": false
}
```

---

Canonical JSON: [`https://api.fiber.ai/openapi.json`](https://api.fiber.ai/openapi.json)
Operation index: [`https://api.fiber.ai/ai-docs/index.md`](https://api.fiber.ai/ai-docs/index.md)