Retrieve the brief for a task

GET /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief

Retrieve the brief for a task

cURL

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief \
  --header 'Authorization: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "body": "<string>",
  "is_user_edited": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Path Parameters

organization_id · string<uuid> · required

Organization identifier

result_id · string<uuid> · required

Recommended action result identifier

task_id · string<uuid> · required

Task identifier

workspace_id · string<uuid> · required

Workspace identifier

Response

200

application/json

Brief for the task

id · string<uuid> · required

Brief UUID

task_id · string<uuid> · required

Task UUID this brief belongs to

title · string · required

Brief title

body · string · required

Brief body content

is_user_edited · boolean · required

True once a user has edited title or body

status · enum<string> · required

User-facing status. One of: not_started, in_progress, implemented

• not_started - not_started
• in_progress - in_progress
• implemented - implemented

Available options: not_started, in_progress, implemented

created_at · string<date-time> | null

Creation timestamp

updated_at · string<date-time> | null

Last update timestamp