Generate briefs for a recommended action

Triggers a Prefect flow that generates briefs for every task of the given recommended action. The flow persists briefs by calling POST /v1/internal/recommendation/recommended-action-results//briefs.

POST /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}/generate-briefs

Generate briefs for a recommended action

cURL

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}/generate-briefs \
  --header 'Authorization: <api-key>'

202

{
  "prefect_flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization · string · header · required

Path Parameters

id · string<uuid> · required

Recommended action identifier

organization_id · string<uuid> · required

Organization identifier

workspace_id · string<uuid> · required

Workspace identifier

Response

202

application/json

Brief generation flow triggered

prefect_flow_run_id · string<uuid> | null · required