- Documentation
- Join Discord Community
- Book a Demo
- Deploying Functions
- GPU Acceleration
- Referencing Functions
- Typing & Metadata
- Autoscaling
- Using Webhooks
- Example: Audio Transcription
- Example: Parallelized Face Detection
- Example: Video Dubbing
- Example: Live Stream Transcription + Translation
API Reference
CLI Reference
SDK Reference
API Reference
- Error Codes
Custom Functions & Models
Walkthroughs
Reference
Reference (V1 Legacy)
Errors
Get Function
Get information about the given function.
The Sieve API key to authenticate with.
The owner of the function.
The name of the function.
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": "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>"
}
]
}Authorizations
The Sieve API key to authenticate with.
Path Parameters
The owner of the function.
The name of the function.
Response
The name of the function
The owner name of the function
The visibility of the function
The title of the function
The link to the code of the function
The description of the function
The tags of the function
The url of the function's cover image
An array of job ids that the function playground will use as an example
The readme of the function
The latest version of the function
Id of the model
Build status of the function version. Statuses are 'queued', 'building', 'pushing', 'deploying', 'ready', 'error'
The time that the function build is queued
The time that the function build finished building
The time that the model is ready to process jobs
Machine type to use. See possible values for GPU machine types
An array of the model's python pip packages
An array of the model's system packages
Cuda Version
Whether this model uses gpu
How many functions to allocate per node
The minimum number of replicas of the model. Scale your model's minimum replicas to avoid cold starts
The maximum number of replicas of the model. Prevents model replicas from scaling beyond a certain point
The inputs to a function
The type of the output, see all possible values here
The name of the output
The data of the output. Empty if the response is not from a job
The description of the output
The outputs to a function
The type of the output, see all possible values here
The name of the output
The data of the output. Empty if the response is not from a job
The description of the output
The current number and status of the model's workers
The number of workers that are in the process of being started. This means that the worker has been allocated resources on the Sieve cloud, but is still in the process of creating the environment in which the model runs.
The number of workers that are in the process of running the setup function.
The number of workers that are actively running a prediction.
The number of workers that have fully setup, but are not currently running a prediction.
The number of workers that are still waiting for resources on the Sieve cloud.
The outputs to a function
The name of the environment variables
The description of the environment variables
Default value of the environment variable
Stream output
Function dependencies
The featured key of the function
The type of the function, either a simple function or a workflow
function, workflow The webhooks associated with the function
job.start, job.complete, job.complete.no_output, job.new_output, job_start, job_complete Was this page helpful?
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": "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>"
}
]
}