Skip to main content
GET
/
v1
/
job-recipes
List Job Recipes
curl --request GET \
  --url https://api.compute.x.io/v1/job-recipes
{
  "data": [
    {
      "object": "job_recipe",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25",
      "name": "<string>",
      "description": "<string>",
      "visibility": "ARCHIVED",
      "payload": {
        "title": "<string>",
        "task": "BATCH",
        "parameters": {
          "parameters": {
            "allowed_ips": [
              "<string>"
            ],
            "env": {},
            "host": "<string>",
            "image": "<string>",
            "imagesrc": "<string>",
            "ports": [
              123
            ],
            "secret": "<string>",
            "sshkey": "<string>",
            "tag": "<string>",
            "user": "<string>",
            "volumes": [
              {
                "image": "<string>",
                "mount": "<string>",
                "registry": "<string>",
                "secret": "<string>",
                "tag": "<string>",
                "user": "<string>"
              }
            ]
          },
          "type": "docker"
        },
        "min_vram_gb": 123,
        "min_ram_gb": 123,
        "min_storage_gb": 123,
        "cpu_count": 4,
        "gpu_count": 1,
        "description": "<string>",
        "max_timeout_assign_ms": 123,
        "max_timeout_run_ms": 123,
        "max_timeout_start_ms": 123,
        "gpu_name": "RTX 3090",
        "gpu_registry_uuid": "01234567-89ab-cdef-0123-456789abcdef",
        "image_size_bytes": 2147483648,
        "max_node_count": 123,
        "max_retry_count": 123
      },
      "is_official": true,
      "last_used_at": "2023-12-25",
      "usage_count": 123,
      "fork_count": 123,
      "uuid": "<string>",
      "quickstart_md": "<string>",
      "input_schema": [
        {
          "key": "<string>",
          "type": "number",
          "label": "<string>",
          "required": true,
          "description": "<string>",
          "placeholder": "<string>",
          "default_value": "<string>",
          "options": [
            {
              "label": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "thumbnail_url": "<string>",
      "is_owner": true,
      "forked_from_recipe_uuid": "<string>",
      "created_by_account_uuid": "<string>",
      "created_by_account": {
        "email": "jsmith@example.com",
        "uuid": "<string>"
      }
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123
}

Query Parameters

​
limit
integer
Required range: 1 <= x <= 50
Example:

1

​
page
integer
Required range: 1 <= x <= 9007199254740991
Example:

1

​
sort
string
Example:

"created_at OR -created_at"

​
filter[uuid]
string
​
filter[is_official]
string
​
filter[visibility]
string
​
filter[created_by_account_uuid]
string

Response

List of Job Recipes

​
data
object[]
required
​
limit
integer
required
​
page
integer
required
​
total
integer
required