Create a run

Python (SDK)

from meetkai_mka1 import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.fine_tune_jobs.create_serving_run(accelerator="<value>", deadline={}, disk_gb=369181, gpu_count=444268, image="https://loremflickr.com/2112/3769?lock=8429739459860585", kind="deployment", startup_script_b64="<value>")

    # Handle response
    print(res)

import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await sdk.fineTuneJobs.createServingRun({
    runCreate: {
      accelerator: "<value>",
      deadline: {},
      diskGb: 369181,
      gpuCount: 444268,
      image: "https://loremflickr.com/2112/3769?lock=8429739459860585",
      kind: "deployment",
      startupScriptB64: "<value>",
    },
  });

  console.log(result);
}

run();

using MeetKai.MKA1;
using MeetKai.MKA1.Types.Components;

var sdk = new SDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.FineTuneJobs.CreateServingRunAsync(body: new RunCreate() {
    Accelerator = "<value>",
    Deadline = new RunDeadline() {},
    DiskGb = 369181,
    GpuCount = 444268,
    Image = "https://loremflickr.com/2112/3769?lock=8429739459860585",
    Kind = RunCreateKind.Deployment,
    StartupScriptB64 = "<value>",
});

// handle response

curl --request POST \
  --url https://apigw.mka1.com/api/v1/serving/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accelerator": "<string>",
  "deadline": {
    "hours": 123,
    "max_usd": 123
  },
  "disk_gb": 2,
  "gpu_count": 4,
  "image": "<string>",
  "startup_script_b64": "<string>",
  "env": {},
  "interconnect": "<string>",
  "name": "<string>",
  "ports": [
    "<string>"
  ],
  "providers": [
    "<string>"
  ],
  "secrets": [
    "<string>"
  ],
  "ssh_public_key": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accelerator: '<string>',
    deadline: {hours: 123, max_usd: 123},
    disk_gb: 2,
    gpu_count: 4,
    image: '<string>',
    startup_script_b64: '<string>',
    env: {},
    interconnect: '<string>',
    name: '<string>',
    ports: ['<string>'],
    providers: ['<string>'],
    secrets: ['<string>'],
    ssh_public_key: '<string>'
  })
};

