Skip to main content
POST
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
asset_evaluations
Create asset evaluation
curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "source": "gpt-4o",
  "brand": "<string>",
  "category": "<string>",
  "attributes": [
    "<string>"
  ],
  "assets_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "communication_type": "Brand Taglines",
  "content_type": "image",
  "persona": "<string>",
  "description": "<string>",
  "callback_url": "<string>",
  "tags": [
    "<string>"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "source": "gpt-3.5-turbo",
  "brand": "<string>",
  "category": "<string>",
  "persona": "<string>",
  "status": "pending",
  "attributes": [
    "<string>"
  ],
  "description": "<string>",
  "is_archived": true,
  "communication_type": "<string>",
  "tags": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

Base for all the serializers in the assets app

​
name
string
required
​
source
enum<string>
required

AI model that should perform the evaluation

  • gpt-4o - gpt 4o
  • gpt-5 - gpt 5
  • gpt-5.2 - gpt 5.2
  • gpt-5.4-mini - gpt 5.4 mini
  • gemini-2.0-flash - gemini 2.0 flash
  • gemini-2.5-flash - gemini 2.5 flash
  • gemini-3-flash-preview - gemini 3 flash preview
  • meta-llama-3.3-70B-instruct-turbo - meta llama 3.3 70B instruct turbo
  • meta-llama-4-maverick - meta llama 4 maverick
Available options:
gpt-4o,
gpt-5,
gpt-5.2,
gpt-5.4-mini,
gemini-2.0-flash,
gemini-2.5-flash,
gemini-3-flash-preview,
meta-llama-3.3-70B-instruct-turbo,
meta-llama-4-maverick
​
brand
string
required
​
category
string
required

The category that best describes the type of product or service the brand offers

​
attributes
string[]
required
Required array length: 3 - 6 elements
​
assets_ids
string<uuid>[]
required
Required array length: 1 - 10 elements
​
communication_type
enum<string>
required

Type of communication the asset is related to

  • Brand Taglines - Brand Taglines
  • Social Media Captions - Social Media Captions
  • Campaign Messaging - Campaign Messaging
  • Email Campaign Copy - Email Campaign Copy
  • Landing Page Headlines - Landing Page Headlines
  • Product Descriptions - Product Descriptions
  • Blog Post - Blog Post
  • Other Text Category - Other Text Category
  • Campaign Visuals - Campaign Visuals
  • Social Media Ads - Social Media Ads
  • Website Page - Website Page
  • Product Feature Highlights - Product Feature Highlights
  • Display Banners - Display Banners
  • Not Specified Image - Not Specified Image
  • Social Media Shorts - Social Media Shorts
  • Customer Testimonial - Customer Testimonial
  • Campaign Ads - Campaign Ads
  • YouTube Video - YouTube Video
  • User-Generated Content - User Generated Content
  • Other Video Category - Other Video Category
Available options:
Brand Taglines,
Social Media Captions,
Campaign Messaging,
Email Campaign Copy,
Landing Page Headlines,
Product Descriptions,
Blog Post,
Other Text Category,
Campaign Visuals,
Social Media Ads,
Website Page,
Product Feature Highlights,
Display Banners,
Not Specified Image,
Social Media Shorts,
Customer Testimonial,
Campaign Ads,
YouTube Video,
User-Generated Content,
Other Video Category
​
content_type
enum<string>
required
  • image - image
  • text - text
  • video - video
Available options:
image,
text,
video
​
persona
string

Persona considered for the evaluation, example: '{age} {gender} {interest or habits}'

​
description
string
​
callback_url
string

URL to send the evaluation result to

​
tags
string[]

Optional list of tags for the asset evaluation

Maximum string length: 255

Response

201 - application/json
​
id
string<uuid>
required
read-only
​
created_at
string<date-time>
required
read-only
​
created_by
string<uuid>
required
​
workspace_id
string<uuid>
required
​
name
string
required
Maximum string length: 255
​
source
enum<string>
required
  • gpt-3.5-turbo - gpt 3.5 turbo
  • gpt-4-turbo - gpt 4 turbo
  • gpt-4o - gpt 4o
  • gpt-4o-mini-search - gpt 4o mini search
  • gpt-5 - gpt 5
  • gpt-5.2 - gpt 5.2
  • gpt-5.4-mini - gpt 5.4 mini
  • gemini-1.5-pro - gemini 1.5 pro
  • gemini-2.0-flash - gemini 2.0 flash
  • gemini-2.5-flash-grounded - gemini 2.5 flash grounded
  • gemini-2.5-flash - gemini 2.5 flash
  • gemini-2.5-flash-lite - gemini 2.5 flash lite
  • gemini-3-flash-preview - gemini 3 flash preview
  • meta-llama-3.1-70B-instruct-turbo - meta llama 3.1 70B instruct turbo
  • meta-llama-3.2-70B-instruct-turbo - meta llama 3.2 70B instruct turbo
  • meta-llama-3.3-70B-instruct-turbo - meta llama 3.3 70B instruct turbo
  • meta-llama-4-maverick - meta llama 4 maverick
  • mistral-7B-instruct - mistral 7B instruct
  • claude-3-5-sonnet - claude 3 5 sonnet
  • claude-4-sonnet - claude 4 sonnet
  • claude-4-5-sonnet - claude 4 5 sonnet
  • claude-4-6-sonnet - claude 4 6 sonnet
  • deepseek-chat - deepseek chat
  • deepseek-reasoner - deepseek reasoner
  • perplexity-sonar - perplexity sonar
  • rufus - rufus
  • google-ai-mode - google ai mode
Available options:
gpt-3.5-turbo,
gpt-4-turbo,
gpt-4o,
gpt-4o-mini-search,
gpt-5,
gpt-5.2,
gpt-5.4-mini,
gemini-1.5-pro,
gemini-2.0-flash,
gemini-2.5-flash-grounded,
gemini-2.5-flash,
gemini-2.5-flash-lite,
gemini-3-flash-preview,
meta-llama-3.1-70B-instruct-turbo,
meta-llama-3.2-70B-instruct-turbo,
meta-llama-3.3-70B-instruct-turbo,
meta-llama-4-maverick,
mistral-7B-instruct,
claude-3-5-sonnet,
claude-4-sonnet,
claude-4-5-sonnet,
claude-4-6-sonnet,
deepseek-chat,
deepseek-reasoner,
perplexity-sonar,
rufus,
google-ai-mode
​
brand
string
required
Maximum string length: 255
​
category
string
required
Maximum string length: 255
​
persona
string
required
Maximum string length: 255
​
status
enum<string>
  • pending - pending
  • in_progress - in progress
  • completed - completed
  • partial - partial
  • failed - failed
Available options:
pending,
in_progress,
completed,
partial,
failed
​
attributes
string[]
Maximum string length: 255
​
description
string
​
is_archived
boolean
​
communication_type
string
Maximum string length: 255
​
tags
string[]
Maximum string length: 255