List briefs

GET

/projects/:projectId/briefs

GET

/projects/:projectId/briefs

1 curl https:/https://api/projects/projectId/briefs \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

1 {
2   "briefs": [
3     {
4       "_id": "64b8f9a2e4b0c123456789ab",
5       "projectId": "proj_9876543210abcdef",
6       "text": "Initial project brief outlining the key objectives and deliverables for Q3.",
7       "attachedFileIds": [
8         "file_123abc456def"
9       ],
10       "status": "shaped",
11       "shapedPlaybookId": "playbook_abc123def456",
12       "shapedRunId": "run_789xyz654wvu",
13       "reasoning": "The brief was shaped to align with the updated client requirements and timeline constraints.",
14       "shapedPlaybook": {
15         "steps": [
16           {
17             "id": "step1",
18             "action": "Define scope",
19             "parameters": {
20               "deadline": "2024-07-15"
21             }
22           }
23         ],
24         "version": "1.2.0"
25       },
26       "shapedRun": {
27         "status": "completed",
28         "result": "success",
29         "executedAt": "2024-06-20T10:15:00Z"
30       },
31       "warnings": [
32         "Missing optional budget details"
33       ],
34       "proposedDataObjects": [
35         {
36           "type": "milestone",
37           "name": "Phase 1 Completion",
38           "dueDate": "2024-08-01"
39         }
40       ],
41       "shapingLogs": [
42         {
43           "timestamp": "2024-06-19T09:00:00Z",
44           "message": "Playbook shaping started"
45         }
46       ],
47       "errorMessage": null,
48       "createdBy": "user_42a7c9d8e1f2",
49       "createdAt": "2024-06-18T14:22:00Z",
50       "shapedAt": "2024-06-19T12:00:00Z",
51       "approvedAt": "2024-06-20T15:30:00Z",
52       "discardedAt": null,
53       "runAttachedFileIds": [
54         "file_789xyz654wvu"
55       ]
56     }
57   ]
58 }

Lists the project's briefs, newest first. An inaccessible project reads as 404.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

projectIdstringRequired

Response

The project's briefs.

briefslist of objects

Errors

401

Unauthorized Error

404

Not Found Error