Create Workspace Registry

POST

workspaces

{workspace}

workspace-registries

Create Workspace Registry

curl --request POST \
  --url https://api.example.com/v1/workspaces/{workspace}/workspace-registries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "source_url": "<string>",
  "credentials_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "mode": "mirror",
  "registry_type": "skills",
  "source_path": "<string>",
  "source_ref": "<string>",
  "trust": "private"
}
'

import requests

url = "https://api.example.com/v1/workspaces/{workspace}/workspace-registries"

payload = {
    "name": "<string>",
    "source_url": "<string>",
    "credentials_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "mode": "mirror",
    "registry_type": "skills",
    "source_path": "<string>",
    "source_ref": "<string>",
    "trust": "private"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    source_url: '<string>',
    credentials_secret_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    description: '<string>',
    mode: 'mirror',
    registry_type: 'skills',
    source_path: '<string>',
    source_ref: '<string>',
    trust: 'private'
  })
};

fetch('https://api.example.com/v1/workspaces/{workspace}/workspace-registries', 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.example.com/v1/workspaces/{workspace}/workspace-registries",
  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([
    'name' => '<string>',
    'source_url' => '<string>',
    'credentials_secret_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'description' => '<string>',
    'mode' => 'mirror',
    'registry_type' => 'skills',
    'source_path' => '<string>',
    'source_ref' => '<string>',
    'trust' => 'private'
  ]),
  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://api.example.com/v1/workspaces/{workspace}/workspace-registries"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"source_url\": \"<string>\",\n  \"credentials_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"mode\": \"mirror\",\n  \"registry_type\": \"skills\",\n  \"source_path\": \"<string>\",\n  \"source_ref\": \"<string>\",\n  \"trust\": \"private\"\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://api.example.com/v1/workspaces/{workspace}/workspace-registries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"source_url\": \"<string>\",\n  \"credentials_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"mode\": \"mirror\",\n  \"registry_type\": \"skills\",\n  \"source_path\": \"<string>\",\n  \"source_ref\": \"<string>\",\n  \"trust\": \"private\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/workspaces/{workspace}/workspace-registries")

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  \"name\": \"<string>\",\n  \"source_url\": \"<string>\",\n  \"credentials_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"mode\": \"mirror\",\n  \"registry_type\": \"skills\",\n  \"source_path\": \"<string>\",\n  \"source_ref\": \"<string>\",\n  \"trust\": \"private\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "item_count": 123,
  "last_sync_error": "<string>",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "mode": "mirror",
  "name": "<string>",
  "recommendation_priority": 123,
  "registry_type": "<string>",
  "scope": "platform",
  "source_type": "<string>",
  "source_url": "<string>",
  "sync_mode": "<string>",
  "trust": "official",
  "updated_at": "2023-11-07T05:31:56Z",
  "credentials_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_path": "<string>",
  "source_ref": "<string>",
  "workspace_id": "<string>"
}

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

Authorizations

Authorization

string

header

required

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

Path Parameters

workspace

string

required

Slug of the workspace the request acts in

Maximum string length: 120

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

name

string

required

Required string length: 1 - 255

source_type

enum<string>

required

'url': an index in the platform format; 'github': a repository

Available options:

url,

github

source_url

string

required

The index URL, or the repository as owner/repo

Minimum string length: 1

credentials_secret_id

string<uuid> | null

A workspace secret holding the token a private source is read with

description

string | null

mode

enum<string>

default:mirror

'mirror' stores every skill's content when the registry syncs, so an install needs no network; 'upstream' fetches it on first install. A source read with credentials is mirrored.

Available options:

mirror,

upstream

registry_type

enum<string>

default:skills

Available options:

skills,

agents

source_path

string | null

GitHub: the folder whose skill folders are indexed; the root if unset

source_ref

string | null

GitHub: branch, tag or commit; the default branch if unset

Maximum string length: 255

trust

enum<string>

default:private

Available options:

private,

community

Response

Successful Response

created_at

string<date-time>

required

description

string | null

required

string<uuid>

required

is_active

boolean

required

item_count

integer

required

last_sync_error

string | null

required

last_synced_at

string<date-time> | null

required

mode

enum<string>

required

Available options:

mirror,

upstream

name

string

required

recommendation_priority

integer

required

registry_type

string

required

scope

enum<string>

required

Available options:

platform,

workspace

source_type

string

required

source_url

string

required

sync_mode

string

required

trust

enum<string>

required

Available options:

official,

verified,

community,

private

updated_at

string<date-time>

required

credentials_secret_id

string<uuid> | null

source_path

string | null

source_ref

string | null

workspace_id

string | null

Create Workspace Registry

curl --request POST \
  --url https://api.example.com/v1/workspaces/{workspace}/workspace-registries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "source_url": "<string>",
  "credentials_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "mode": "mirror",
  "registry_type": "skills",
  "source_path": "<string>",
  "source_ref": "<string>",
  "trust": "private"
}
'

import requests

url = "https://api.example.com/v1/workspaces/{workspace}/workspace-registries"

payload = {
    "name": "<string>",
    "source_url": "<string>",
    "credentials_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "mode": "mirror",
    "registry_type": "skills",
    "source_path": "<string>",
    "source_ref": "<string>",
    "trust": "private"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    source_url: '<string>',
    credentials_secret_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    description: '<string>',
    mode: 'mirror',
    registry_type: 'skills',
    source_path: '<string>',
    source_ref: '<string>',
    trust: 'private'
  })
};

fetch('https://api.example.com/v1/workspaces/{workspace}/workspace-registries', 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.example.com/v1/workspaces/{workspace}/workspace-registries",
  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([
    'name' => '<string>',
    'source_url' => '<string>',
    'credentials_secret_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'description' => '<string>',
    'mode' => 'mirror',
    'registry_type' => 'skills',
    'source_path' => '<string>',
    'source_ref' => '<string>',
    'trust' => 'private'
  ]),
  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://api.example.com/v1/workspaces/{workspace}/workspace-registries"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"source_url\": \"<string>\",\n  \"credentials_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"mode\": \"mirror\",\n  \"registry_type\": \"skills\",\n  \"source_path\": \"<string>\",\n  \"source_ref\": \"<string>\",\n  \"trust\": \"private\"\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://api.example.com/v1/workspaces/{workspace}/workspace-registries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"source_url\": \"<string>\",\n  \"credentials_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"mode\": \"mirror\",\n  \"registry_type\": \"skills\",\n  \"source_path\": \"<string>\",\n  \"source_ref\": \"<string>\",\n  \"trust\": \"private\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/workspaces/{workspace}/workspace-registries")

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  \"name\": \"<string>\",\n  \"source_url\": \"<string>\",\n  \"credentials_secret_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"mode\": \"mirror\",\n  \"registry_type\": \"skills\",\n  \"source_path\": \"<string>\",\n  \"source_ref\": \"<string>\",\n  \"trust\": \"private\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "item_count": 123,
  "last_sync_error": "<string>",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "mode": "mirror",
  "name": "<string>",
  "recommendation_priority": 123,
  "registry_type": "<string>",
  "scope": "platform",
  "source_type": "<string>",
  "source_url": "<string>",
  "sync_mode": "<string>",
  "trust": "official",
  "updated_at": "2023-11-07T05:31:56Z",
  "credentials_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_path": "<string>",
  "source_ref": "<string>",
  "workspace_id": "<string>"
}

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

Start here

Concepts

Guides

Self-host

Reference

API reference

API endpoints

Community

Create Workspace Registry

Authorizations

Path Parameters

Body

Response