Access Retrieve

GET

https://host.com/api/v2/experiences/:id/access/

GET

/api/v2/experiences/:id/access/

$ curl /api/v2/experiences/1/access/ \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "id": 1,
3   "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4   "workspace_group": 42,
5   "category": "Content Creation",
6   "subcategory": "AI Writing",
7   "tags": [
8     "AI",
9     "content",
10     "automation"
11   ],
12   "publications": [
13     {
14       "id": 12,
15       "uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
16       "name": "AI Content Hub",
17       "custom_url": "ai-content-hub",
18       "cover_image": "https://example.com/images/cover_ai_content_hub.jpg",
19       "logo": "https://example.com/images/logo_ai_content_hub.png",
20       "visibility": "public"
21     }
22   ],
23   "is_generation_ready_for_review": true,
24   "experience_object": "{\"type\":\"AIExpert\",\"config\":{\"model\":\"gpt-4\",\"temperature\":0.7}}",
25   "rag_documents": [
26     {
27       "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
28       "document_id": 55,
29       "document_name": "AI Content Guidelines"
30     }
31   ],
32   "title": "AI-Powered Content Creation Experience",
33   "primary_deployed_resource_uid": "7b9e1f2a-4d3c-4f8a-9a2b-1c2d3e4f5a6b",
34   "primary_deployed_resource_id": 101,
35   "primary_deployed_resource_type": "AI Expert",
36   "focus_area": "Natural Language Generation",
37   "visibility": "public",
38   "status": "completed",
39   "is_draft": false,
40   "is_fully_published": true,
41   "chat_session": 9876,
42   "needs_review": false
43 }

V2 View to retrieve a single Experience by ID. Returns the latest data including the dynamic ‘experience_object’.

Path parameters

idintegerRequired

Response

idintegerRead-only

uidstringRead-onlyformat: "uuid"

workspace_groupinteger

categorystringRead-only

subcategorystringRead-only

tagslist of strings

publicationslist of objectsRead-only

is_generation_ready_for_reviewbooleanRead-only

experience_objectstringRead-only

rag_documentslist of objectsRead-only

titlestring or null<=255 characters

primary_deployed_resource_uidstring or nullformat: "uuid"

UID of the primary deployed resource (domain/blog/quest/podcast)

primary_deployed_resource_idinteger or null-2147483648-2147483647

Database ID of the primary deployed resource

primary_deployed_resource_typestring or null<=20 characters

Type of the primary deployed resource (AI Expert/AI Note/Quest/Podcast)

focus_areastring or null

visibilityenum

public - Public
private - Private
team - Team
org - Organization

Allowed values:

statusenum

not_started - Not Started
in_progress - In Progress
completed - Completed
failed - Failed

Allowed values:

is_draftboolean

is_fully_publishedboolean

True when all selected experience types have been successfully published

chat_sessioninteger or null

Chat session used to generate this experience

needs_reviewboolean

Whether this experience requires review before publishing