get the draft

GET

agents

{agent_ref}

versions

draft

get the draft

curl --request GET \
  --url https://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft', 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://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "019f6b3f-8d2e-7c4b-af50-2b3c4d5e6f70",
  "versionNumber": 1,
  "name": "first cut",
  "status": "draft",
  "systemInstruction": "You are the support agent for {company}. Be brief and warm. When the caller asks for a human, {{transfer_call}}.",
  "greeting": "Hi, this is {company} support. How can I help?",
  "ttsConfig": {
    "model": "mulberry",
    "voice": "Emma",
    "description": "a female 30s american voice, normal pitch, warm timbre, conversational pacing, calm and reassuring, professional register, like a customer support agent."
  },
  "callSettings": {
    "background_noise": {
      "enabled": true,
      "volume": 30
    },
    "idle_ladder": {
      "enabled": true,
      "nudge_after_seconds": 5,
      "presence_after_seconds": 7,
      "hangup_after_seconds": 5
    }
  },
  "language": "english",
  "createdAt": "2026-09-11T10:00:00Z",
  "activatedAt": null,
  "updatedAt": "2026-09-11T10:05:00Z"
}

Authorizations

Authorization

string

header

required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Path Parameters

agent_ref

string

required

the agent's UUID or its ua_… handle.

Required string length: 1 - 64

Response

ok.

one config snapshot in an agent's history.

string<uuid>

required

versionNumber

integer

required

1 for the first deploy, counting up. a draft carries the number of the version it derives from.

status

enum<string>

required

draft (pending, not served), active (what the agent answers with) or archived.

Available options:

draft,

active,

archived

systemInstruction

string

required

greeting

string

required

ttsConfig

AgentTtsConfig · object

required

the voice an agent speaks with.

Show child attributes

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

callSettings

AgentCallSettings · object

call behaviour, versioned with the rest of the config.

Show child attributes

name

string | null

the version's name, or null (the dashboard shows v{versionNumber}).

language

string | null

activatedAt

string<date-time> | null

when the version first went live; null for a version never deployed.

get the draft

curl --request GET \
  --url https://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft', 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://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://silk-api.rumik.ai/v1/agents/{agent_ref}/versions/draft")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "019f6b3f-8d2e-7c4b-af50-2b3c4d5e6f70",
  "versionNumber": 1,
  "name": "first cut",
  "status": "draft",
  "systemInstruction": "You are the support agent for {company}. Be brief and warm. When the caller asks for a human, {{transfer_call}}.",
  "greeting": "Hi, this is {company} support. How can I help?",
  "ttsConfig": {
    "model": "mulberry",
    "voice": "Emma",
    "description": "a female 30s american voice, normal pitch, warm timbre, conversational pacing, calm and reassuring, professional register, like a customer support agent."
  },
  "callSettings": {
    "background_noise": {
      "enabled": true,
      "volume": 30
    },
    "idle_ladder": {
      "enabled": true,
      "nudge_after_seconds": 5,
      "presence_after_seconds": 7,
      "hangup_after_seconds": 5
    }
  },
  "language": "english",
  "createdAt": "2026-09-11T10:00:00Z",
  "activatedAt": null,
  "updatedAt": "2026-09-11T10:05:00Z"
}

documentation

sdk

integrations

cookbook

api reference

Authorizations

Path Parameters

Response