API Reference

Create new endpoint

post
https://api.octoai.cloud/v1/endpoint
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Endpoint to add to the store

string
required

Name of the endpoint

string

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

string

Description of the endpoint

string
required

URL of the docker image

integer
required

Port number of the endpoint

string

URL path of a health check endpoint

boolean

EXPERIMENTAL: autogenerate a volume for the endpoint

volumes_experimental
array of objects

EXPERIMENTAL: volumes to be used by this container

volumes_experimental
integer
0 to 999

Minimum number of replicas

integer
0 to 999

Maximum number of replicas

integer
0 to 3600

Time to scale to zero (in seconds)

string

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

string
enum

Visibility of the endpoint

Allowed:
string
enum

State of a endpoint

Allowed:
env_overrides
object

JSON object with environment variable overrides

string

Endpoint to query against

container_secrets
array of strings

A list of container secrets to inject as environment variables

container_secrets
integer
1 to 500

The maximum concurrency per replica

Response

Updated over 2 years ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago