base-schema.json

{
  "openapi": "3.0.2",
  "info": {
    "title": "Cog",
    "version": "0.1.0"
  },
  "paths": {
    "/": {
      "get": {
        "summary": "Root",
        "operationId": "root__get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Response Root  Get"
                }
              }
            }
          }
        }
      }
    },
    "/health-check": {
      "get": {
        "summary": "Healthcheck",
        "operationId": "healthcheck_health_check_get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Response Healthcheck Health Check Get"
                }
              }
            }
          }
        }
      }
    },
    "/predictions": {
      "post": {
        "summary": "Predict",
        "description": "Run a single prediction on the model",
        "operationId": "predict_predictions_post",
        "parameters": [
          {
            "required": false,
            "schema": {
              "title": "Prefer",
              "type": "string"
            },
            "name": "prefer",
            "in": "header"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PredictionRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PredictionResponse"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/predictions/{prediction_id}": {
      "put": {
        "summary": "Predict Idempotent",
        "description": "Run a single prediction on the model (idempotent creation).",
        "operationId": "predict_idempotent_predictions__prediction_id__put",
        "parameters": [
          {
            "required": true,
            "schema": {
              "title": "Prediction ID",
              "type": "string"
            },
            "name": "prediction_id",
            "in": "path"
          },
          {
            "required": false,
            "schema": {
              "title": "Prefer",
              "type": "string"
            },
            "name": "prefer",
            "in": "header"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "title": "Prediction Request",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PredictionRequest"
                  }
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PredictionResponse"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/predictions/{prediction_id}/cancel": {
      "post": {
        "summary": "Cancel",
        "description": "Cancel a running prediction",
        "operationId": "cancel_predictions__prediction_id__cancel_post",
        "parameters": [
          {
            "required": true,
            "schema": {
              "title": "Prediction ID",
              "type": "string"
            },
            "name": "prediction_id",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Response Cancel Predictions  Prediction Id  Cancel Post"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    },
    "/shutdown": {
      "post": {
        "summary": "Start Shutdown",
        "operationId": "start_shutdown_shutdown_post",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Response Start Shutdown Shutdown Post"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "HTTPValidationError": {
        "title": "HTTPValidationError",
        "type": "object",
        "properties": {
          "detail": {
            "title": "Detail",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            }
          }
        }
      },
      "Input": {
        "title": "Input",
        "required": [
          "prompt"
        ],
        "type": "object",
        "properties": {
          "prompt": {
            "title": "Prompt",
            "type": "string",
            "description": "Prompt to send to the model.",
            "x-order": 0
          },
          "max_new_tokens": {
            "title": "Max New Tokens",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of tokens to generate. A word is generally 2-3 tokens",
            "default": 128,
            "x-order": 1
          },
          "min_new_tokens": {
            "title": "Min New Tokens",
            "minimum": -1,
            "type": "integer",
            "description": "Minimum number of tokens to generate. To disable, set to -1. A word is generally 2-3 tokens.",
            "default": -1,
            "x-order": 2
          },
          "temperature": {
            "title": "Temperature",
            "maximum": 5,
            "minimum": 0.01,
            "type": "number",
            "description": "Adjusts randomness of outputs, greater than 1 is random and 0 is deterministic, 0.75 is a good starting value.",
            "default": 0.7,
            "x-order": 3
          },
          "top_p": {
            "title": "Top P",
            "maximum": 1,
            "minimum": 0,
            "type": "number",
            "description": "When decoding text, samples from the top p percentage of most likely tokens; lower to ignore less likely tokens",
            "default": 0.95,
            "x-order": 4
          },
          "repetition_penalty": {
            "title": "Repetition Penalty",
            "minimum": 0,
            "type": "number",
            "description": "A parameter that controls how repetitive text can be. Lower means more repetitive, while higher means less repetitive. Set to 1.0 to disable.",
            "default": 1.15,
            "x-order": 5
          },
          "stop_sequences": {
            "title": "Stop Sequences",
            "type": "string",
            "description": "A comma-separated list of sequences to stop generation at. For example, '<end>,<stop>' will stop generation at the first instance of 'end' or '<stop>'.",
            "x-order": 6
          },
          "seed": {
            "title": "Seed",
            "type": "integer",
            "description": "Random seed. Leave blank to randomize the seed",
            "x-order": 7
          },
          "debug": {
            "title": "Debug",
            "type": "boolean",
            "description": "provide debugging output in logs",
            "default": false,
            "x-order": 8
          },
          "prompt_template": {
            "title": "Prompt Template",
            "type": "string",
            "description": "Template for formatting the prompt",
            "default": "{prompt}",
            "x-order": 9
          },
          "replicate_weights": {
            "title": "Replicate Weights",
            "type": "string",
            "description": "Path to fine-tuned weights produced by a Replicate fine-tune job.",
            "x-order": 10
          }
        }
      },
      "Output": {
        "title": "Output",
        "type": "array",
        "items": {
          "type": "string"
        },
        "x-cog-array-display": "concatenate",
        "x-cog-array-type": "iterator"
      },
      "PredictionRequest": {
        "title": "PredictionRequest",
        "type": "object",
        "properties": {
          "input": {
            "$ref": "#/components/schemas/Input"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "created_at": {
            "title": "Created At",
            "type": "string",
            "format": "date-time"
          },
          "output_file_prefix": {
            "title": "Output File Prefix",
            "type": "string"
          },
          "webhook": {
            "title": "Webhook",
            "maxLength": 65536,
            "minLength": 1,
            "type": "string",
            "format": "uri"
          },
          "webhook_events_filter": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WebhookEvent"
            },
            "default": [
              "start",
              "output",
              "logs",
              "completed"
            ]
          }
        }
      },
      "PredictionResponse": {
        "title": "PredictionResponse",
        "type": "object",
        "properties": {
          "input": {
            "$ref": "#/components/schemas/Input"
          },
          "output": {
            "$ref": "#/components/schemas/Output"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
          "version": {
            "title": "Version",
            "type": "string"
          },
          "created_at": {
            "title": "Created At",
            "type": "string",
            "format": "date-time"
          },
          "started_at": {
            "title": "Started At",
            "type": "string",
            "format": "date-time"
          },
          "completed_at": {
            "title": "Completed At",
            "type": "string",
            "format": "date-time"
          },
          "logs": {
            "title": "Logs",
            "type": "string",
            "default": ""
          },
          "error": {
            "title": "Error",
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/Status"
          },
          "metrics": {
            "title": "Metrics",
            "type": "object"
          }
        }
      },
      "Status": {
        "title": "Status",
        "enum": [
          "starting",
          "processing",
          "succeeded",
          "canceled",
          "failed"
        ],
        "type": "string",
        "description": "An enumeration."
      },
      "ValidationError": {
        "title": "ValidationError",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "type": "object",
        "properties": {
          "loc": {
            "title": "Location",
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            }
          },
          "msg": {
            "title": "Message",
            "type": "string"
          },
          "type": {
            "title": "Error Type",
            "type": "string"
          }
        }
      },
      "WebhookEvent": {
        "title": "WebhookEvent",
        "enum": [
          "start",
          "output",
          "logs",
          "completed"
        ],
        "type": "string",
        "description": "An enumeration."
      }
    }
  }
}