---
title: "Get Suggestions"
method: POST
path: "/v1/endpoint/get-suggestions"
tags: ["EndpointPoc"]
---

# Get Suggestions

`POST /v1/endpoint/get-suggestions`

## Request body

- EndPointSuggestionRequest
  - `website_url` string, required
  - `prompt` string, required

## Response `200`

Successful Response

- EndPointSuggestionsResponse
  - `suggestions` EndpointSuggestion[], required
    - `endpoint` string, required
    - `method` string
    - `description` string, required
    - `target_url` string, required
    - `parameters` EndpointParameter[], required
      - `name` string, required
      - `type` string, required
      - `location` string, required
      - `required` boolean, required
      - `description` string, required
      - `is_url` boolean
    - `pydantic_schema` object, required
    - `extraction_prompt` string, required
    - `interaction_steps` string[], nullable
  - `html_with_markdowns` unknown, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/scrapegraphai/apis/fastapi.md) · [All operations](https://skmtc.dev/scrapegraphai/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scrapegraphai/fastapi/revisions/17bc5b01fe0c/schema)