fetch('https://apigw.mka1.com/api/v1/serving/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apigw.mka1.com/api/v1/serving/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accelerator' => '<string>',
    'deadline' => [
        'hours' => 123,
        'max_usd' => 123
    ],
    'disk_gb' => 2,
    'gpu_count' => 4,
    'image' => '<string>',
    'startup_script_b64' => '<string>',
    'env' => [
        
    ],
    'interconnect' => '<string>',
    'name' => '<string>',
    'ports' => [
        '<string>'
    ],
    'providers' => [
        '<string>'
    ],
    'secrets' => [
        '<string>'
    ],
    'ssh_public_key' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apigw.mka1.com/api/v1/serving/runs"

	payload := strings.NewReader("{\n  \"accelerator\": \"<string>\",\n  \"deadline\": {\n    \"hours\": 123,\n    \"max_usd\": 123\n  },\n  \"disk_gb\": 2,\n  \"gpu_count\": 4,\n  \"image\": \"<string>\",\n  \"startup_script_b64\": \"<string>\",\n  \"env\": {},\n  \"interconnect\": \"<string>\",\n  \"name\": \"<string>\",\n  \"ports\": [\n    \"<string>\"\n  ],\n  \"providers\": [\n    \"<string>\"\n  ],\n  \"secrets\": [\n    \"<string>\"\n  ],\n  \"ssh_public_key\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://apigw.mka1.com/api/v1/serving/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accelerator\": \"<string>\",\n  \"deadline\": {\n    \"hours\": 123,\n    \"max_usd\": 123\n  },\n  \"disk_gb\": 2,\n  \"gpu_count\": 4,\n  \"image\": \"<string>\",\n  \"startup_script_b64\": \"<string>\",\n  \"env\": {},\n  \"interconnect\": \"<string>\",\n  \"name\": \"<string>\",\n  \"ports\": [\n    \"<string>\"\n  ],\n  \"providers\": [\n    \"<string>\"\n  ],\n  \"secrets\": [\n    \"<string>\"\n  ],\n  \"ssh_public_key\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apigw.mka1.com/api/v1/serving/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accelerator\": \"<string>\",\n  \"deadline\": {\n    \"hours\": 123,\n    \"max_usd\": 123\n  },\n  \"disk_gb\": 2,\n  \"gpu_count\": 4,\n  \"image\": \"<string>\",\n  \"startup_script_b64\": \"<string>\",\n  \"env\": {},\n  \"interconnect\": \"<string>\",\n  \"name\": \"<string>\",\n  \"ports\": [\n    \"<string>\"\n  ],\n  \"providers\": [\n    \"<string>\"\n  ],\n  \"secrets\": [\n    \"<string>\"\n  ],\n  \"ssh_public_key\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "accelerator": "<string>",
  "deadline_at": "2023-11-07T05:31:56Z",
  "endpoint": "<string>",
  "exit_code": 123,
  "gpu_count": 123,
  "image": "<string>",
  "name": "<string>",
  "price_usd_hr": 123,
  "provider": "<string>",
  "reason": "<string>",
  "ssh": {
    "command": "<string>",
    "host": "<string>",
    "port": 123,
    "user": "<string>"
  },
  "started_at": "2023-11-07T05:31:56Z",
  "terminal_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

POST

api

serving

runs

Python (SDK)

from meetkai_mka1 import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.fine_tune_jobs.create_serving_run(accelerator="<value>", deadline={}, disk_gb=369181, gpu_count=444268, image="https://loremflickr.com/2112/3769?lock=8429739459860585", kind="deployment", startup_script_b64="<value>")

    # Handle response
    print(res)

import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await sdk.fineTuneJobs.createServingRun({
    runCreate: {
      accelerator: "<value>",
      deadline: {},
      diskGb: 369181,
      gpuCount: 444268,
      image: "https://loremflickr.com/2112/3769?lock=8429739459860585",
      kind: "deployment",
      startupScriptB64: "<value>",
    },
  });

  console.log(result);
}

run();

using MeetKai.MKA1;
using MeetKai.MKA1.Types.Components;

var sdk = new SDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.FineTuneJobs.CreateServingRunAsync(body: new RunCreate() {
    Accelerator = "<value>",
    Deadline = new RunDeadline() {},
    DiskGb = 369181,
    GpuCount = 444268,
    Image = "https://loremflickr.com/2112/3769?lock=8429739459860585",
    Kind = RunCreateKind.Deployment,
    StartupScriptB64 = "<value>",
});

// handle response

curl --request POST \
  --url https://apigw.mka1.com/api/v1/serving/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accelerator": "<string>",
  "deadline": {
    "hours": 123,
    "max_usd": 123
  },
  "disk_gb": 2,
  "gpu_count": 4,
  "image": "<string>",
  "startup_script_b64": "<string>",
  "env": {},
  "interconnect": "<string>",
  "name": "<string>",
  "ports": [
    "<string>"
  ],
  "providers": [
    "<string>"
  ],
  "secrets": [
    "<string>"
  ],
  "ssh_public_key": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accelerator: '<string>',
    deadline: {hours: 123, max_usd: 123},
    disk_gb: 2,
    gpu_count: 4,
    image: '<string>',
    startup_script_b64: '<string>',
    env: {},
    interconnect: '<string>',
    name: '<string>',
    ports: ['<string>'],
    providers: ['<string>'],
    secrets: ['<string>'],
    ssh_public_key: '<string>'
  })
};

