curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions \
--header 'Authorization: <api-key>'[
{
"description": "<string>",
"details": "<string>",
"opportunity": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"action": {
"id": "<string>",
"opportunity_id": "<string>",
"name": "<string>",
"trigger_rules": "<string>",
"recommendation_rules": "<string>",
"channel": "<string>",
"criticality_rule": "<string>",
"impact_rule": "<string>",
"effort_rule": "<string>",
"timeline_rule": "<string>",
"active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"pipeline_run_id": "<string>",
"organization_id": "<string>",
"workspace_id": "<string>",
"team": [
"<string>"
],
"effort": "<string>",
"impact": "<string>",
"criticality": "<string>",
"timeline": "<string>",
"reasoning": "<string>",
"channel": "<string>",
"category": "<string>",
"brand": "<string>",
"country": "<string>",
"score": 123,
"action_label": "<string>",
"tasks": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"recommended_action_result_id": "<string>",
"brief_template_id": "<string>",
"brief_body": "",
"sort_order": 0,
"created_at": "2023-11-07T05:31:56Z"
}
],
"brief_generation_status": "not-started",
"workflow_status": "new"
}
]List recommended actions
Returns the list of recommended actions from the database.
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions \
--header 'Authorization: <api-key>'[
{
"description": "<string>",
"details": "<string>",
"opportunity": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"action": {
"id": "<string>",
"opportunity_id": "<string>",
"name": "<string>",
"trigger_rules": "<string>",
"recommendation_rules": "<string>",
"channel": "<string>",
"criticality_rule": "<string>",
"impact_rule": "<string>",
"effort_rule": "<string>",
"timeline_rule": "<string>",
"active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"pipeline_run_id": "<string>",
"organization_id": "<string>",
"workspace_id": "<string>",
"team": [
"<string>"
],
"effort": "<string>",
"impact": "<string>",
"criticality": "<string>",
"timeline": "<string>",
"reasoning": "<string>",
"channel": "<string>",
"category": "<string>",
"brand": "<string>",
"country": "<string>",
"score": 123,
"action_label": "<string>",
"tasks": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"recommended_action_result_id": "<string>",
"brief_template_id": "<string>",
"brief_body": "",
"sort_order": 0,
"created_at": "2023-11-07T05:31:56Z"
}
],
"brief_generation_status": "not-started",
"workflow_status": "new"
}
]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
Path Parameters
Organization identifier
Workspace identifier
Query Parameters
Filter by brand
Filter by category
Filter by channel
Filter by country
Filter by opportunity
Filter by score
Filter by team
Filter by workflow status bucket. One of: new (default queue), confirmed (my plan), dismissed. Omit to return all statuses.
confirmed, dismissed, new Response
List of recommended actions
Detailed description of the action
Detailed markdown tasks and examples
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Recommended action result UUID
Recommendation pipeline run UUID that produced this result, if any
Organization ID
Workspace ID
Teams responsible for the action
Effort required to perform the action
Impact of the action on the brand
Criticality level of the action
Timeline required to perform the action
Reasoning behind the recommendation
Channel this action relates to
Category this action relates to
Brand this action relates to
Country this action relates to
Score from 0 to 100
Human-readable contextual title for the recommendation
Activable tasks generated by the pipeline for this recommendation
Show child attributes
Show child attributes
Brief generation lifecycle: not-started (never run), pending, in-progress, generated, error
User-facing plan status: new (default), confirmed (on my plan), dismissed