GET
/
v2
/
functions
/
{owner_name}
/
{function_name}
/
versions
/
{version_slug}
curl --request GET \
  --url https://mango.sievedata.com/v2/functions/{owner_name}/{function_name}/versions/{version_slug} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "build_status": "<string>",
  "queued_at": "2024-12-15T01:41:59.195000",
  "built_at": "2024-12-15T01:41:59.195000",
  "ready_at": "2024-12-15T01:41:59.195000",
  "compute_type": "<string>",
  "python_packages": [
    "<string>"
  ],
  "system_packages": [
    "<string>"
  ],
  "cuda_version": "<string>",
  "gpu": true,
  "split": 123,
  "minimum_replicas": 0,
  "maximum_replicas": 123,
  "inputs": [
    {
      "type": "<string>",
      "name": "<string>",
      "data": "<string>",
      "description": "<string>",
      "schema": {},
      "run_id": "<string>"
    }
  ],
  "outputs": [
    {
      "type": "<string>",
      "name": "<string>",
      "data": "<string>",
      "description": "<string>",
      "schema": {},
      "run_id": "<string>"
    }
  ],
  "current_workers": {
    "starting": 123,
    "setup": 123,
    "active": 123,
    "idle": 123,
    "awaiting_resources": 123
  },
  "environment_variables": [
    {
      "name": "<string>",
      "description": "<string>",
      "default": "<string>"
    }
  ],
  "stream_output": true,
  "function_dependencies": [
    "<string>"
  ]
}

Authorizations

​
X-API-Key
string
header
required

The Sieve API key to authenticate with.

Path Parameters

​
owner_name
string
required

The owner of the function.

​
function_name
string
required

The name of the function.

​
version_slug
string
required

The ID or ID prefix of the function version, or 'latest'.

Response

200
application/json
Successful Response
​
id
string
required

Id of the model

​
build_status
string
required

Build status of the function version. Statuses are 'queued', 'building', 'pushing', 'deploying', 'ready', 'error'

​
queued_at
string | null
required

The UTC time that the function build is queued.

Example:

"2024-12-15T01:41:59.195000"

​
built_at
string | null
required

The UTC time that the function build finished building.

Example:

"2024-12-15T01:41:59.195000"

​
ready_at
string | null
required

The UTC time that the model is ready to process jobs.

Example:

"2024-12-15T01:41:59.195000"

​
compute_type
string
required

Machine type to use. See possible values for GPU machine types

​
python_packages
string[]
required

An array of the model's python pip packages

​
system_packages
string[]
required

An array of the model's system packages

​
gpu
boolean
required

Whether this model uses gpu

​
split
integer
required

How many functions to allocate per node

​
inputs
object[]
required

The inputs to a function

​
outputs
object[]
required

The outputs to a function

​
environment_variables
required

The outputs to a function

​
function_dependencies
string[]
required

Function dependencies

​
cuda_version
string | null

Cuda Version

​
minimum_replicas
integer
default:0

The minimum number of replicas of the model. Scale your model's minimum replicas to avoid cold starts

​
maximum_replicas
integer | null
default:0

The maximum number of replicas of the model. Prevents model replicas from scaling beyond a certain point

​
current_workers
object | null

The current number and status of the model's workers

​
stream_output
boolean | null
default:false

Stream output

Was this page helpful?

Suggest editsRaise issue