Create

POST

config_schemas

Python

import os
from miru_platform_sdk import Miru

client = Miru(
    api_key=os.environ.get("MIRU_API_KEY"),  # This is the default and can be omitted
)
config_schema = client.config_schemas.create(
    config_type_ref={},
    documents=[{
        "data": "data",
        "name": "motion-control.json",
    }],
    format="json",
    language="jsonschema",
)
print(config_schema.id)

curl --request POST \
  --url https://api.mirurobotics.com/beta/config_schemas \
  --header 'Content-Type: application/json' \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "config_type_ref": {
    "id": "cfg_123",
    "slug": "my-config-type"
  },
  "language": "jsonschema",
  "documents": [
    {
      "name": "motion-control.json",
      "data": "<string>"
    }
  ],
  "instance_filepath": "/srv/miru/configs/v1/motion-control.json"
}
'

const options = {
  method: 'POST',
  headers: {
    'Miru-Version': '<miru-version>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    config_type_ref: {id: 'cfg_123', slug: 'my-config-type'},
    language: 'jsonschema',
    documents: [{name: 'motion-control.json', data: '<string>'}],
    instance_filepath: '/srv/miru/configs/v1/motion-control.json'
  })
};

fetch('https://api.mirurobotics.com/beta/config_schemas', 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://api.mirurobotics.com/beta/config_schemas",
  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([
    'config_type_ref' => [
        'id' => 'cfg_123',
        'slug' => 'my-config-type'
    ],
    'language' => 'jsonschema',
    'documents' => [
        [
                'name' => 'motion-control.json',
                'data' => '<string>'
        ]
    ],
    'instance_filepath' => '/srv/miru/configs/v1/motion-control.json'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Miru-Version: <miru-version>",
    "X-API-Key: <api-key>"
  ],
]);

$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://api.mirurobotics.com/beta/config_schemas"

	payload := strings.NewReader("{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_filepath\": \"/srv/miru/configs/v1/motion-control.json\"\n}")

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

	req.Header.Add("Miru-Version", "<miru-version>")
	req.Header.Add("X-API-Key", "<api-key>")
	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://api.mirurobotics.com/beta/config_schemas")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_filepath\": \"/srv/miru/configs/v1/motion-control.json\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/config_schemas")

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

request = Net::HTTP::Post.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_filepath\": \"/srv/miru/configs/v1/motion-control.json\"\n}"

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

{
  "object": "config_schema",
  "id": "cfg_sch_123",
  "digest": "sha256:1234567890",
  "config_type_name": "Motion Control",
  "instance_filepath": "/srv/miru/configs/v1/motion-control.json",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "config_type_id": "cfg_typ_123",
  "language": "jsonschema",
  "format": "json"
}

Scope	Required
`config_schemas:write`	Yes

Consider using the Miru CLI in a CI/CD pipeline to create config schemas instead of calling this endpoint directly.

Authorizations

X-API-Key

string

header

required

The API key to use for authentication.

Headers

Miru-Version

string

required

The API version the client was built against.

Example:

"2026-05-06.rainier"

Query Parameters

expand

enum<string>[]

Fields to expand on the config schema resource.

Available options:

documents,

config_type

Example:

["documents"]

Body

application/json

config_type_ref

Config Type Reference · object

required

A reference to a config type. At least one of id or slug must be provided. When both are provided, id takes precedence and slug is ignored.

Show child attributes

language

enum<string>

required

Available options:

jsonschema,

cue

Example:

"jsonschema"

format

enum<string>

required

Available options:

json,

yaml,

cue

documents

Schema Document · object[]

required

The schema document files.

Show child attributes

instance_filepath

string

The absolute file system path config instances for this schema are written to.

Example:

"/srv/miru/configs/v1/motion-control.json"

git_commit

Git Commit Request · object

The git commit to link to this config schema.

Show child attributes

Response

200 - application/json

Successfully created the config schema.

object

enum<string>

required

The object type, which is always config_schema.

Available options:

config_schema

Example:

"config_schema"

string

required

ID of the config schema.

Example:

"cfg_sch_123"

digest

string

required

The digest of the config schema.

Example:

"sha256:1234567890"

