List Function Jobs

GET

functions

{owner_name}

{function_name}

jobs

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

{
  "data": [
    {
      "id": "<string>",
      "function_id": "<string>",
      "function": {
        "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": "2023-11-07T05:31:56Z",
          "built_at": "2023-11-07T05:31:56Z",
          "ready_at": "2023-11-07T05:31:56Z",
          "compute_type": "<string>",
          "python_packages": [
            "<string>"
          ],
          "system_packages": [
            "<string>"
          ],
          "cuda_version": "<string>",
          "gpu": true,
          "split": 123,
          "minimum_replicas": 123,
          "maximum_replicas": 123,
          "inputs": [
            {
              "type": "<string>",
              "name": "<string>",
              "data": "<string>",
              "description": "<string>",
              "schema": {}
            }
          ],
          "outputs": [
            {
              "type": "<string>",
              "name": "<string>",
              "data": "<string>",
              "description": "<string>",
              "schema": {}
            }
          ],
          "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>"
          ]
        },
        "featured_key": 123,
        "function_type": "function",
        "webhooks": [
          {
            "type": "job.start",
            "url": "<string>"
          }
        ]
      },
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "inputs": {},
      "outputs": [
        {
          "type": "<string>",
          "name": "<string>",
          "data": "<string>",
          "description": "<string>",
          "schema": {}
        }
      ],
      "error": "<string>",
      "visibility": "<string>",
      "run_id": "<string>",
      "children": {}
    }
  ],
  "next_offset": 123
}

Authorizations

X-API-Key

string

headerrequired

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.

Query Parameters

limit

integer

default: 10000

The maximum amount of jobs to show.

offset

integer

default: 0

Exclude the first N jobs.

Response

200 - application/json

data

object[]

required

data.id

string

required

The id of the job.

data.function_id

string

required

The id of the function that the job belongs to. This can be the first 7 characters of the full id.

data.function

object | null

required

The name of the function that the job belongs to.

data.function.name

string

required

The name of the function

data.function.owner_name

string

required

The owner name of the function

data.function.visibility

string

required

The visibility of the function

data.function.title

string

required

The title of the function

data.function.code_url

string | null

The link to the code of the function

data.function.description

string | null

The description of the function

data.function.tags

string[] | null

The tags of the function

data.function.cover_image_url

string | null

The url of the function's cover image

data.function.examples

string[]

An array of job ids that the function playground will use as an example

data.function.readme

string | null

The readme of the function

data.function.latest_version

object

required

The latest version of the function

data.function.latest_version.id

string

required

Id of the model

data.function.latest_version.build_status

string

required

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

data.function.latest_version.queued_at

string | null

required

The time that the function build is queued

data.function.latest_version.built_at

string | null

required

The time that the function build finished building

data.function.latest_version.ready_at

string | null

required

The time that the model is ready to process jobs

data.function.latest_version.compute_type

string

required

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

data.function.latest_version.python_packages

string[]

required

An array of the model's python pip packages

data.function.latest_version.system_packages

string[]

required

An array of the model's system packages

data.function.latest_version.cuda_version

string | null

Cuda Version

data.function.latest_version.gpu

boolean

required

Whether this model uses gpu

data.function.latest_version.split

integer

required

How many functions to allocate per node

data.function.latest_version.minimum_replicas

integer

default: 0

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

data.function.latest_version.maximum_replicas

integer | null

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

data.function.latest_version.inputs

object[]

required

The inputs to a function

data.function.latest_version.outputs

object[]

required

The outputs to a function

data.function.latest_version.current_workers

object | null

The current number and status of the model's workers

data.function.latest_version.environment_variables

required

The outputs to a function

data.function.latest_version.stream_output

boolean | null

Stream output

data.function.latest_version.function_dependencies

string[]

required

Function dependencies

data.function.featured_key

integer | null

The featured key of the function

data.function.function_type

enum<string> | null

The type of the function, either a simple function or a workflow

Available options:

function,

workflow

data.function.webhooks

object[] | null

The webhooks associated with the function

data.status

string

required

The status of the job. Possible values: 'queued', 'processing', 'error', 'finished', 'cancelled'

data.created_at

string | null

required

The time the job was created.

data.started_at

string | null

required

The time the job started processing by the function.

data.completed_at

string | null

required

The time the job was completed.

data.inputs

object

required

Show child attributes

data.outputs

array | null

required

Show child attributes

data.error

string | null

required

The error that the job ran into. Empty string if there's no error.

data.visibility

string

required

"public" or "private".

data.run_id

string | null

required

The run_id of the job.

data.children

object | null

Child attributes

next_offset

integer

required

Was this page helpful?

Get Function Version Get Job

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

{
  "data": [
    {
      "id": "<string>",
      "function_id": "<string>",
      "function": {
        "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": "2023-11-07T05:31:56Z",
          "built_at": "2023-11-07T05:31:56Z",
          "ready_at": "2023-11-07T05:31:56Z",
          "compute_type": "<string>",
          "python_packages": [
            "<string>"
          ],
          "system_packages": [
            "<string>"
          ],
          "cuda_version": "<string>",
          "gpu": true,
          "split": 123,
          "minimum_replicas": 123,
          "maximum_replicas": 123,
          "inputs": [
            {
              "type": "<string>",
              "name": "<string>",
              "data": "<string>",
              "description": "<string>",
              "schema": {}
            }
          ],
          "outputs": [
            {
              "type": "<string>",
              "name": "<string>",
              "data": "<string>",
              "description": "<string>",
              "schema": {}
            }
          ],
          "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>"
          ]
        },
        "featured_key": 123,
        "function_type": "function",
        "webhooks": [
          {
            "type": "job.start",
            "url": "<string>"
          }
        ]
      },
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "inputs": {},
      "outputs": [
        {
          "type": "<string>",
          "name": "<string>",
          "data": "<string>",
          "description": "<string>",
          "schema": {}
        }
      ],
      "error": "<string>",
      "visibility": "<string>",
      "run_id": "<string>",
      "children": {}
    }
  ],
  "next_offset": 123
}

Introduction

Custom Functions & Models

Walkthroughs

Reference

Reference (V1 Legacy)

Errors

List Function Jobs

Authorizations

Path Parameters

Query Parameters

Response