Get Function

GET

functions

{owner_name}

{function_name}

curl --request GET \
  --url https://mango.sievedata.com/v2/functions/{owner_name}/{function_name} \
  --header 'X-API-Key: <api-key>'

{
  "name": "<string>",
  "owner_name": "<string>",
  "visibility": "<string>",
  "title": "<string>",
  "code_url": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "cover_image_url": "<string>",
  "examples": [
    "<string>"
  ],
  "readme": "<string>",
  "latest_version": {
    "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>"
    ]
  },
  "function_type": "function",
  "webhooks": [
    {
      "type": "job.start",
      "url": "<string>"
    }
  ],
  "restart_on_error": true
}

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

Successful Response

name

string

required

The name of the function.

owner_name

string

required

The owner name of the function

visibility

string | null

The visibility of the function. Omitted if truncate enabled.

title

string | null

The title of the function. Omitted if truncate enabled.

code_url

string | null

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

description

string | null

The description of the function. Omitted if truncate enabled.

tags

string[] | null

The tags of the function. Omitted if truncate enabled.

cover_image_url

string | null

The url of the function's cover image. 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.

readme

string | null

The readme of the function. Omitted if truncate enabled.

latest_version

object | null

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

latest_version.id

string

required

Id of the model

latest_version.build_status

string

required

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

latest_version.queued_at

string | null

required

The UTC time that the function build is queued.

latest_version.built_at

string | null

required

The UTC time that the function build finished building.

latest_version.ready_at

string | null

required

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

latest_version.compute_type

string

required

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

latest_version.python_packages

string[]

required

An array of the model's python pip packages

latest_version.system_packages

string[]

required

An array of the model's system packages

latest_version.gpu

boolean

required

Whether this model uses gpu

latest_version.split

integer

required

How many functions to allocate per node

latest_version.inputs

object[]

required

The inputs to a function

latest_version.outputs

object[]

required

The outputs to a function

latest_version.environment_variables

required

The outputs to a function

latest_version.function_dependencies

string[]

required

Function dependencies

latest_version.cuda_version

string | null

Cuda Version

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.maximum_replicas

integer | null

default:

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

latest_version.current_workers

object | null

The current number and status of the model's workers

latest_version.stream_output

boolean | null

default:

false

Stream output

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

webhooks

object[] | null

The webhooks associated with the function. Omitted if truncate enabled.

restart_on_error

boolean | null

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

Was this page helpful?

Suggest edits Raise issue

List Function Versions List Function Jobs

curl --request GET \
  --url https://mango.sievedata.com/v2/functions/{owner_name}/{function_name} \
  --header 'X-API-Key: <api-key>'

{
  "name": "<string>",
  "owner_name": "<string>",
  "visibility": "<string>",
  "title": "<string>",
  "code_url": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "cover_image_url": "<string>",
  "examples": [
    "<string>"
  ],
  "readme": "<string>",
  "latest_version": {
    "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>"
    ]
  },
  "function_type": "function",
  "webhooks": [
    {
      "type": "job.start",
      "url": "<string>"
    }
  ],
  "restart_on_error": true
}

Getting Started

Custom Functions

Advanced Features

Walkthroughs

Reference

Errors

Get Function

Authorizations

Path Parameters

Response