Create job

Create job

curl --request POST \
  --url https://api.blaxel.ai/v0/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "canaryRevision": "<string>",
      "message": "<string>",
      "revision": "<string>",
      "status": "<string>",
      "time": "<string>",
      "type": "<string>"
    }
  ],
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "<string>",
    "labels": {},
    "name": "<string>",
    "plan": "<unknown>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "configurations": {
      "key": {
        "secret": true,
        "value": "<string>"
      }
    },
    "enabled": true,
    "flavors": [
      {
        "name": "<string>",
        "type": "<string>"
      }
    ],
    "integrationConnections": [
      "<string>"
    ],
    "policies": [
      "<string>"
    ],
    "revision": {
      "active": "<string>",
      "canary": "<string>",
      "canaryPercent": 123,
      "stickySessionTtl": 123,
      "traffic": 123
    },
    "runtime": {
      "args": [
        "<unknown>"
      ],
      "command": [
        "<unknown>"
      ],
      "configuration": {},
      "cpu": 123,
      "endpointName": "<string>",
      "envs": [
        "<unknown>"
      ],
      "expires": "<string>",
      "generation": "<string>",
      "image": "<string>",
      "maxConcurrentTasks": 123,
      "maxRetries": 123,
      "maxScale": 123,
      "memory": 123,
      "metricPort": 123,
      "minScale": 123,
      "model": "<string>",
      "organization": "<string>",
      "ports": [
        {
          "name": "<string>",
          "protocol": "<string>",
          "target": 123
        }
      ],
      "startupProbe": {},
      "timeout": 123,
      "transport": "<string>",
      "ttl": "<string>",
      "type": "<string>"
    },
    "sandbox": true,
    "region": "<string>",
    "triggers": [
      {
        "configuration": {
          "authenticationType": "<string>",
          "callbackSecret": "<string>",
          "callbackUrl": "<string>",
          "path": "<string>",
          "retry": 123,
          "schedule": "<string>",
          "tasks": [
            {}
          ],
          "timeout": 123
        },
        "enabled": true,
        "id": "<string>",
        "type": "<string>"
      }
    ]
  },
  "status": "<string>"
}
'

{
  "events": [
    {
      "canaryRevision": "<string>",
      "message": "<string>",
      "revision": "<string>",
      "status": "<string>",
      "time": "<string>",
      "type": "<string>"
    }
  ],
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "<string>",
    "labels": {},
    "name": "<string>",
    "plan": "<unknown>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "configurations": {
      "key": {
        "secret": true,
        "value": "<string>"
      }
    },
    "enabled": true,
    "flavors": [
      {
        "name": "<string>",
        "type": "<string>"
      }
    ],
    "integrationConnections": [
      "<string>"
    ],
    "policies": [
      "<string>"
    ],
    "revision": {
      "active": "<string>",
      "canary": "<string>",
      "canaryPercent": 123,
      "stickySessionTtl": 123,
      "traffic": 123
    },
    "runtime": {
      "args": [
        "<unknown>"
      ],
      "command": [
        "<unknown>"
      ],
      "configuration": {},
      "cpu": 123,
      "endpointName": "<string>",
      "envs": [
        "<unknown>"
      ],
      "expires": "<string>",
      "generation": "<string>",
      "image": "<string>",
      "maxConcurrentTasks": 123,
      "maxRetries": 123,
      "maxScale": 123,
      "memory": 123,
      "metricPort": 123,
      "minScale": 123,
      "model": "<string>",
      "organization": "<string>",
      "ports": [
        {
          "name": "<string>",
          "protocol": "<string>",
          "target": 123
        }
      ],
      "startupProbe": {},
      "timeout": 123,
      "transport": "<string>",
      "ttl": "<string>",
      "type": "<string>"
    },
    "sandbox": true,
    "region": "<string>",
    "triggers": [
      {
        "configuration": {
          "authenticationType": "<string>",
          "callbackSecret": "<string>",
          "callbackUrl": "<string>",
          "path": "<string>",
          "retry": 123,
          "schedule": "<string>",
          "tasks": [
            {}
          ],
          "timeout": 123
        },
        "enabled": true,
        "id": "<string>",
        "type": "<string>"
      }
    ]
  },
  "status": "<string>"
}

