For AI agents: visit https://octoai-cloud.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
octoai
API Reference
ga

Log Inoctoai
API Reference
Log In
gaAPI Reference

OctoAI API

  • Authentication
  • Inference
  • Account
    • Get fields on an accountget
    • Update fields on an accountpatch
  • Endpoint
    • Create new endpointpost
    • Get description of an endpointget
    • Update an endpointpatch
    • Delete an endpointdel
    • List endpointsget
    • Get container metadataget
    • Get token for accessing the volumeget
  • Events & Logs
    • Get endpoint eventsget
    • Get endpoint events as streamget
    • Get endpoint logsget
    • Get endpoint logs as streamget
  • Secrets
    • Create new secretpost
    • Get secretget
    • Update secretput
    • Delete secretdel
    • List secretsget
  • Registry credentials
    • Create new registry credentialspost
    • Get registry credentialsget
    • Update registry credentialsput
    • Delete registry credentialsdel
    • List registry credentialsget
  • Public endpoints
    • List public, OctoAI-deployed endpointsget
  • Instance types
    • List hardware instance typesget

Image Generation API

  • Generate SD1.5post
  • Generate SDXLpost
  • Generate SSDpost
  • Generate ControlNet SD1.5post
  • Generate ControlNet SDXLpost

Fine Tuning API

  • Create Fine-tunepost
  • Cancel Fine-tunepost
  • Get Fine-tuneget
  • List Fine-tunesget
  • Delete Fine-tunedel

Asset Library API

  • Create Assetpost
  • Complete Asset Uploadpost
  • Get Assetget
  • List Assetsget
  • Delete Assetdel
Powered by 

Authentication

Authorization: Bearer $OCTOAI_TOKEN

API requests to your endpoints must be authenticated with a token - you can generate a token from the Account Settings page. Be sure to include your token in the header of your requests.

Updated over 2 years ago


Updated over 2 years ago