Sign in

v1

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2024-05-09262060.3 KB
public-endpoint

Return list of public, OctoAI-deployed endpoints

get/v1/public-endpoints

Response

A list of OctoAI-deployed endpoints

namestring required

Name of the endpoint

display_namestring

User-friendly name of the endpoint (e.g. Stable Diffusion 2.1)

descriptionstring

Description of the endpoint

image_urlstring required

URL of the docker image

portinteger required

Port number of the endpoint

health_check_pathstring

URL path of a health check endpoint

auto_volume_experimentalboolean

EXPERIMENTAL: autogenerate a volume for the endpoint

min_replicasinteger

Minimum number of replicas

max_replicasinteger

Maximum number of replicas

scale_to_zerointeger

Time to scale to zero (in seconds)

registry_credentialstring

The key of a registry credential used to authenticate to a private registry

visibility'private' | 'public'

Visibility of the endpoint

endpoint_state'active' | 'disabled'

State of a endpoint

env_overridesobject

JSON object with environment variable overrides

instance_typestring

Endpoint to query against

container_secretsstring[]

A list of container secrets to inject as environment variables

concurrency_per_replicainteger

The maximum concurrency per replica

endpointstring required

Endpoint to query against

is_liveboolean

If this endpoint should be considered live or not