Filter workspaces
curl --request POST \
--url https://api.shareofmodel.ai/v1/workspaces/filter \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"module": "<string>",
"pencil_client_id": 123,
"pencil_client_uuid": "<string>",
"is_pencil": true
}
'import requests
url = "https://api.shareofmodel.ai/v1/workspaces/filter"
payload = {
"name": "<string>",
"module": "<string>",
"pencil_client_id": 123,
"pencil_client_uuid": "<string>",
"is_pencil": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
module: '<string>',
pencil_client_id: 123,
pencil_client_uuid: '<string>',
is_pencil: true
})
};
fetch('https://api.shareofmodel.ai/v1/workspaces/filter', 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.shareofmodel.ai/v1/workspaces/filter",
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>',
'module' => '<string>',
'pencil_client_id' => 123,
'pencil_client_uuid' => '<string>',
'is_pencil' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.shareofmodel.ai/v1/workspaces/filter"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"module\": \"<string>\",\n \"pencil_client_id\": 123,\n \"pencil_client_uuid\": \"<string>\",\n \"is_pencil\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.shareofmodel.ai/v1/workspaces/filter")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"module\": \"<string>\",\n \"pencil_client_id\": 123,\n \"pencil_client_uuid\": \"<string>\",\n \"is_pencil\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shareofmodel.ai/v1/workspaces/filter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"module\": \"<string>\",\n \"pencil_client_id\": 123,\n \"pencil_client_uuid\": \"<string>\",\n \"is_pencil\": true\n}"
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"logo": "<string>",
"is_pencil": true,
"pencil_client_id": 0,
"pencil_client_uuid": "<string>"
}
]Workspaces
Filter workspaces
Filter workspaces on given criteria. At least one of name, module, pencil_client_id, pencil_client_uuid, or is_pencil is required. The logo field is omitted unless include_logo=true.
POST
/
v1
/
workspaces
/
filter
Filter workspaces
curl --request POST \
--url https://api.shareofmodel.ai/v1/workspaces/filter \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"module": "<string>",
"pencil_client_id": 123,
"pencil_client_uuid": "<string>",
"is_pencil": true
}
'import requests
url = "https://api.shareofmodel.ai/v1/workspaces/filter"
payload = {
"name": "<string>",
"module": "<string>",
"pencil_client_id": 123,
"pencil_client_uuid": "<string>",
"is_pencil": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
module: '<string>',
pencil_client_id: 123,
pencil_client_uuid: '<string>',
is_pencil: true
})
};
fetch('https://api.shareofmodel.ai/v1/workspaces/filter', 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.shareofmodel.ai/v1/workspaces/filter",
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>',
'module' => '<string>',
'pencil_client_id' => 123,
'pencil_client_uuid' => '<string>',
'is_pencil' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.shareofmodel.ai/v1/workspaces/filter"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"module\": \"<string>\",\n \"pencil_client_id\": 123,\n \"pencil_client_uuid\": \"<string>\",\n \"is_pencil\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.shareofmodel.ai/v1/workspaces/filter")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"module\": \"<string>\",\n \"pencil_client_id\": 123,\n \"pencil_client_uuid\": \"<string>\",\n \"is_pencil\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shareofmodel.ai/v1/workspaces/filter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"module\": \"<string>\",\n \"pencil_client_id\": 123,\n \"pencil_client_uuid\": \"<string>\",\n \"is_pencil\": true\n}"
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"logo": "<string>",
"is_pencil": true,
"pencil_client_id": 0,
"pencil_client_uuid": "<string>"
}
]Authorizations
Query Parameters
If set to true, include the logo field in the response. Defaults to false.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data*/*
Response
200 - application/json
Maximum string length:
255Required range:
-9223372036854776000 <= x <= 9223372036854776000Maximum string length:
64Was this page helpful?
⌘I