config_type_name

string

required

The name of the config type.

Example:

"Motion Control"

instance_filepath

string

required

The absolute file system path where config instances for this schema are written.

Example:

"/srv/miru/configs/v1/motion-control.json"

created_at

string<date-time>

required

Timestamp of when the config schema was created.

Example:

"2021-01-01T00:00:00Z"

updated_at

string<date-time>

required

Timestamp of when the config schema was last updated.

Example:

"2021-01-01T00:00:00Z"

config_type_id

string

required

ID of the config type.

Example:

"cfg_typ_123"

language

enum<string>

required

Available options:

jsonschema,

cue

Example:

"jsonschema"

format

enum<string>

required

Available options:

json,

yaml,

cue

documents

Schema Document · object[]

Expand the config schema documents using expand=documents in the query string.

Show child attributes

Example:

[
  {
    "id": "doc_123",
    "name": "main.json",
    "data": "{\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"type\": \"object\"\n}\n"
  }
]

config_type

Config Type · object

Expand the config type using 'expand=config_type' in the query string.

Show child attributes

Example:

{
  "object": "config_type",
  "id": "cfg_typ_123",
  "name": "Motion Control",
  "slug": "motion-control",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

Last modified on May 27, 2026

GetRetrieve a config type by ID.

⌘I

Python

import os
from miru_platform_sdk import Miru

client = Miru(
    api_key=os.environ.get("MIRU_API_KEY"),  # This is the default and can be omitted
)
config_schema = client.config_schemas.create(
    config_type_ref={},
    documents=[{
        "data": "data",
        "name": "motion-control.json",
    }],
    format="json",
    language="jsonschema",
)
print(config_schema.id)

curl --request POST \
  --url https://api.mirurobotics.com/beta/config_schemas \
  --header 'Content-Type: application/json' \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "config_type_ref": {
    "id": "cfg_123",
    "slug": "my-config-type"
  },
  "language": "jsonschema",
  "documents": [
    {
      "name": "motion-control.json",
      "data": "<string>"
    }
  ],
  "instance_filepath": "/srv/miru/configs/v1/motion-control.json"
}
'

const options = {
  method: 'POST',
  headers: {
    'Miru-Version': '<miru-version>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    config_type_ref: {id: 'cfg_123', slug: 'my-config-type'},
    language: 'jsonschema',
    documents: [{name: 'motion-control.json', data: '<string>'}],
    instance_filepath: '/srv/miru/configs/v1/motion-control.json'
  })
};

fetch('https://api.mirurobotics.com/beta/config_schemas', 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://api.mirurobotics.com/beta/config_schemas",
  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([
    'config_type_ref' => [
        'id' => 'cfg_123',
        'slug' => 'my-config-type'
    ],
    'language' => 'jsonschema',
    'documents' => [
        [
                'name' => 'motion-control.json',
                'data' => '<string>'
        ]
    ],
    'instance_filepath' => '/srv/miru/configs/v1/motion-control.json'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Miru-Version: <miru-version>",
    "X-API-Key: <api-key>"
  ],
]);

$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://api.mirurobotics.com/beta/config_schemas"

	payload := strings.NewReader("{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_filepath\": \"/srv/miru/configs/v1/motion-control.json\"\n}")

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

	req.Header.Add("Miru-Version", "<miru-version>")
	req.Header.Add("X-API-Key", "<api-key>")
	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://api.mirurobotics.com/beta/config_schemas")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_filepath\": \"/srv/miru/configs/v1/motion-control.json\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/config_schemas")

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

request = Net::HTTP::Post.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_filepath\": \"/srv/miru/configs/v1/motion-control.json\"\n}"

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

{
  "object": "config_schema",
  "id": "cfg_sch_123",
  "digest": "sha256:1234567890",
  "config_type_name": "Motion Control",
  "instance_filepath": "/srv/miru/configs/v1/motion-control.json",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "config_type_id": "cfg_typ_123",
  "language": "jsonschema",
  "format": "json"
}

Config Instances

Config Schemas

Config Types

Deployments

Devices

Provisioning Tokens

Git Commits

Principals

Releases

Authorizations

Headers

Query Parameters

Body

Response