fetch('https://apigw.mka1.com/api/v1/serving/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apigw.mka1.com/api/v1/serving/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accelerator' => '<string>',
    'deadline' => [
        'hours' => 123,
        'max_usd' => 123
    ],
    'disk_gb' => 2,
    'gpu_count' => 4,
    'image' => '<string>',
    'startup_script_b64' => '<string>',
    'env' => [
        
    ],
    'interconnect' => '<string>',
    'name' => '<string>',
    'ports' => [
        '<string>'
    ],
    'providers' => [
        '<string>'
    ],
    'secrets' => [
        '<string>'
    ],
    'ssh_public_key' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apigw.mka1.com/api/v1/serving/runs"

	payload := strings.NewReader("{\n  \"accelerator\": \"<string>\",\n  \"deadline\": {\n    \"hours\": 123,\n    \"max_usd\": 123\n  },\n  \"disk_gb\": 2,\n  \"gpu_count\": 4,\n  \"image\": \"<string>\",\n  \"startup_script_b64\": \"<string>\",\n  \"env\": {},\n  \"interconnect\": \"<string>\",\n  \"name\": \"<string>\",\n  \"ports\": [\n    \"<string>\"\n  ],\n  \"providers\": [\n    \"<string>\"\n  ],\n  \"secrets\": [\n    \"<string>\"\n  ],\n  \"ssh_public_key\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://apigw.mka1.com/api/v1/serving/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accelerator\": \"<string>\",\n  \"deadline\": {\n    \"hours\": 123,\n    \"max_usd\": 123\n  },\n  \"disk_gb\": 2,\n  \"gpu_count\": 4,\n  \"image\": \"<string>\",\n  \"startup_script_b64\": \"<string>\",\n  \"env\": {},\n  \"interconnect\": \"<string>\",\n  \"name\": \"<string>\",\n  \"ports\": [\n    \"<string>\"\n  ],\n  \"providers\": [\n    \"<string>\"\n  ],\n  \"secrets\": [\n    \"<string>\"\n  ],\n  \"ssh_public_key\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apigw.mka1.com/api/v1/serving/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accelerator\": \"<string>\",\n  \"deadline\": {\n    \"hours\": 123,\n    \"max_usd\": 123\n  },\n  \"disk_gb\": 2,\n  \"gpu_count\": 4,\n  \"image\": \"<string>\",\n  \"startup_script_b64\": \"<string>\",\n  \"env\": {},\n  \"interconnect\": \"<string>\",\n  \"name\": \"<string>\",\n  \"ports\": [\n    \"<string>\"\n  ],\n  \"providers\": [\n    \"<string>\"\n  ],\n  \"secrets\": [\n    \"<string>\"\n  ],\n  \"ssh_public_key\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "accelerator": "<string>",
  "deadline_at": "2023-11-07T05:31:56Z",
  "endpoint": "<string>",
  "exit_code": 123,
  "gpu_count": 123,
  "image": "<string>",
  "name": "<string>",
  "price_usd_hr": 123,
  "provider": "<string>",
  "reason": "<string>",
  "ssh": {
    "command": "<string>",
    "host": "<string>",
    "port": 123,
    "user": "<string>"
  },
  "started_at": "2023-11-07T05:31:56Z",
  "terminal_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Headers

X-On-Behalf-Of

string

Optional external end-user identifier forwarded by the API gateway.

Body

application/json

accelerator

string

required

Curated accelerator name. GET /accelerators lists what is available.

deadline

RunDeadline · object

required

Exactly one of hours or max_usd. Cost is rate x time and the rate is fixed at acquisition, so they are interchangeable — but they are not the same number. A max_usd deadline resolves only once acquisition fixes the rate.

Show child attributes

disk_gb

integer

required

Required, no default. Must fit the image plus whatever the script downloads; too small and the pod dies mid-download.

Required range: x >= 1

gpu_count

integer

required

Accelerators on one node. V1 is single-node: multi-node clusters are not offered by the providers we support.

Required range: 1 <= x <= 8

image

string

required

Any public image. It must contain bash, and on providers where we install sshd it must be Debian-family with apt.

kind

enum<string>

required

What the run is for. A fine-tune ends on its own and its exit code is the outcome; a deployment serves traffic and runs until it is deleted. They are one resource because they are one pod, one provider and one script — the kind selects terminal semantics, not a different machine.

Available options:

finetune,

deployment

startup_script_b64

string

required

Base64 bash. Run as a child process of our run script; its exit code is the run's outcome. Never interpreted.

env

Env · object

Environment for the workload. Keys in the MKA1_ namespace are reserved.

Show child attributes

interconnect

string

Optional filter on intra-node topology, e.g. nvlink. Tensor-parallel work is materially slower over PCIe.

name

string

ports

string[]

Container ports to expose, e.g. "8000/http". Meaningful for a deployment, which serves traffic; a fine-tune has nothing to expose.

providers

string[]

Ordered preference, tried in turn. Rejected while provider anonymity is enabled, because the list is itself a provider-identity leak.

secrets

string[]

Stored secret ids resolved into the environment immediately before hand-off.

ssh_public_key

string

Your own public key. We never generate or hold private key material. Omit and the run has no SSH.

Response

The run, accepted and submitted for acquisition.

created_at

string<date-time>

required

string

required

kind

enum<string>

required

Available options:

finetune,

deployment

state

enum<string>

required

Available options:

requested,

provisioning,

running,

succeeded,

failed,

terminated

accelerator

string

deadline_at

string<date-time>

endpoint

string

Where the workload serves, once it is running. Only a deployment declares ports, so only a deployment reports an endpoint.

exit_code

integer

The workload's exit status. Provider status is not trusted for this: one provider reports the VM rather than the container.

gpu_count

integer

image

string

name

string

price_usd_hr

number

provider

string

reason

string

Why the run is in this state, e.g. ssh_setup_failed or budget_exhausted.

ssh

RunSSH · object

Connection details. The login user is provider dependent and is read from the provider, never assumed.

Show child attributes

started_at

string<date-time>

terminal_at

string<date-time>

List runs

Get a run

⌘I

Overview

Responses API

Agents API

Platform APIs

Administration

Sandbox API

Serving API

Deprecated

Other

Create a run

Authorizations

Headers

Body

Response