Get Function

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.

Response

200 - application/json

name

string

required

The name of the function.

owner_name

string

required

The owner name of the function

code_url

string | null

The link to the code of the function. Omitted if truncate enabled.

cover_image_url

string | null

The url of the function's cover image. Omitted if truncate enabled.

description

string | null

The description of the function. Omitted if truncate enabled.

examples

string[] | null

An array of job ids that the function playground will use as an example. Omitted if truncate enabled.

function_type

enum<string> | null

The type of the function, either a simple function or a workflow. Omitted if truncate enabled.

Available options:

function,

workflow

latest_version

object | null

The latest version of the function. Omitted if truncate enabled.

latest_version.build_status

string

required

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

latest_version.built_at

string | null

required

The UTC time that the function build finished building.

latest_version.compute_type

string

required

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

latest_version.environment_variables

required

The outputs to a function

latest_version.function_dependencies

string[]

required

Function dependencies

latest_version.gpu

boolean

required

Whether this model uses gpu

latest_version.id

string

required

Id of the model

latest_version.inputs

object[]

required

The inputs to a function

latest_version.outputs

object[]

required

The outputs to a function

latest_version.python_packages

string[]

required

An array of the model's python pip packages

latest_version.queued_at

string | null

required

The UTC time that the function build is queued.

latest_version.ready_at

string | null

required

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

latest_version.split

integer

required

How many functions to allocate per node

latest_version.system_packages

string[]

required

An array of the model's system packages

latest_version.cuda_version

string | null

Cuda Version

latest_version.current_workers

object | null

The current number and status of the model's workers

latest_version.maximum_replicas

integer | null

default:

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

latest_version.minimum_replicas

integer

default:

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

latest_version.stream_output

boolean | null

default:

false

Stream output

readme

string | null

The readme of the function. Omitted if truncate enabled.

restart_on_error

boolean | null

Whether to restart the function on job error. Omitted if truncate enabled.

Getting Started

Custom Functions

Advanced Features

Walkthroughs

Reference

Errors

Get Function

Authorizations

Path Parameters

Response