Get Job

GET

jobs

{job_id}

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

{
  "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": {}
}

Authorizations

X-API-Key

string

headerrequired

The Sieve API key to authenticate with.

Path Parameters

job_id

string

required

The ID of the job.

Query Parameters

offset

integer

default: 0

Response

200 - application/json

string

required

The id of the job.

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.

function

object | null

required

The name of the function that the job belongs to.

function.name

string

required

The name of the function

function.owner_name

string

required

The owner name of the function

function.visibility

string

required

The visibility of the function

function.title

string

required

The title of the function

function.code_url

string | null

The link to the code of the function

function.description

string | null

The description of the function

function.tags

string[] | null

The tags of the function

function.cover_image_url

string | null

The url of the function's cover image

function.examples

string[]

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

function.readme

string | null

The readme of the function

function.latest_version

object

required

The latest version of the function

function.latest_version.id

string

required

Id of the model

function.latest_version.build_status

string

required

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

function.latest_version.queued_at

string | null

required

The time that the function build is queued

function.latest_version.built_at

string | null

required

The time that the function build finished building

function.latest_version.ready_at

string | null

required

The time that the model is ready to process jobs

function.latest_version.compute_type

string

required

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

function.latest_version.python_packages

string[]

required

An array of the model's python pip packages

function.latest_version.system_packages

string[]

required

An array of the model's system packages

function.latest_version.cuda_version

string | null

Cuda Version

function.latest_version.gpu

boolean

required

Whether this model uses gpu

function.latest_version.split

integer

required

How many functions to allocate per node

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

function.latest_version.maximum_replicas

integer | null

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

function.latest_version.inputs

object[]

required

The inputs to a function

function.latest_version.outputs

object[]

required

The outputs to a function

function.latest_version.current_workers

object | null

The current number and status of the model's workers

function.latest_version.environment_variables

required

The outputs to a function

function.latest_version.stream_output

boolean | null

Stream output

function.latest_version.function_dependencies

string[]

required

Function dependencies

function.featured_key

integer | null

The featured key of the function

function.function_type

enum<string> | null

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

Available options:

function,

workflow

function.webhooks

object[] | null

The webhooks associated with the function

status

string

required

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

created_at

string | null

required

The time the job was created.

started_at

string | null

required

The time the job started processing by the function.

completed_at

string | null

required

The time the job was completed.

inputs

object

required

Show child attributes

outputs

array | null

required

Show child attributes

error

string | null

required

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

visibility

string

required

"public" or "private".

run_id

string | null

required

The run_id of the job.

children

object | null

Child attributes

Was this page helpful?

List Function Jobs Cancel Job

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

{
  "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": {}
}

Introduction

Custom Functions & Models

Walkthroughs

Reference

Reference (V1 Legacy)

Errors

Authorizations

Path Parameters

Query Parameters

Response