Create analysis

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand": "<string>",
  "category": "<string>",
  "competitors": [
    "<string>"
  ],
  "countries": [],
  "llm_providers": [],
  "name": "<string>",
  "personas": [
    "General Population"
  ],
  "attributes": [
    "<string>"
  ],
  "collect_end_date": "2023-12-25",
  "language": "en",
  "is_boost": false
}
'

import requests

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

payload = {
    "brand": "<string>",
    "category": "<string>",
    "competitors": ["<string>"],
    "countries": [],
    "llm_providers": [],
    "name": "<string>",
    "personas": ["General Population"],
    "attributes": ["<string>"],
    "collect_end_date": "2023-12-25",
    "language": "en",
    "is_boost": False
}
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({
    brand: '<string>',
    category: '<string>',
    competitors: ['<string>'],
    countries: [],
    llm_providers: [],
    name: '<string>',
    personas: ['General Population'],
    attributes: ['<string>'],
    collect_end_date: '2023-12-25',
    language: 'en',
    is_boost: false
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses', 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/{workspace_id}/analyses",
  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([
    'brand' => '<string>',
    'category' => '<string>',
    'competitors' => [
        '<string>'
    ],
    'countries' => [
        
    ],
    'llm_providers' => [
        
    ],
    'name' => '<string>',
    'personas' => [
        'General Population'
    ],
    'attributes' => [
        '<string>'
    ],
    'collect_end_date' => '2023-12-25',
    'language' => 'en',
    'is_boost' => false
  ]),
  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/{workspace_id}/analyses"

	payload := strings.NewReader("{\n  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"countries\": [],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"General Population\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\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/{workspace_id}/analyses")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"countries\": [],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"General Population\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"countries\": [],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"General Population\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "brand": "<string>",
  "category": "<string>",
  "countries": [
    "<string>"
  ],
  "competitors": [
    "<string>"
  ],
  "personas": [
    "<string>"
  ],
  "attributes": [
    "<string>"
  ],
  "is_archived": true,
  "archived_at": "2023-11-07T05:31:56Z",
  "active_clustering": true,
  "collect_end_date": "2023-12-25",
  "llm_providers": [
    "<string>"
  ],
  "llm_provider_versions": "<unknown>",
  "is_boost": true,
  "generation_cost": -1
}

POST

organizations

{organization_id}

workspaces

{workspace_id}

analyses

Create analysis

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand": "<string>",
  "category": "<string>",
  "competitors": [
    "<string>"
  ],
  "countries": [],
  "llm_providers": [],
  "name": "<string>",
  "personas": [
    "General Population"
  ],
  "attributes": [
    "<string>"
  ],
  "collect_end_date": "2023-12-25",
  "language": "en",
  "is_boost": false
}
'

import requests

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

payload = {
    "brand": "<string>",
    "category": "<string>",
    "competitors": ["<string>"],
    "countries": [],
    "llm_providers": [],
    "name": "<string>",
    "personas": ["General Population"],
    "attributes": ["<string>"],
    "collect_end_date": "2023-12-25",
    "language": "en",
    "is_boost": False
}
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({
    brand: '<string>',
    category: '<string>',
    competitors: ['<string>'],
    countries: [],
    llm_providers: [],
    name: '<string>',
    personas: ['General Population'],
    attributes: ['<string>'],
    collect_end_date: '2023-12-25',
    language: 'en',
    is_boost: false
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses', 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/{workspace_id}/analyses",
  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([
    'brand' => '<string>',
    'category' => '<string>',
    'competitors' => [
        '<string>'
    ],
    'countries' => [
        
    ],
    'llm_providers' => [
        
    ],
    'name' => '<string>',
    'personas' => [
        'General Population'
    ],
    'attributes' => [
        '<string>'
    ],
    'collect_end_date' => '2023-12-25',
    'language' => 'en',
    'is_boost' => false
  ]),
  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/{workspace_id}/analyses"

	payload := strings.NewReader("{\n  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"countries\": [],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"General Population\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\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/{workspace_id}/analyses")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"countries\": [],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"General Population\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"countries\": [],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"General Population\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "brand": "<string>",
  "category": "<string>",
  "countries": [
    "<string>"
  ],
  "competitors": [
    "<string>"
  ],
  "personas": [
    "<string>"
  ],
  "attributes": [
    "<string>"
  ],
  "is_archived": true,
  "archived_at": "2023-11-07T05:31:56Z",
  "active_clustering": true,
  "collect_end_date": "2023-12-25",
  "llm_providers": [
    "<string>"
  ],
  "llm_provider_versions": "<unknown>",
  "is_boost": true,
  "generation_cost": -1
}

Authorizations

Authorization

string

header

required

Path Parameters

organization_id

string<uuid>

required

A UUID string identifying the organization.

workspace_id

string<uuid>

required

A UUID string identifying the workspace.

Body

brand

string

required

Response

201 - application/json

string<uuid>

required

read-only

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

created_by

string<uuid>

required

workspace_id

string<uuid>

required

name

string

required

Maximum string length: 255

brand

string

required

Maximum string length: 255

Overview

Core API

Search API

Create analysis

Authorizations

Path Parameters

Body

Response