POST

jobs

Create job

curl --request POST \
  --url https://api.blaxel.ai/v0/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "canaryRevision": "<string>",
      "message": "<string>",
      "revision": "<string>",
      "status": "<string>",
      "time": "<string>",
      "type": "<string>"
    }
  ],
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "<string>",
    "labels": {},
    "name": "<string>",
    "plan": "<unknown>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "configurations": {
      "key": {
        "secret": true,
        "value": "<string>"
      }
    },
    "enabled": true,
    "flavors": [
      {
        "name": "<string>",
        "type": "<string>"
      }
    ],
    "integrationConnections": [
      "<string>"
    ],
    "policies": [
      "<string>"
    ],
    "revision": {
      "active": "<string>",
      "canary": "<string>",
      "canaryPercent": 123,
      "stickySessionTtl": 123,
      "traffic": 123
    },
    "runtime": {
      "args": [
        "<unknown>"
      ],
      "command": [
        "<unknown>"
      ],
      "configuration": {},
      "cpu": 123,
      "endpointName": "<string>",
      "envs": [
        "<unknown>"
      ],
      "expires": "<string>",
      "generation": "<string>",
      "image": "<string>",
      "maxConcurrentTasks": 123,
      "maxRetries": 123,
      "maxScale": 123,
      "memory": 123,
      "metricPort": 123,
      "minScale": 123,
      "model": "<string>",
      "organization": "<string>",
      "ports": [
        {
          "name": "<string>",
          "protocol": "<string>",
          "target": 123
        }
      ],
      "startupProbe": {},
      "timeout": 123,
      "transport": "<string>",
      "ttl": "<string>",
      "type": "<string>"
    },
    "sandbox": true,
    "region": "<string>",
    "triggers": [
      {
        "configuration": {
          "authenticationType": "<string>",
          "callbackSecret": "<string>",
          "callbackUrl": "<string>",
          "path": "<string>",
          "retry": 123,
          "schedule": "<string>",
          "tasks": [
            {}
          ],
          "timeout": 123
        },
        "enabled": true,
        "id": "<string>",
        "type": "<string>"
      }
    ]
  },
  "status": "<string>"
}
'

{
  "events": [
    {
      "canaryRevision": "<string>",
      "message": "<string>",
      "revision": "<string>",
      "status": "<string>",
      "time": "<string>",
      "type": "<string>"
    }
  ],
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "<string>",
    "labels": {},
    "name": "<string>",
    "plan": "<unknown>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "configurations": {
      "key": {
        "secret": true,
        "value": "<string>"
      }
    },
    "enabled": true,
    "flavors": [
      {
        "name": "<string>",
        "type": "<string>"
      }
    ],
    "integrationConnections": [
      "<string>"
    ],
    "policies": [
      "<string>"
    ],
    "revision": {
      "active": "<string>",
      "canary": "<string>",
      "canaryPercent": 123,
      "stickySessionTtl": 123,
      "traffic": 123
    },
    "runtime": {
      "args": [
        "<unknown>"
      ],
      "command": [
        "<unknown>"
      ],
      "configuration": {},
      "cpu": 123,
      "endpointName": "<string>",
      "envs": [
        "<unknown>"
      ],
      "expires": "<string>",
      "generation": "<string>",
      "image": "<string>",
      "maxConcurrentTasks": 123,
      "maxRetries": 123,
      "maxScale": 123,
      "memory": 123,
      "metricPort": 123,
      "minScale": 123,
      "model": "<string>",
      "organization": "<string>",
      "ports": [
        {
          "name": "<string>",
          "protocol": "<string>",
          "target": 123
        }
      ],
      "startupProbe": {},
      "timeout": 123,
      "transport": "<string>",
      "ttl": "<string>",
      "type": "<string>"
    },
    "sandbox": true,
    "region": "<string>",
    "triggers": [
      {
        "configuration": {
          "authenticationType": "<string>",
          "callbackSecret": "<string>",
          "callbackUrl": "<string>",
          "path": "<string>",
          "retry": 123,
          "schedule": "<string>",
          "tasks": [
            {}
          ],
          "timeout": 123
        },
        "enabled": true,
        "id": "<string>",
        "type": "<string>"
      }
    ]
  },
  "status": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Job

