Function
Get Function
Getting Started
Advanced Features
Walkthroughs
Reference
- API Reference
- CLI Reference
- SDK Reference
Errors
Function
Get Function
Get information about the given function.
GET
/
v2
/
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
The Sieve API key to authenticate with.
Path Parameters
The owner of the function.
The name of the function.
Response
200
application/json
Successful Response
The response is of type object
.
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": "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
}