Create workspace

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "analysis_quota": 0,
  "asset_evaluation_quota": 0,
  "geo_audit_quota": 0,
  "search_credits": 0,
  "logo": "<string>"
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces"

payload = {
    "name": "<string>",
    "analysis_quota": 0,
    "asset_evaluation_quota": 0,
    "geo_audit_quota": 0,
    "search_credits": 0,
    "logo": "<string>"
}
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>',
    analysis_quota: 0,
    asset_evaluation_quota: 0,
    geo_audit_quota: 0,
    search_credits: 0,
    logo: '<string>'
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces', 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/organizations/{organization_id}/workspaces",
  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>',
    'analysis_quota' => 0,
    'asset_evaluation_quota' => 0,
    'geo_audit_quota' => 0,
    'search_credits' => 0,
    'logo' => '<string>'
  ]),
  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/organizations/{organization_id}/workspaces"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"analysis_quota\": 0,\n  \"asset_evaluation_quota\": 0,\n  \"geo_audit_quota\": 0,\n  \"search_credits\": 0,\n  \"logo\": \"<string>\"\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/organizations/{organization_id}/workspaces")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"analysis_quota\": 0,\n  \"asset_evaluation_quota\": 0,\n  \"geo_audit_quota\": 0,\n  \"search_credits\": 0,\n  \"logo\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces")

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  \"analysis_quota\": 0,\n  \"asset_evaluation_quota\": 0,\n  \"geo_audit_quota\": 0,\n  \"search_credits\": 0,\n  \"logo\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "is_active": true,
  "analysis_quota": 1073741823,
  "asset_evaluation_quota": 1073741823,
  "geo_audit_quota": 1073741823,
  "search_credits": 1073741823,
  "search_project_credits": 1073741823,
  "logo": "<string>",
  "is_pencil": true,
  "pencil_client_id": 0,
  "pencil_client_uuid": "<string>"
}

POST

organizations

{organization_id}

workspaces

Create workspace

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "analysis_quota": 0,
  "asset_evaluation_quota": 0,
  "geo_audit_quota": 0,
  "search_credits": 0,
  "logo": "<string>"
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces"

payload = {
    "name": "<string>",
    "analysis_quota": 0,
    "asset_evaluation_quota": 0,
    "geo_audit_quota": 0,
    "search_credits": 0,
    "logo": "<string>"
}
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>',
    analysis_quota: 0,
    asset_evaluation_quota: 0,
    geo_audit_quota: 0,
    search_credits: 0,
    logo: '<string>'
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces', 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/organizations/{organization_id}/workspaces",
  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>',
    'analysis_quota' => 0,
    'asset_evaluation_quota' => 0,
    'geo_audit_quota' => 0,
    'search_credits' => 0,
    'logo' => '<string>'
  ]),
  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/organizations/{organization_id}/workspaces"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"analysis_quota\": 0,\n  \"asset_evaluation_quota\": 0,\n  \"geo_audit_quota\": 0,\n  \"search_credits\": 0,\n  \"logo\": \"<string>\"\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/organizations/{organization_id}/workspaces")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"analysis_quota\": 0,\n  \"asset_evaluation_quota\": 0,\n  \"geo_audit_quota\": 0,\n  \"search_credits\": 0,\n  \"logo\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces")

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  \"analysis_quota\": 0,\n  \"asset_evaluation_quota\": 0,\n  \"geo_audit_quota\": 0,\n  \"search_credits\": 0,\n  \"logo\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "is_active": true,
  "analysis_quota": 1073741823,
  "asset_evaluation_quota": 1073741823,
  "geo_audit_quota": 1073741823,
  "search_credits": 1073741823,
  "search_project_credits": 1073741823,
  "logo": "<string>",
  "is_pencil": true,
  "pencil_client_id": 0,
  "pencil_client_uuid": "<string>"
}

Authorizations

Authorization

string

header

required

Path Parameters

organization_id

string<uuid>

required

A UUID string identifying the organization.

Query Parameters

include_logo

boolean

If set to true, include the logo field in the response. Defaults to false.

Body

name

string

required

Maximum string length: 255

analysis_quota

integer

default:0

asset_evaluation_quota

integer

default:0

geo_audit_quota

integer

default:0

search_credits

integer

default:0

logo

string | null

Binary content of the logo encoded in base64 with appropriate header ex: data:image/png;base64,XXXXXX

Response

201 - application/json

string<uuid>

required

read-only

name

string

required

Maximum string length: 255

is_active

boolean

analysis_quota

integer