Deployments
Create a provider-managed deployment
POST
/
api
/
v1
/
deployments
Create a provider-managed deployment
curl --request POST \
--url http://127.0.0.1:18000/api/v1/deployments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"model": "<string>",
"name": "<string>",
"cloud": "<string>",
"gpu": "<string>",
"max_replicas": 1,
"min_replicas": 1,
"model_revision": "<string>",
"port": 32768,
"provider_adapter": "<string>",
"region": "<string>",
"runtime": "vllm",
"runtime_args": [
"<string>"
],
"runtime_version": "<string>"
}
'import requests
url = "http://127.0.0.1:18000/api/v1/deployments"
payload = {
"model": "<string>",
"name": "<string>",
"cloud": "<string>",
"gpu": "<string>",
"max_replicas": 1,
"min_replicas": 1,
"model_revision": "<string>",
"port": 32768,
"provider_adapter": "<string>",
"region": "<string>",
"runtime": "vllm",
"runtime_args": ["<string>"],
"runtime_version": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
model: '<string>',
name: '<string>',
cloud: '<string>',
gpu: '<string>',
max_replicas: 1,
min_replicas: 1,
model_revision: '<string>',
port: 32768,
provider_adapter: '<string>',
region: '<string>',
runtime: 'vllm',
runtime_args: ['<string>'],
runtime_version: '<string>'
})
};
fetch('http://127.0.0.1:18000/api/v1/deployments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:18000/api/v1/deployments"
payload := strings.NewReader("{\n \"model\": \"<string>\",\n \"name\": \"<string>\",\n \"cloud\": \"<string>\",\n \"gpu\": \"<string>\",\n \"max_replicas\": 1,\n \"min_replicas\": 1,\n \"model_revision\": \"<string>\",\n \"port\": 32768,\n \"provider_adapter\": \"<string>\",\n \"region\": \"<string>\",\n \"runtime\": \"vllm\",\n \"runtime_args\": [\n \"<string>\"\n ],\n \"runtime_version\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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))
}{
"operation": {
"id": "<string>",
"kind": "<string>",
"progress": 50,
"attempt": 123,
"cancel_requested": true,
"created_at": "2023-11-07T05:31:56Z",
"error_code": "<string>",
"max_attempts": 123,
"message": "<string>",
"resource_name": "<string>",
"resource_type": "<string>",
"retryable": true,
"updated_at": "2023-11-07T05:31:56Z"
},
"created": true,
"deployment": {
"model": "<string>",
"name": "<string>",
"runtime": "<string>",
"active_revision_id": "<string>",
"candidate_revision_id": "<string>",
"id": "<string>",
"max_replicas": 123,
"min_replicas": 123,
"observed_state": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"category": "<string>",
"remediation": "<string>",
"request_id": "<string>",
"retryable": true
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Stable key used to adopt the original durable operation after retries or disconnects.
Maximum string length:
128Body
application/json
Available options:
elastic, serverless Required range:
x >= 0Required range:
x >= 0Required range:
1 <= x <= 65535Exact provider profile for this immutable revision; omit only when the cloud/runtime default is unambiguous.
Available options:
vllm, sglang, custom-oci Show child attributes
Show child attributes
⌘I
Create a provider-managed deployment
curl --request POST \
--url http://127.0.0.1:18000/api/v1/deployments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"model": "<string>",
"name": "<string>",
"cloud": "<string>",
"gpu": "<string>",
"max_replicas": 1,
"min_replicas": 1,
"model_revision": "<string>",
"port": 32768,
"provider_adapter": "<string>",
"region": "<string>",
"runtime": "vllm",
"runtime_args": [
"<string>"
],
"runtime_version": "<string>"
}
'import requests
url = "http://127.0.0.1:18000/api/v1/deployments"
payload = {
"model": "<string>",
"name": "<string>",
"cloud": "<string>",
"gpu": "<string>",
"max_replicas": 1,
"min_replicas": 1,
"model_revision": "<string>",
"port": 32768,
"provider_adapter": "<string>",
"region": "<string>",
"runtime": "vllm",
"runtime_args": ["<string>"],
"runtime_version": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
model: '<string>',
name: '<string>',
cloud: '<string>',
gpu: '<string>',
max_replicas: 1,
min_replicas: 1,
model_revision: '<string>',
port: 32768,
provider_adapter: '<string>',
region: '<string>',
runtime: 'vllm',
runtime_args: ['<string>'],
runtime_version: '<string>'
})
};
fetch('http://127.0.0.1:18000/api/v1/deployments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:18000/api/v1/deployments"
payload := strings.NewReader("{\n \"model\": \"<string>\",\n \"name\": \"<string>\",\n \"cloud\": \"<string>\",\n \"gpu\": \"<string>\",\n \"max_replicas\": 1,\n \"min_replicas\": 1,\n \"model_revision\": \"<string>\",\n \"port\": 32768,\n \"provider_adapter\": \"<string>\",\n \"region\": \"<string>\",\n \"runtime\": \"vllm\",\n \"runtime_args\": [\n \"<string>\"\n ],\n \"runtime_version\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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))
}{
"operation": {
"id": "<string>",
"kind": "<string>",
"progress": 50,
"attempt": 123,
"cancel_requested": true,
"created_at": "2023-11-07T05:31:56Z",
"error_code": "<string>",
"max_attempts": 123,
"message": "<string>",
"resource_name": "<string>",
"resource_type": "<string>",
"retryable": true,
"updated_at": "2023-11-07T05:31:56Z"
},
"created": true,
"deployment": {
"model": "<string>",
"name": "<string>",
"runtime": "<string>",
"active_revision_id": "<string>",
"candidate_revision_id": "<string>",
"id": "<string>",
"max_replicas": 123,
"min_replicas": 123,
"observed_state": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"category": "<string>",
"remediation": "<string>",
"request_id": "<string>",
"retryable": true
}
}