Allow custom REST endpoints

[aliabid94]

Split out the ChatAPI content from this PR because how chat api endpoints are handled are very different. Allows the ability to ad GET and POST endpoint to your gradio app.

From what I added to the guides:

If you need to add some extra GET and POST request endpoints to you app, you can do so as such:

with gr.Blocks() as demo:
    textbox = ...

    @gr.api.get("/sum")
    def some_function(a: int, b: int):
        return {"sum": a + b}

This would expose a GET endpoint at "http://localhost:7860/get/sum" that would take two arguments via query parameters. e.g. "http://localhost:7860/get/sum?a=4&b=3". Note the type-hinting of a and b so the underlying FastAPI app can cast the inputs to int. Also note the "/get" URL prefix in the request!

POST requests work similarly, with URL's prefixed with /post.

with gr.Blocks() as demo:
    @gr.api.post("/sum")
    def some_function(data: dict):
        return {"sum": data.get("a") + data.get("b")}

Under the hood, Gradio is simply attaching your function directly to the FastAPI app underneath, so all FastAPI features are supported.

[gradio-pr-bot]

🪼 branch checks and previews

•	Name	Status	URL
	Spaces	ready!	Spaces preview
	Website	ready!	Website preview
🦄	Changes	detected!	Details

---

Install Gradio from this PR

pip install https://gradio-pypi-previews.s3.amazonaws.com/1103863a2527d684c40721adf14ca05dc5883c76/gradio-5.10.0-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@1103863a2527d684c40721adf14ca05dc5883c76#subdirectory=client/python"

Install Gradio JS Client from this PR

npm install https://gradio-npm-previews.s3.amazonaws.com/1103863a2527d684c40721adf14ca05dc5883c76/gradio-client-1.9.0.tgz

Use Lite from this PR

<script type="module" src="https://gradio-lite-previews.s3.amazonaws.com/1103863a2527d684c40721adf14ca05dc5883c76/dist/lite.js""></script>

[gradio-pr-bot]

🦄 change detected

This Pull Request includes changes to the following packages.

Package	Version
gradio	minor

• Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Allow custom REST endpoints

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

• Maintainers can change the version label to modify the version bump.
• If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

[abidlabs]

remove

Suggested change

print(response.json())

[abidlabs]

Superseded by #10332