Ray Serve Python API#

Core APIs#

serve.run(target[, _blocking, host, port, ...])

Run a Serve application and return a ServeHandle to the ingress.

serve.start([detached, http_options, ...])

Initialize a serve instance.

serve.shutdown()

Completely shut down the connected Serve instance.

serve.delete(name[, _blocking])

Delete an app by its name

ServeHandle API#

serve.handle.RayServeHandle(...[, ...])

A handle to a service deployment.

serve.handle.RayServeHandle.remote(*args, ...)

Issue an asynchronous request to the deployment.

serve.handle.RayServeHandle.options(*[, ...])

Set options for this handle.

Batching Requests#

serve.batch()

Converts a function to asynchronously handle batches.

Deployment Graph APIs#

serve.api.build(target)

Builds a Serve application into a static application.