Create Job Recipe

POST /v1/job-recipes

Create Job Recipe

cURL

curl --request POST \
  --url https://api.dispersed.com/v1/job-recipes \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "payload": {
    "title": "<string>",
    "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,
    "allowed_region_codes": []
  },
  "description": "<string>",
  "visibility": "PRIVATE",
  "quickstart_md": "<string>",
  "input_schema": [
    {
      "key": "<string>",
      "label": "<string>",
      "required": true,
      "description": "<string>",
      "placeholder": "<string>",
      "default_value": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "thumbnail_url": "<string>",
  "is_official": false
}
'

201

{
  "object": "job_recipe",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "payload": {
    "title": "<string>",
    "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,
    "allowed_region_codes": []
  },
  "is_official": true,
  "last_used_at": "2023-11-07T05:31:56Z",
  "usage_count": 123,
  "fork_count": 123,
  "uuid": "<string>",
  "quickstart_md": "<string>",
  "input_schema": [
    {
      "key": "<string>",
      "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": {
    "uuid": "<string>",
    "email": "<string>"
  }
}

Body

application/json

name · string · required

Required string length: 1 - 100

payload · object · required

Show child attributes

description · string

Maximum string length: 500

visibility · enum<string> · default: PRIVATE

Available options: ARCHIVED, PRIVATE, PUBLIC, UNLISTED

quickstart_md · string

Markdown content for the quickstart guide

Maximum string length: 10000

input_schema · object[]

Schema defining required user inputs when cooking this recipe

Show child attributes

thumbnail_url · string<uri>

URL to a thumbnail image for the recipe card

is_official · boolean · default: false

Response

201

application/json

Job recipe created successfully (fields filtered by role)

object · enum<string> · required

Available options: job_recipe

created_at · string<date-time> | null · required

updated_at · string<date-time> | null · required

name · string · required

description · string | null · required

visibility · enum<string> · required

Available options: ARCHIVED, PRIVATE, PUBLIC, UNLISTED

payload · object · required

Show child attributes

is_official · boolean · required

last_used_at · string<date-time> | null · required

usage_count · number · required

fork_count · number · required

uuid · string | null

quickstart_md · string | null

input_schema · object[] | null

Show child attributes

thumbnail_url · string<uri> | null

is_owner · boolean

forked_from_recipe_uuid · string | null

created_by_account_uuid · string | null

created_by_account · object | null

Show child attributes