Search...
/
Login
Sign up
Documentation
API Reference
Integrations
Release Notes
Status
Community
Support
Documentation
API Reference
Integrations
Release Notes
Status
Community
Support
OctoAI API
Authentication
Inference
Account
GET
Get fields on an account
Endpoint
POST
Create new endpoint
GET
Get description of an endpoint
DEL
Delete an endpoint
PATCH
Update an endpoint
GET
List endpoints
GET
Get container metadata
GET
Get token for accessing the volume
Telemetry
GET
Get endpoint logs
GET
Get endpoint logs as stream
GET
Get endpoint events
GET
Get endpoint events as stream
Secret
POST
Create new secret
GET
Retrieve secret by key
PUT
Update secret by key
DEL
Delete secret by key
GET
Get secret
Registry Credential
POST
Create new registry credentials
GET
Retrieve registry credentials by key
PUT
Update registry credentials
DEL
Delete registry credentials
GET
Get registry credentials
Public Endpoint
GET
List public, OctoAI-deployed endpoints
Instance Types
GET
List hardware instance types
Text Generation API
STREAM
Create Chat Completion
STREAM
Create Completion
Media Generation API
POST
Generate SD1.5
POST
Generate SDXL
POST
Generate SD3
POST
Generate ControlNet 1.5
POST
Generate ControlNet SDXL
POST
Generate SVD
POST
IP Adapter
POST
Generate FLUX.1 [dev]
POST
Generate FLUX.1 [schnell]
Fine Tuning API
POST
Create Tune
GET
Retrieve Tune
DEL
Delete Tune
POST
Cancel Tune
GET
List Tunes
Asset Library API
GET
List Assets
POST
Create Asset
DEL
Delete Asset
POST
Complete Asset Upload
GET
Retrieve Asset
Media Utilities API
POST
Adetailer
POST
Upscaling
POST
Remove Background
Login
Sign up
OctoAI API
Endpoint
Get description of an endpoint
GET
https://
api.octoai.cloud
/
v1
/
endpoint
/
:endpoint_name
Return description of an endpoint
Path parameters
endpoint_name
string
Required
The endpoint to retrieve
Response
This endpoint returns an object
name
string
Name of the endpoint
port
integer
Port number of the endpoint
replicas
list of objects
Active replicas for the endpoint
Show 6 properties
auto_volume_experimental
boolean
Optional
EXPERIMENTAL: autogenerate a volume for the endpoint
concurrency_per_replica
integer
Optional
The maximum concurrency per replica
container_secrets
list of strings
Optional
A list of container secrets to inject as environment variables
description
string
Optional
Defaults to
Description of the endpoint
display_name
string
Optional
Defaults to
User-friendly name of the endpoint (e.g. Stable Diffusion 2.1)
endpoint
string
Optional
Endpoint to query against
endpoint_state
"active" or "disabled"
Optional
Allowed values:
active
disabled
State of a endpoint
env_overrides
map from strings to any
Optional
JSON object with environment variable overrides
health_check_path
string
Optional
URL path of a health check endpoint
image_url
string
Optional
URL of the docker image
instance_type
string
Optional
Endpoint to query against
max_replicas
integer
Optional
Maximum number of replicas
min_replicas
integer
Optional
Minimum number of replicas
registry_credential
string
Optional
The key of a registry credential used to authenticate to a private registry
scale_to_zero
integer
Optional
Time to scale to zero (in seconds)
visibility
"private" or "public"
Optional
Allowed values:
private
public
Visibility of the endpoint
volumes_experimental
list of objects
Optional
EXPERIMENTAL: volumes to be used by this container
Show 3 properties