Skip to main content
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
website_evaluations
/
{id}
Retrieve website evaluation
curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "ai_summary": "<string>",
  "takeaways": [
    "<string>"
  ],
  "is_archived": true,
  "tags": [
    "<string>"
  ],
  "include_subpages": true,
  "status": "pending"
}

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

​
id
string<uuid>
required

A UUID string identifying this website evaluation.

​
organization_id
string
required
​
workspace_id
string<uuid>
required

Query Parameters

​
group_by
enum<string>

Optional parameter to group evaluation results. Accepted values are agent or url. If omitted, results are returned individually without aggregation.

Available options:
agent,
url

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
created_at
string<date-time>
required
read-only
​
workspace_id
string<uuid>
required
​
name
string
required
Maximum string length: 200
​
url
string<uri>
required
Maximum string length: 200
​
ai_summary
string | null
required
read-only
​
takeaways
string[]
required
read-only
Maximum string length: 500
​
is_archived
boolean
required
read-only
​
tags
string[]
Maximum string length: 200
​
include_subpages
boolean
​
status
enum<string>
  • pending - pending
  • in_progress - in progress
  • completed - completed
  • partial - partial
  • failed - failed
Available options:
pending,
in_progress,
completed,
partial,
failed