events

object[]

Core events

Show child attributes

events.canaryRevision

string

Canary revisionID link to the event

events.message

string

Event message

events.revision

string

RevisionID link to the event

events.status

string

Event status

events.time

string

Event time

events.type

string

Event type

metadata

object

Metadata Time fields for Persistance Owner fields for Persistance

Show child attributes

metadata.createdAt

string

The date and time when the resource was created

metadata.updatedAt

string

The date and time when the resource was updated

metadata.createdBy

string

The user or service account who created the resource

metadata.updatedBy

string

The user or service account who updated the resource

metadata.displayName

string

Model display name

metadata.labels

object

Labels

Show child attributes

metadata.labels.{key}

string

metadata.name

string

Model name

metadata.plan

any

Plan

metadata.url

string

URL

metadata.workspace

string

Workspace name

spec

object

Job specification Core specification

Show child attributes

spec.configurations

object

Optional configurations for the object

Show child attributes

spec.configurations.key

object

Configuration, this is a key value storage. In your object you can retrieve the value with config[key]

Show child attributes

spec.configurations.key.secret

boolean

ACconfiguration secret

spec.configurations.key.value

string

Configuration value

spec.enabled

boolean

Enable or disable the resource

spec.flavors

object[]

Types of hardware available for deployments

Show child attributes

spec.flavors.name

string

Flavor name (e.g. t4)

spec.flavors.type

string

Flavor type (e.g. cpu, gpu)

spec.integrationConnections

string[]

Deployment integration connection name

spec.policies

string[]

Policy name

spec.revision

object

Revision configuration

Show child attributes

spec.revision.active

string

Active revision id

spec.revision.canary

string

Canary revision id

spec.revision.canaryPercent

integer

Canary revision percent

spec.revision.stickySessionTtl

integer

Sticky session TTL in seconds (0 = disabled)

spec.revision.traffic

integer

Traffic percentage

spec.runtime

object

Set of configurations for a deployment

Show child attributes

spec.runtime.args

any[]

The arguments to pass to the deployment runtime

spec.runtime.command

any[]

The command to run the deployment

spec.runtime.configuration

object

The configuration for the deployment

spec.runtime.cpu

integer

The CPU for the deployment in cores, only available for private cluster

spec.runtime.endpointName

string

Endpoint Name of the model. In case of hf_private_endpoint, it is the endpoint name. In case of hf_public_endpoint, it is not used.

spec.runtime.envs

any[]

The env variables to set in the deployment. Should be a list of Kubernetes EnvVar types

spec.runtime.expires

string

The expiration date for the deployment in ISO 8601 format - 2024-12-31T23:59:59Z

spec.runtime.generation

string

The generation of the deployment

spec.runtime.image

string

The Docker image for the deployment

spec.runtime.maxConcurrentTasks

integer

The maximum number of concurrent task for an execution

spec.runtime.maxRetries

integer

The maximum number of retries for the deployment

spec.runtime.maxScale

integer

The minimum number of replicas for the deployment. Can be 0 or 1 (in which case the deployment is always running in at least one location).

spec.runtime.memory

integer

The memory for the deployment in MB

spec.runtime.metricPort

integer

The port to serve the metrics on

spec.runtime.minScale

integer

The maximum number of replicas for the deployment.

spec.runtime.model

string

The slug name of the origin model at HuggingFace.

spec.runtime.organization

string

The organization of the model

spec.runtime.ports

object[]

The exposed ports of the resource

Show child attributes

spec.runtime.ports.name

string

The name of the port

spec.runtime.ports.protocol

string

The protocol of the port

spec.runtime.ports.target

integer

The target port of the port

spec.runtime.startupProbe

object

The readiness probe. Should be a Kubernetes Probe type

spec.runtime.timeout

integer

The timeout for the deployment in seconds

spec.runtime.transport

string

The transport for the deployment, used by MCPs: "websocket" or "http-stream"

spec.runtime.ttl

string

The TTL for the deployment in seconds - 30m, 24h, 7d

spec.runtime.type

string

The type of origin for the deployment (hf_private_endpoint, hf_public_endpoint)

spec.sandbox

boolean

Sandbox mode

spec.region

string

Region where the job should be created (e.g. us-was-1, eu-lon-1)

spec.triggers

object[]

Triggers to use your agent

Show child attributes

spec.triggers.configuration

object

The configuration of the trigger

Show child attributes

spec.triggers.configuration.authenticationType

string

The authentication type of the trigger

spec.triggers.configuration.callbackSecret

string

The callback secret for async triggers (auto-generated, encrypted)

spec.triggers.configuration.callbackUrl

string

The callback URL for async triggers (optional)

spec.triggers.configuration.path

string

The path of the trigger

spec.triggers.configuration.retry

integer

The retry of the trigger

spec.triggers.configuration.schedule

string

The schedule of the trigger, cron expression * * * * *

spec.triggers.configuration.tasks

object[]

The tasks configuration of the cronjob

spec.triggers.configuration.timeout

integer

The timeout in seconds for async triggers (max 900s, MK3 only)

spec.triggers.enabled

boolean

Enable or disable the trigger (default: true)

spec.triggers.id

string

The id of the trigger

spec.triggers.type

string

The type of trigger, can be http or http-async

status

string

Job status

Response

200 - application/json

successful operation

Job

events

object[]

Core events

Show child attributes

events.canaryRevision

string

Canary revisionID link to the event

events.message

string

Event message

events.revision

string

RevisionID link to the event

events.status

string

Event status

events.time

string

Event time

events.type

string

Event type

metadata

object

Metadata Time fields for Persistance Owner fields for Persistance

Show child attributes

metadata.createdAt

string

The date and time when the resource was created

metadata.updatedAt

string

The date and time when the resource was updated

metadata.createdBy

string

The user or service account who created the resource

metadata.updatedBy

string

The user or service account who updated the resource

metadata.displayName

string

Model display name

metadata.labels

object

Labels

Show child attributes

metadata.labels.{key}

string

metadata.name

string

Model name

metadata.plan

any

Plan

metadata.url

string

URL

metadata.workspace

string

Workspace name

spec

object

Job specification Core specification

Show child attributes

spec.configurations

object

Optional configurations for the object

Show child attributes

spec.configurations.key

object

Configuration, this is a key value storage. In your object you can retrieve the value with config[key]

Show child attributes

spec.configurations.key.secret

boolean

ACconfiguration secret

spec.configurations.key.value

string

Configuration value

spec.enabled

boolean

Enable or disable the resource

spec.flavors

object[]

Types of hardware available for deployments

Show child attributes

spec.flavors.name

string

Flavor name (e.g. t4)

spec.flavors.type

string

Flavor type (e.g. cpu, gpu)

spec.integrationConnections

string[]

Deployment integration connection name

spec.policies

string[]

Policy name

spec.revision

object

Revision configuration

Show child attributes

spec.revision.active

string

Active revision id

spec.revision.canary

string

Canary revision id

spec.revision.canaryPercent

integer

Canary revision percent

spec.revision.stickySessionTtl

integer

Sticky session TTL in seconds (0 = disabled)

spec.revision.traffic

integer

Traffic percentage

spec.runtime

object

Set of configurations for a deployment

Show child attributes

spec.runtime.args

any[]

The arguments to pass to the deployment runtime

spec.runtime.command

any[]

The command to run the deployment

spec.runtime.configuration

object

The configuration for the deployment

spec.runtime.cpu

integer

The CPU for the deployment in cores, only available for private cluster

spec.runtime.endpointName

string

Endpoint Name of the model. In case of hf_private_endpoint, it is the endpoint name. In case of hf_public_endpoint, it is not used.

spec.runtime.envs

any[]

The env variables to set in the deployment. Should be a list of Kubernetes EnvVar types

spec.runtime.expires

string

The expiration date for the deployment in ISO 8601 format - 2024-12-31T23:59:59Z

spec.runtime.generation

string

The generation of the deployment

spec.runtime.image

string

The Docker image for the deployment

spec.runtime.maxConcurrentTasks

integer

The maximum number of concurrent task for an execution

spec.runtime.maxRetries

integer

The maximum number of retries for the deployment

spec.runtime.maxScale

integer

The minimum number of replicas for the deployment. Can be 0 or 1 (in which case the deployment is always running in at least one location).

spec.runtime.memory

integer

The memory for the deployment in MB

spec.runtime.metricPort

integer

The port to serve the metrics on

spec.runtime.minScale

integer

The maximum number of replicas for the deployment.

spec.runtime.model

string

The slug name of the origin model at HuggingFace.

spec.runtime.organization

string

The organization of the model

spec.runtime.ports

object[]

The exposed ports of the resource

Show child attributes

spec.runtime.ports.name

string

The name of the port

spec.runtime.ports.protocol

string

The protocol of the port

spec.runtime.ports.target

integer

The target port of the port

spec.runtime.startupProbe

object

The readiness probe. Should be a Kubernetes Probe type

spec.runtime.timeout

integer

The timeout for the deployment in seconds

spec.runtime.transport

string

The transport for the deployment, used by MCPs: "websocket" or "http-stream"

spec.runtime.ttl

string

The TTL for the deployment in seconds - 30m, 24h, 7d

spec.runtime.type

string

The type of origin for the deployment (hf_private_endpoint, hf_public_endpoint)

spec.sandbox

boolean

Sandbox mode

spec.region

string

Region where the job should be created (e.g. us-was-1, eu-lon-1)

spec.triggers

object[]

Triggers to use your agent

Show child attributes

spec.triggers.configuration

object

The configuration of the trigger

Show child attributes

spec.triggers.configuration.authenticationType

string

The authentication type of the trigger

spec.triggers.configuration.callbackSecret

string

The callback secret for async triggers (auto-generated, encrypted)

spec.triggers.configuration.callbackUrl

string

The callback URL for async triggers (optional)

spec.triggers.configuration.path

string

The path of the trigger

spec.triggers.configuration.retry

integer

The retry of the trigger

spec.triggers.configuration.schedule

string

The schedule of the trigger, cron expression * * * * *

spec.triggers.configuration.tasks

object[]

The tasks configuration of the cronjob

spec.triggers.configuration.timeout

integer

The timeout in seconds for async triggers (max 900s, MK3 only)

spec.triggers.enabled

boolean

Enable or disable the trigger (default: true)

spec.triggers.id

string

The id of the trigger

spec.triggers.type

string

The type of trigger, can be http or http-async

status

string

Job status

List jobs Get job

⌘I

Overview

Inference API

agents

configurations

customdomains

functions

images

integrations

jobs

locations

API Reference

models

policies

invitations

publicIps:list

compute

service_accounts

templates

workspaces

volumeTemplates

volumes

Authorizations

Body

Response