@breign/client 1.0.101 → 1.0.103
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/apis/AgentApi.d.ts +14 -0
- package/dist/apis/AgentApi.js +32 -0
- package/dist/apis/ConfigurationApi.d.ts +7 -7
- package/dist/apis/ConfigurationApi.js +5 -5
- package/dist/apis/OrganizationsApi.d.ts +175 -1
- package/dist/apis/OrganizationsApi.js +433 -0
- package/dist/apis/ScheduledTasksApi.d.ts +143 -0
- package/dist/apis/ScheduledTasksApi.js +364 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/models/AccessRoleCreateRequestUio.d.ts +45 -0
- package/dist/models/AccessRoleCreateRequestUio.js +55 -0
- package/dist/models/AccessRolePermissionsRequestUio.d.ts +33 -0
- package/dist/models/AccessRolePermissionsRequestUio.js +51 -0
- package/dist/models/AccessRoleUio.d.ts +75 -0
- package/dist/models/AccessRoleUio.js +75 -0
- package/dist/models/AccessRoleUpdateRequestUio.d.ts +38 -0
- package/dist/models/AccessRoleUpdateRequestUio.js +52 -0
- package/dist/models/ChatUio.d.ts +14 -0
- package/dist/models/ChatUio.js +10 -0
- package/dist/models/GetUploadLimits200ResponseUio.d.ts +32 -0
- package/dist/models/GetUploadLimits200ResponseUio.js +50 -0
- package/dist/models/OrganizationMemberUio.d.ts +51 -0
- package/dist/models/OrganizationMemberUio.js +63 -0
- package/dist/models/OrganizationMemberUserUio.d.ts +32 -0
- package/dist/models/OrganizationMemberUserUio.js +50 -0
- package/dist/models/OrganizationPermissionKeyUio.d.ts +59 -0
- package/dist/models/OrganizationPermissionKeyUio.js +85 -0
- package/dist/models/OrganizationUserInviteRequestUio.d.ts +38 -0
- package/dist/models/OrganizationUserInviteRequestUio.js +52 -0
- package/dist/models/OrganizationUserInviteResponseUio.d.ts +32 -0
- package/dist/models/OrganizationUserInviteResponseUio.js +50 -0
- package/dist/models/PermissionEntryUio.d.ts +39 -0
- package/dist/models/PermissionEntryUio.js +55 -0
- package/dist/models/PromptCreateRequestUio.d.ts +14 -0
- package/dist/models/PromptCreateRequestUio.js +10 -0
- package/dist/models/PromptFlowCreateRequestUio.d.ts +14 -0
- package/dist/models/PromptFlowCreateRequestUio.js +10 -0
- package/dist/models/ProviderValiationRequestUio.d.ts +6 -0
- package/dist/models/ProviderValiationRequestUio.js +4 -0
- package/dist/models/RunStepUio.d.ts +78 -0
- package/dist/models/RunStepUio.js +74 -0
- package/dist/models/ScheduledTaskCreateUio.d.ts +77 -0
- package/dist/models/ScheduledTaskCreateUio.js +75 -0
- package/dist/models/ScheduledTaskListUio.d.ts +39 -0
- package/dist/models/ScheduledTaskListUio.js +55 -0
- package/dist/models/ScheduledTaskManualRunResponseUio.d.ts +32 -0
- package/dist/models/ScheduledTaskManualRunResponseUio.js +50 -0
- package/dist/models/ScheduledTaskRunListUio.d.ts +39 -0
- package/dist/models/ScheduledTaskRunListUio.js +55 -0
- package/dist/models/ScheduledTaskRunUio.d.ts +110 -0
- package/dist/models/ScheduledTaskRunUio.js +98 -0
- package/dist/models/ScheduledTaskStatusResponseUio.d.ts +46 -0
- package/dist/models/ScheduledTaskStatusResponseUio.js +60 -0
- package/dist/models/ScheduledTaskStatusToggleUio.d.ts +40 -0
- package/dist/models/ScheduledTaskStatusToggleUio.js +58 -0
- package/dist/models/ScheduledTaskUio.d.ts +146 -0
- package/dist/models/ScheduledTaskUio.js +123 -0
- package/dist/models/TaskScheduleEndOneOf1Uio.d.ts +45 -0
- package/dist/models/TaskScheduleEndOneOf1Uio.js +61 -0
- package/dist/models/TaskScheduleEndOneOf2Uio.d.ts +45 -0
- package/dist/models/TaskScheduleEndOneOf2Uio.js +61 -0
- package/dist/models/TaskScheduleEndOneOfUio.d.ts +39 -0
- package/dist/models/TaskScheduleEndOneOfUio.js +57 -0
- package/dist/models/TaskScheduleEndUio.d.ts +24 -0
- package/dist/models/TaskScheduleEndUio.js +64 -0
- package/dist/models/TaskScheduleIntervalUio.d.ts +47 -0
- package/dist/models/TaskScheduleIntervalUio.js +63 -0
- package/dist/models/TaskScheduleUio.d.ts +94 -0
- package/dist/models/TaskScheduleUio.js +78 -0
- package/dist/models/UserAccessRolesRequestUio.d.ts +32 -0
- package/dist/models/UserAccessRolesRequestUio.js +50 -0
- package/dist/models/UserAccessUio.d.ts +39 -0
- package/dist/models/UserAccessUio.js +55 -0
- package/dist/models/UserAgentAccessAgentUio.d.ts +38 -0
- package/dist/models/UserAgentAccessAgentUio.js +54 -0
- package/dist/models/UserAgentAccessRequestUio.d.ts +38 -0
- package/dist/models/UserAgentAccessRequestUio.js +54 -0
- package/dist/models/UserAgentAccessUio.d.ts +45 -0
- package/dist/models/UserAgentAccessUio.js +59 -0
- package/dist/models/UserDirectPermissionsRequestUio.d.ts +33 -0
- package/dist/models/UserDirectPermissionsRequestUio.js +51 -0
- package/dist/models/UserUio.d.ts +3 -3
- package/dist/models/UserUio.js +3 -3
- package/dist/models/index.d.ts +32 -2
- package/dist/models/index.js +32 -2
- package/dist/openapi.json +2329 -617
- package/package.json +1 -1
- package/dist/models/UploadLimitsResponseUio.d.ts +0 -32
- package/dist/models/UploadLimitsResponseUio.js +0 -50
- package/dist/models/UserUserUio.d.ts +0 -32
- package/dist/models/UserUserUio.js +0 -50
package/dist/openapi.json
CHANGED
|
@@ -69,6 +69,9 @@
|
|
|
69
69
|
}, {
|
|
70
70
|
"description" : "Skills management endpoints",
|
|
71
71
|
"name" : "skills"
|
|
72
|
+
}, {
|
|
73
|
+
"description" : "Scheduled task management endpoints",
|
|
74
|
+
"name" : "scheduled-tasks"
|
|
72
75
|
} ],
|
|
73
76
|
"paths" : {
|
|
74
77
|
"/health" : {
|
|
@@ -1497,11 +1500,10 @@
|
|
|
1497
1500
|
"type" : "string"
|
|
1498
1501
|
}
|
|
1499
1502
|
}, {
|
|
1500
|
-
"description" : "Sort
|
|
1503
|
+
"description" : "Sort order for results",
|
|
1501
1504
|
"in" : "query",
|
|
1502
1505
|
"name" : "sortOrder",
|
|
1503
1506
|
"schema" : {
|
|
1504
|
-
"default" : "desc",
|
|
1505
1507
|
"enum" : [ "asc", "desc" ],
|
|
1506
1508
|
"type" : "string"
|
|
1507
1509
|
}
|
|
@@ -1598,6 +1600,55 @@
|
|
|
1598
1600
|
"tags" : [ "prompts" ]
|
|
1599
1601
|
}
|
|
1600
1602
|
},
|
|
1603
|
+
"/agents/{agentId}/conversations/{conversationId}" : {
|
|
1604
|
+
"get" : {
|
|
1605
|
+
"description" : "Get a specific conversation by its ID for the given agent",
|
|
1606
|
+
"operationId" : "getAgentConversationById",
|
|
1607
|
+
"parameters" : [ {
|
|
1608
|
+
"description" : "ID of the agent",
|
|
1609
|
+
"in" : "path",
|
|
1610
|
+
"name" : "agentId",
|
|
1611
|
+
"required" : true,
|
|
1612
|
+
"schema" : {
|
|
1613
|
+
"format" : "uuid",
|
|
1614
|
+
"type" : "string"
|
|
1615
|
+
}
|
|
1616
|
+
}, {
|
|
1617
|
+
"in" : "path",
|
|
1618
|
+
"name" : "conversationId",
|
|
1619
|
+
"required" : true,
|
|
1620
|
+
"schema" : {
|
|
1621
|
+
"type" : "string"
|
|
1622
|
+
}
|
|
1623
|
+
} ],
|
|
1624
|
+
"responses" : {
|
|
1625
|
+
"200" : {
|
|
1626
|
+
"content" : {
|
|
1627
|
+
"application/json" : {
|
|
1628
|
+
"schema" : {
|
|
1629
|
+
"$ref" : "#/components/schemas/Chat"
|
|
1630
|
+
}
|
|
1631
|
+
}
|
|
1632
|
+
},
|
|
1633
|
+
"description" : "The conversation"
|
|
1634
|
+
},
|
|
1635
|
+
"401" : {
|
|
1636
|
+
"description" : "Unauthorized"
|
|
1637
|
+
},
|
|
1638
|
+
"403" : {
|
|
1639
|
+
"description" : "Forbidden - User doesn't have access to this agent"
|
|
1640
|
+
},
|
|
1641
|
+
"404" : {
|
|
1642
|
+
"description" : "Conversation not found"
|
|
1643
|
+
},
|
|
1644
|
+
"500" : {
|
|
1645
|
+
"description" : "Failed to get conversation"
|
|
1646
|
+
}
|
|
1647
|
+
},
|
|
1648
|
+
"summary" : "Get a conversation by ID for an agent",
|
|
1649
|
+
"tags" : [ "agent" ]
|
|
1650
|
+
}
|
|
1651
|
+
},
|
|
1601
1652
|
"/agents/{agentId}/message-audio/{audioFileId}" : {
|
|
1602
1653
|
"delete" : {
|
|
1603
1654
|
"description" : "Removes the audio chunk from the message in the database and deletes the file from object storage.\n",
|
|
@@ -1747,10 +1798,9 @@
|
|
|
1747
1798
|
"tags" : [ "agent" ]
|
|
1748
1799
|
}
|
|
1749
1800
|
},
|
|
1750
|
-
"/agents/{agentId}/
|
|
1801
|
+
"/agents/{agentId}/scheduled-tasks" : {
|
|
1751
1802
|
"get" : {
|
|
1752
|
-
"
|
|
1753
|
-
"operationId" : "getAppsForAgentId",
|
|
1803
|
+
"operationId" : "listScheduledTasks",
|
|
1754
1804
|
"parameters" : [ {
|
|
1755
1805
|
"description" : "ID of the agent",
|
|
1756
1806
|
"in" : "path",
|
|
@@ -1760,35 +1810,67 @@
|
|
|
1760
1810
|
"format" : "uuid",
|
|
1761
1811
|
"type" : "string"
|
|
1762
1812
|
}
|
|
1813
|
+
}, {
|
|
1814
|
+
"description" : "Filter by task status",
|
|
1815
|
+
"in" : "query",
|
|
1816
|
+
"name" : "status",
|
|
1817
|
+
"schema" : {
|
|
1818
|
+
"enum" : [ "active", "paused", "done" ],
|
|
1819
|
+
"type" : "string"
|
|
1820
|
+
}
|
|
1821
|
+
}, {
|
|
1822
|
+
"description" : "Search query",
|
|
1823
|
+
"in" : "query",
|
|
1824
|
+
"name" : "q",
|
|
1825
|
+
"schema" : {
|
|
1826
|
+
"type" : "string"
|
|
1827
|
+
}
|
|
1828
|
+
}, {
|
|
1829
|
+
"in" : "query",
|
|
1830
|
+
"name" : "limit",
|
|
1831
|
+
"schema" : {
|
|
1832
|
+
"default" : 50,
|
|
1833
|
+
"type" : "integer"
|
|
1834
|
+
}
|
|
1835
|
+
}, {
|
|
1836
|
+
"description" : "Cursor for pagination (createdAt before this date)",
|
|
1837
|
+
"in" : "query",
|
|
1838
|
+
"name" : "before",
|
|
1839
|
+
"schema" : {
|
|
1840
|
+
"format" : "date-time",
|
|
1841
|
+
"type" : "string"
|
|
1842
|
+
}
|
|
1763
1843
|
} ],
|
|
1764
1844
|
"responses" : {
|
|
1765
1845
|
"200" : {
|
|
1766
1846
|
"content" : {
|
|
1767
1847
|
"application/json" : {
|
|
1768
1848
|
"schema" : {
|
|
1769
|
-
"
|
|
1770
|
-
"$ref" : "#/components/schemas/AppLight"
|
|
1771
|
-
},
|
|
1772
|
-
"type" : "array"
|
|
1849
|
+
"$ref" : "#/components/schemas/ScheduledTaskList"
|
|
1773
1850
|
}
|
|
1774
1851
|
}
|
|
1775
1852
|
},
|
|
1776
|
-
"description" : "
|
|
1853
|
+
"description" : "List of scheduled tasks"
|
|
1854
|
+
},
|
|
1855
|
+
"401" : {
|
|
1856
|
+
"description" : "Unauthorized"
|
|
1857
|
+
},
|
|
1858
|
+
"403" : {
|
|
1859
|
+
"description" : "Forbidden"
|
|
1777
1860
|
}
|
|
1778
1861
|
},
|
|
1779
|
-
"summary" : "
|
|
1780
|
-
"tags" : [ "
|
|
1781
|
-
}
|
|
1782
|
-
},
|
|
1783
|
-
"/apps" : {
|
|
1862
|
+
"summary" : "List scheduled tasks for an agent",
|
|
1863
|
+
"tags" : [ "scheduledTasks" ]
|
|
1864
|
+
},
|
|
1784
1865
|
"post" : {
|
|
1785
|
-
"
|
|
1786
|
-
"operationId" : "createApp",
|
|
1866
|
+
"operationId" : "createScheduledTask",
|
|
1787
1867
|
"parameters" : [ {
|
|
1788
|
-
"description" : "
|
|
1789
|
-
"in" : "
|
|
1790
|
-
"name" : "
|
|
1868
|
+
"description" : "ID of the agent",
|
|
1869
|
+
"in" : "path",
|
|
1870
|
+
"name" : "agentId",
|
|
1871
|
+
"required" : true,
|
|
1791
1872
|
"schema" : {
|
|
1873
|
+
"format" : "uuid",
|
|
1792
1874
|
"type" : "string"
|
|
1793
1875
|
}
|
|
1794
1876
|
} ],
|
|
@@ -1796,7 +1878,7 @@
|
|
|
1796
1878
|
"content" : {
|
|
1797
1879
|
"application/json" : {
|
|
1798
1880
|
"schema" : {
|
|
1799
|
-
"$ref" : "#/components/schemas/
|
|
1881
|
+
"$ref" : "#/components/schemas/ScheduledTaskCreate"
|
|
1800
1882
|
}
|
|
1801
1883
|
}
|
|
1802
1884
|
},
|
|
@@ -1807,25 +1889,45 @@
|
|
|
1807
1889
|
"content" : {
|
|
1808
1890
|
"application/json" : {
|
|
1809
1891
|
"schema" : {
|
|
1810
|
-
"$ref" : "#/components/schemas/
|
|
1892
|
+
"$ref" : "#/components/schemas/ScheduledTask"
|
|
1811
1893
|
}
|
|
1812
1894
|
}
|
|
1813
1895
|
},
|
|
1814
|
-
"description" : "
|
|
1896
|
+
"description" : "Task created"
|
|
1897
|
+
},
|
|
1898
|
+
"400" : {
|
|
1899
|
+
"description" : "Invalid request body"
|
|
1900
|
+
},
|
|
1901
|
+
"401" : {
|
|
1902
|
+
"description" : "Unauthorized"
|
|
1903
|
+
},
|
|
1904
|
+
"403" : {
|
|
1905
|
+
"description" : "Forbidden"
|
|
1906
|
+
},
|
|
1907
|
+
"422" : {
|
|
1908
|
+
"description" : "Invalid schedule configuration"
|
|
1815
1909
|
}
|
|
1816
1910
|
},
|
|
1817
|
-
"summary" : "Create an
|
|
1818
|
-
"tags" : [ "
|
|
1911
|
+
"summary" : "Create a scheduled task for an agent",
|
|
1912
|
+
"tags" : [ "scheduledTasks" ]
|
|
1819
1913
|
}
|
|
1820
1914
|
},
|
|
1821
|
-
"/
|
|
1915
|
+
"/agents/{agentId}/scheduled-tasks/{taskId}" : {
|
|
1822
1916
|
"delete" : {
|
|
1823
|
-
"
|
|
1824
|
-
"operationId" : "deleteAppById",
|
|
1917
|
+
"operationId" : "deleteScheduledTask",
|
|
1825
1918
|
"parameters" : [ {
|
|
1826
|
-
"description" : "ID of the
|
|
1919
|
+
"description" : "ID of the agent",
|
|
1827
1920
|
"in" : "path",
|
|
1828
|
-
"name" : "
|
|
1921
|
+
"name" : "agentId",
|
|
1922
|
+
"required" : true,
|
|
1923
|
+
"schema" : {
|
|
1924
|
+
"format" : "uuid",
|
|
1925
|
+
"type" : "string"
|
|
1926
|
+
}
|
|
1927
|
+
}, {
|
|
1928
|
+
"description" : "ID of the scheduled task",
|
|
1929
|
+
"in" : "path",
|
|
1930
|
+
"name" : "taskId",
|
|
1829
1931
|
"required" : true,
|
|
1830
1932
|
"schema" : {
|
|
1831
1933
|
"type" : "string"
|
|
@@ -1833,19 +1935,36 @@
|
|
|
1833
1935
|
} ],
|
|
1834
1936
|
"responses" : {
|
|
1835
1937
|
"204" : {
|
|
1836
|
-
"description" : "
|
|
1938
|
+
"description" : "Task deleted"
|
|
1939
|
+
},
|
|
1940
|
+
"401" : {
|
|
1941
|
+
"description" : "Unauthorized"
|
|
1942
|
+
},
|
|
1943
|
+
"403" : {
|
|
1944
|
+
"description" : "Forbidden"
|
|
1945
|
+
},
|
|
1946
|
+
"404" : {
|
|
1947
|
+
"description" : "Task not found"
|
|
1837
1948
|
}
|
|
1838
1949
|
},
|
|
1839
|
-
"summary" : "Delete
|
|
1840
|
-
"tags" : [ "
|
|
1950
|
+
"summary" : "Delete a scheduled task",
|
|
1951
|
+
"tags" : [ "scheduledTasks" ]
|
|
1841
1952
|
},
|
|
1842
1953
|
"get" : {
|
|
1843
|
-
"
|
|
1844
|
-
"operationId" : "getAppById",
|
|
1954
|
+
"operationId" : "getScheduledTask",
|
|
1845
1955
|
"parameters" : [ {
|
|
1846
|
-
"description" : "ID of the
|
|
1956
|
+
"description" : "ID of the agent",
|
|
1847
1957
|
"in" : "path",
|
|
1848
|
-
"name" : "
|
|
1958
|
+
"name" : "agentId",
|
|
1959
|
+
"required" : true,
|
|
1960
|
+
"schema" : {
|
|
1961
|
+
"format" : "uuid",
|
|
1962
|
+
"type" : "string"
|
|
1963
|
+
}
|
|
1964
|
+
}, {
|
|
1965
|
+
"description" : "ID of the scheduled task",
|
|
1966
|
+
"in" : "path",
|
|
1967
|
+
"name" : "taskId",
|
|
1849
1968
|
"required" : true,
|
|
1850
1969
|
"schema" : {
|
|
1851
1970
|
"type" : "string"
|
|
@@ -1856,23 +1975,40 @@
|
|
|
1856
1975
|
"content" : {
|
|
1857
1976
|
"application/json" : {
|
|
1858
1977
|
"schema" : {
|
|
1859
|
-
"$ref" : "#/components/schemas/
|
|
1978
|
+
"$ref" : "#/components/schemas/ScheduledTask"
|
|
1860
1979
|
}
|
|
1861
1980
|
}
|
|
1862
1981
|
},
|
|
1863
|
-
"description" : "
|
|
1982
|
+
"description" : "The scheduled task"
|
|
1983
|
+
},
|
|
1984
|
+
"401" : {
|
|
1985
|
+
"description" : "Unauthorized"
|
|
1986
|
+
},
|
|
1987
|
+
"403" : {
|
|
1988
|
+
"description" : "Forbidden"
|
|
1989
|
+
},
|
|
1990
|
+
"404" : {
|
|
1991
|
+
"description" : "Task not found"
|
|
1864
1992
|
}
|
|
1865
1993
|
},
|
|
1866
|
-
"summary" : "Get
|
|
1867
|
-
"tags" : [ "
|
|
1994
|
+
"summary" : "Get a scheduled task by ID",
|
|
1995
|
+
"tags" : [ "scheduledTasks" ]
|
|
1868
1996
|
},
|
|
1869
|
-
"
|
|
1870
|
-
"
|
|
1871
|
-
"operationId" : "updateAppById",
|
|
1997
|
+
"put" : {
|
|
1998
|
+
"operationId" : "updateScheduledTask",
|
|
1872
1999
|
"parameters" : [ {
|
|
1873
|
-
"description" : "ID of the
|
|
2000
|
+
"description" : "ID of the agent",
|
|
1874
2001
|
"in" : "path",
|
|
1875
|
-
"name" : "
|
|
2002
|
+
"name" : "agentId",
|
|
2003
|
+
"required" : true,
|
|
2004
|
+
"schema" : {
|
|
2005
|
+
"format" : "uuid",
|
|
2006
|
+
"type" : "string"
|
|
2007
|
+
}
|
|
2008
|
+
}, {
|
|
2009
|
+
"description" : "ID of the scheduled task",
|
|
2010
|
+
"in" : "path",
|
|
2011
|
+
"name" : "taskId",
|
|
1876
2012
|
"required" : true,
|
|
1877
2013
|
"schema" : {
|
|
1878
2014
|
"type" : "string"
|
|
@@ -1882,7 +2018,7 @@
|
|
|
1882
2018
|
"content" : {
|
|
1883
2019
|
"application/json" : {
|
|
1884
2020
|
"schema" : {
|
|
1885
|
-
"$ref" : "#/components/schemas/
|
|
2021
|
+
"$ref" : "#/components/schemas/ScheduledTaskCreate"
|
|
1886
2022
|
}
|
|
1887
2023
|
}
|
|
1888
2024
|
},
|
|
@@ -1893,27 +2029,48 @@
|
|
|
1893
2029
|
"content" : {
|
|
1894
2030
|
"application/json" : {
|
|
1895
2031
|
"schema" : {
|
|
1896
|
-
"$ref" : "#/components/schemas/
|
|
2032
|
+
"$ref" : "#/components/schemas/ScheduledTask"
|
|
1897
2033
|
}
|
|
1898
2034
|
}
|
|
1899
2035
|
},
|
|
1900
|
-
"description" : "
|
|
2036
|
+
"description" : "Task updated"
|
|
2037
|
+
},
|
|
2038
|
+
"400" : {
|
|
2039
|
+
"description" : "Invalid request body"
|
|
2040
|
+
},
|
|
2041
|
+
"401" : {
|
|
2042
|
+
"description" : "Unauthorized"
|
|
2043
|
+
},
|
|
2044
|
+
"403" : {
|
|
2045
|
+
"description" : "Forbidden"
|
|
1901
2046
|
},
|
|
1902
2047
|
"404" : {
|
|
1903
|
-
"description" : "
|
|
2048
|
+
"description" : "Task not found"
|
|
2049
|
+
},
|
|
2050
|
+
"422" : {
|
|
2051
|
+
"description" : "Task completed or invalid schedule"
|
|
1904
2052
|
}
|
|
1905
2053
|
},
|
|
1906
|
-
"summary" : "Update
|
|
1907
|
-
"tags" : [ "
|
|
2054
|
+
"summary" : "Update a scheduled task",
|
|
2055
|
+
"tags" : [ "scheduledTasks" ]
|
|
1908
2056
|
}
|
|
1909
2057
|
},
|
|
1910
|
-
"/
|
|
1911
|
-
"
|
|
1912
|
-
"operationId" : "
|
|
2058
|
+
"/agents/{agentId}/scheduled-tasks/{taskId}/status" : {
|
|
2059
|
+
"patch" : {
|
|
2060
|
+
"operationId" : "toggleScheduledTaskStatus",
|
|
1913
2061
|
"parameters" : [ {
|
|
1914
|
-
"description" : "ID of the
|
|
2062
|
+
"description" : "ID of the agent",
|
|
1915
2063
|
"in" : "path",
|
|
1916
|
-
"name" : "
|
|
2064
|
+
"name" : "agentId",
|
|
2065
|
+
"required" : true,
|
|
2066
|
+
"schema" : {
|
|
2067
|
+
"format" : "uuid",
|
|
2068
|
+
"type" : "string"
|
|
2069
|
+
}
|
|
2070
|
+
}, {
|
|
2071
|
+
"description" : "ID of the scheduled task",
|
|
2072
|
+
"in" : "path",
|
|
2073
|
+
"name" : "taskId",
|
|
1917
2074
|
"required" : true,
|
|
1918
2075
|
"schema" : {
|
|
1919
2076
|
"type" : "string"
|
|
@@ -1923,203 +2080,242 @@
|
|
|
1923
2080
|
"content" : {
|
|
1924
2081
|
"application/json" : {
|
|
1925
2082
|
"schema" : {
|
|
1926
|
-
"$ref" : "#/components/schemas/
|
|
2083
|
+
"$ref" : "#/components/schemas/ScheduledTaskStatusToggle"
|
|
1927
2084
|
}
|
|
1928
2085
|
}
|
|
1929
2086
|
},
|
|
1930
2087
|
"required" : true
|
|
1931
2088
|
},
|
|
1932
2089
|
"responses" : {
|
|
1933
|
-
"
|
|
2090
|
+
"200" : {
|
|
1934
2091
|
"content" : {
|
|
1935
2092
|
"application/json" : {
|
|
1936
2093
|
"schema" : {
|
|
1937
|
-
"$ref" : "#/components/schemas/
|
|
2094
|
+
"$ref" : "#/components/schemas/ScheduledTaskStatusResponse"
|
|
1938
2095
|
}
|
|
1939
2096
|
}
|
|
1940
2097
|
},
|
|
1941
|
-
"description" : "
|
|
2098
|
+
"description" : "Status updated"
|
|
2099
|
+
},
|
|
2100
|
+
"400" : {
|
|
2101
|
+
"description" : "Invalid status value"
|
|
2102
|
+
},
|
|
2103
|
+
"401" : {
|
|
2104
|
+
"description" : "Unauthorized"
|
|
2105
|
+
},
|
|
2106
|
+
"403" : {
|
|
2107
|
+
"description" : "Forbidden"
|
|
2108
|
+
},
|
|
2109
|
+
"404" : {
|
|
2110
|
+
"description" : "Task not found"
|
|
2111
|
+
},
|
|
2112
|
+
"422" : {
|
|
2113
|
+
"description" : "Task already completed"
|
|
1942
2114
|
}
|
|
1943
2115
|
},
|
|
1944
|
-
"summary" : "
|
|
1945
|
-
"tags" : [ "
|
|
2116
|
+
"summary" : "Toggle scheduled task status (active/paused)",
|
|
2117
|
+
"tags" : [ "scheduledTasks" ]
|
|
1946
2118
|
}
|
|
1947
2119
|
},
|
|
1948
|
-
"/
|
|
2120
|
+
"/agents/{agentId}/scheduled-tasks/{taskId}/run" : {
|
|
1949
2121
|
"post" : {
|
|
1950
|
-
"
|
|
1951
|
-
"operationId" : "createAppFlow",
|
|
2122
|
+
"operationId" : "triggerScheduledTask",
|
|
1952
2123
|
"parameters" : [ {
|
|
1953
|
-
"description" : "ID of the
|
|
2124
|
+
"description" : "ID of the agent",
|
|
1954
2125
|
"in" : "path",
|
|
1955
|
-
"name" : "
|
|
2126
|
+
"name" : "agentId",
|
|
1956
2127
|
"required" : true,
|
|
1957
2128
|
"schema" : {
|
|
2129
|
+
"format" : "uuid",
|
|
1958
2130
|
"type" : "string"
|
|
1959
2131
|
}
|
|
1960
2132
|
}, {
|
|
1961
|
-
"description" : "
|
|
1962
|
-
"in" : "
|
|
1963
|
-
"name" : "
|
|
2133
|
+
"description" : "ID of the scheduled task",
|
|
2134
|
+
"in" : "path",
|
|
2135
|
+
"name" : "taskId",
|
|
2136
|
+
"required" : true,
|
|
1964
2137
|
"schema" : {
|
|
1965
2138
|
"type" : "string"
|
|
1966
2139
|
}
|
|
1967
|
-
}, {
|
|
1968
|
-
"description" : "If true, the resource will not appear in history and will be deleted after a certain time.",
|
|
1969
|
-
"in" : "query",
|
|
1970
|
-
"name" : "ephemeral",
|
|
1971
|
-
"required" : false,
|
|
1972
|
-
"schema" : {
|
|
1973
|
-
"type" : "boolean"
|
|
1974
|
-
}
|
|
1975
2140
|
} ],
|
|
1976
|
-
"requestBody" : {
|
|
1977
|
-
"content" : {
|
|
1978
|
-
"application/json" : {
|
|
1979
|
-
"schema" : {
|
|
1980
|
-
"$ref" : "#/components/schemas/AppFlowCreateRequest"
|
|
1981
|
-
}
|
|
1982
|
-
}
|
|
1983
|
-
},
|
|
1984
|
-
"required" : true
|
|
1985
|
-
},
|
|
1986
2141
|
"responses" : {
|
|
1987
|
-
"
|
|
2142
|
+
"202" : {
|
|
1988
2143
|
"content" : {
|
|
1989
2144
|
"application/json" : {
|
|
1990
2145
|
"schema" : {
|
|
1991
|
-
"$ref" : "#/components/schemas/
|
|
2146
|
+
"$ref" : "#/components/schemas/ScheduledTaskManualRunResponse"
|
|
1992
2147
|
}
|
|
1993
2148
|
}
|
|
1994
2149
|
},
|
|
1995
|
-
"description" : "
|
|
2150
|
+
"description" : "Run queued"
|
|
2151
|
+
},
|
|
2152
|
+
"401" : {
|
|
2153
|
+
"description" : "Unauthorized"
|
|
2154
|
+
},
|
|
2155
|
+
"403" : {
|
|
2156
|
+
"description" : "Forbidden"
|
|
2157
|
+
},
|
|
2158
|
+
"404" : {
|
|
2159
|
+
"description" : "Task not found"
|
|
1996
2160
|
}
|
|
1997
2161
|
},
|
|
1998
|
-
"summary" : "
|
|
1999
|
-
"tags" : [ "
|
|
2162
|
+
"summary" : "Manually trigger a scheduled task run",
|
|
2163
|
+
"tags" : [ "scheduledTasks" ]
|
|
2000
2164
|
}
|
|
2001
2165
|
},
|
|
2002
|
-
"/
|
|
2003
|
-
"
|
|
2004
|
-
"
|
|
2005
|
-
"operationId" : "createAppChat",
|
|
2166
|
+
"/agents/{agentId}/scheduled-tasks/{taskId}/runs" : {
|
|
2167
|
+
"get" : {
|
|
2168
|
+
"operationId" : "listScheduledTaskRuns",
|
|
2006
2169
|
"parameters" : [ {
|
|
2007
|
-
"description" : "ID of the
|
|
2170
|
+
"description" : "ID of the agent",
|
|
2008
2171
|
"in" : "path",
|
|
2009
|
-
"name" : "
|
|
2172
|
+
"name" : "agentId",
|
|
2010
2173
|
"required" : true,
|
|
2011
2174
|
"schema" : {
|
|
2175
|
+
"format" : "uuid",
|
|
2012
2176
|
"type" : "string"
|
|
2013
2177
|
}
|
|
2014
2178
|
}, {
|
|
2015
|
-
"description" : "
|
|
2016
|
-
"in" : "
|
|
2017
|
-
"name" : "
|
|
2179
|
+
"description" : "ID of the scheduled task",
|
|
2180
|
+
"in" : "path",
|
|
2181
|
+
"name" : "taskId",
|
|
2182
|
+
"required" : true,
|
|
2018
2183
|
"schema" : {
|
|
2019
2184
|
"type" : "string"
|
|
2020
2185
|
}
|
|
2021
2186
|
}, {
|
|
2022
|
-
"description" : "If true, the resource will not appear in history and will be deleted after a certain time.",
|
|
2023
2187
|
"in" : "query",
|
|
2024
|
-
"name" : "
|
|
2025
|
-
"required" : false,
|
|
2188
|
+
"name" : "limit",
|
|
2026
2189
|
"schema" : {
|
|
2027
|
-
"
|
|
2190
|
+
"default" : 20,
|
|
2191
|
+
"type" : "integer"
|
|
2192
|
+
}
|
|
2193
|
+
}, {
|
|
2194
|
+
"description" : "Cursor for pagination (createdAt before this date)",
|
|
2195
|
+
"in" : "query",
|
|
2196
|
+
"name" : "before",
|
|
2197
|
+
"schema" : {
|
|
2198
|
+
"format" : "date-time",
|
|
2199
|
+
"type" : "string"
|
|
2028
2200
|
}
|
|
2029
2201
|
} ],
|
|
2030
|
-
"requestBody" : {
|
|
2031
|
-
"content" : {
|
|
2032
|
-
"application/json" : {
|
|
2033
|
-
"schema" : {
|
|
2034
|
-
"$ref" : "#/components/schemas/AppChatCreateRequest"
|
|
2035
|
-
}
|
|
2036
|
-
}
|
|
2037
|
-
},
|
|
2038
|
-
"required" : true
|
|
2039
|
-
},
|
|
2040
2202
|
"responses" : {
|
|
2041
2203
|
"200" : {
|
|
2042
2204
|
"content" : {
|
|
2043
2205
|
"application/json" : {
|
|
2044
2206
|
"schema" : {
|
|
2045
|
-
"$ref" : "#/components/schemas/
|
|
2207
|
+
"$ref" : "#/components/schemas/ScheduledTaskRunList"
|
|
2046
2208
|
}
|
|
2047
2209
|
}
|
|
2048
2210
|
},
|
|
2049
|
-
"description" : "
|
|
2211
|
+
"description" : "List of task runs with next scheduled run time"
|
|
2212
|
+
},
|
|
2213
|
+
"401" : {
|
|
2214
|
+
"description" : "Unauthorized"
|
|
2215
|
+
},
|
|
2216
|
+
"403" : {
|
|
2217
|
+
"description" : "Forbidden"
|
|
2218
|
+
},
|
|
2219
|
+
"404" : {
|
|
2220
|
+
"description" : "Task not found"
|
|
2050
2221
|
}
|
|
2051
2222
|
},
|
|
2052
|
-
"summary" : "
|
|
2053
|
-
"tags" : [ "
|
|
2223
|
+
"summary" : "List runs for a scheduled task",
|
|
2224
|
+
"tags" : [ "scheduledTasks" ]
|
|
2054
2225
|
}
|
|
2055
2226
|
},
|
|
2056
|
-
"/
|
|
2057
|
-
"
|
|
2058
|
-
"
|
|
2059
|
-
"operationId" : "submitNewMessageToChat",
|
|
2227
|
+
"/agents/{agentId}/scheduled-tasks/{taskId}/runs/{runId}" : {
|
|
2228
|
+
"get" : {
|
|
2229
|
+
"operationId" : "getScheduledTaskRun",
|
|
2060
2230
|
"parameters" : [ {
|
|
2061
|
-
"description" : "ID of the
|
|
2231
|
+
"description" : "ID of the agent",
|
|
2062
2232
|
"in" : "path",
|
|
2063
|
-
"name" : "
|
|
2233
|
+
"name" : "agentId",
|
|
2064
2234
|
"required" : true,
|
|
2065
2235
|
"schema" : {
|
|
2236
|
+
"format" : "uuid",
|
|
2066
2237
|
"type" : "string"
|
|
2067
2238
|
}
|
|
2068
2239
|
}, {
|
|
2069
|
-
"description" : "ID of the
|
|
2240
|
+
"description" : "ID of the scheduled task",
|
|
2070
2241
|
"in" : "path",
|
|
2071
|
-
"name" : "
|
|
2242
|
+
"name" : "taskId",
|
|
2072
2243
|
"required" : true,
|
|
2073
2244
|
"schema" : {
|
|
2074
2245
|
"type" : "string"
|
|
2075
2246
|
}
|
|
2076
2247
|
}, {
|
|
2077
|
-
"description" : "
|
|
2078
|
-
"in" : "
|
|
2079
|
-
"name" : "
|
|
2248
|
+
"description" : "ID of the scheduled task run",
|
|
2249
|
+
"in" : "path",
|
|
2250
|
+
"name" : "runId",
|
|
2251
|
+
"required" : true,
|
|
2080
2252
|
"schema" : {
|
|
2081
2253
|
"type" : "string"
|
|
2082
2254
|
}
|
|
2083
2255
|
} ],
|
|
2084
|
-
"requestBody" : {
|
|
2085
|
-
"content" : {
|
|
2086
|
-
"application/json" : {
|
|
2087
|
-
"schema" : {
|
|
2088
|
-
"$ref" : "#/components/schemas/AppChatSubmitMessageRequest"
|
|
2089
|
-
}
|
|
2090
|
-
}
|
|
2091
|
-
},
|
|
2092
|
-
"required" : true
|
|
2093
|
-
},
|
|
2094
2256
|
"responses" : {
|
|
2095
2257
|
"200" : {
|
|
2096
2258
|
"content" : {
|
|
2097
2259
|
"application/json" : {
|
|
2098
2260
|
"schema" : {
|
|
2099
|
-
"$ref" : "#/components/schemas/
|
|
2261
|
+
"$ref" : "#/components/schemas/ScheduledTaskRun"
|
|
2100
2262
|
}
|
|
2101
2263
|
}
|
|
2102
2264
|
},
|
|
2103
|
-
"description" : "
|
|
2265
|
+
"description" : "The task run"
|
|
2266
|
+
},
|
|
2267
|
+
"401" : {
|
|
2268
|
+
"description" : "Unauthorized"
|
|
2269
|
+
},
|
|
2270
|
+
"403" : {
|
|
2271
|
+
"description" : "Forbidden"
|
|
2272
|
+
},
|
|
2273
|
+
"404" : {
|
|
2274
|
+
"description" : "Run not found"
|
|
2104
2275
|
}
|
|
2105
2276
|
},
|
|
2106
|
-
"summary" : "
|
|
2107
|
-
"tags" : [ "
|
|
2277
|
+
"summary" : "Get a specific scheduled task run by ID",
|
|
2278
|
+
"tags" : [ "scheduledTasks" ]
|
|
2108
2279
|
}
|
|
2109
2280
|
},
|
|
2110
|
-
"/
|
|
2111
|
-
"
|
|
2112
|
-
"description" : "
|
|
2113
|
-
"operationId" : "
|
|
2281
|
+
"/agents/{agentId}/apps" : {
|
|
2282
|
+
"get" : {
|
|
2283
|
+
"description" : "Get apps for agent id",
|
|
2284
|
+
"operationId" : "getAppsForAgentId",
|
|
2114
2285
|
"parameters" : [ {
|
|
2115
|
-
"description" : "ID of the
|
|
2286
|
+
"description" : "ID of the agent",
|
|
2116
2287
|
"in" : "path",
|
|
2117
|
-
"name" : "
|
|
2288
|
+
"name" : "agentId",
|
|
2118
2289
|
"required" : true,
|
|
2119
2290
|
"schema" : {
|
|
2291
|
+
"format" : "uuid",
|
|
2120
2292
|
"type" : "string"
|
|
2121
2293
|
}
|
|
2122
|
-
},
|
|
2294
|
+
} ],
|
|
2295
|
+
"responses" : {
|
|
2296
|
+
"200" : {
|
|
2297
|
+
"content" : {
|
|
2298
|
+
"application/json" : {
|
|
2299
|
+
"schema" : {
|
|
2300
|
+
"items" : {
|
|
2301
|
+
"$ref" : "#/components/schemas/AppLight"
|
|
2302
|
+
},
|
|
2303
|
+
"type" : "array"
|
|
2304
|
+
}
|
|
2305
|
+
}
|
|
2306
|
+
},
|
|
2307
|
+
"description" : "Apps retrieved successfully"
|
|
2308
|
+
}
|
|
2309
|
+
},
|
|
2310
|
+
"summary" : "Get apps for agent id",
|
|
2311
|
+
"tags" : [ "app" ]
|
|
2312
|
+
}
|
|
2313
|
+
},
|
|
2314
|
+
"/apps" : {
|
|
2315
|
+
"post" : {
|
|
2316
|
+
"description" : "Creates a new app",
|
|
2317
|
+
"operationId" : "createApp",
|
|
2318
|
+
"parameters" : [ {
|
|
2123
2319
|
"description" : "Instance id",
|
|
2124
2320
|
"in" : "query",
|
|
2125
2321
|
"name" : "instanceId",
|
|
@@ -2131,32 +2327,32 @@
|
|
|
2131
2327
|
"content" : {
|
|
2132
2328
|
"application/json" : {
|
|
2133
2329
|
"schema" : {
|
|
2134
|
-
"$ref" : "#/components/schemas/
|
|
2330
|
+
"$ref" : "#/components/schemas/AppCreateRequest"
|
|
2135
2331
|
}
|
|
2136
2332
|
}
|
|
2137
2333
|
},
|
|
2138
2334
|
"required" : true
|
|
2139
2335
|
},
|
|
2140
2336
|
"responses" : {
|
|
2141
|
-
"
|
|
2337
|
+
"201" : {
|
|
2142
2338
|
"content" : {
|
|
2143
2339
|
"application/json" : {
|
|
2144
2340
|
"schema" : {
|
|
2145
|
-
"$ref" : "#/components/schemas/
|
|
2341
|
+
"$ref" : "#/components/schemas/App"
|
|
2146
2342
|
}
|
|
2147
2343
|
}
|
|
2148
2344
|
},
|
|
2149
|
-
"description" : "App
|
|
2345
|
+
"description" : "App created successfully"
|
|
2150
2346
|
}
|
|
2151
2347
|
},
|
|
2152
|
-
"summary" : "
|
|
2348
|
+
"summary" : "Create an app",
|
|
2153
2349
|
"tags" : [ "app" ]
|
|
2154
2350
|
}
|
|
2155
2351
|
},
|
|
2156
|
-
"/apps/{appId}
|
|
2157
|
-
"
|
|
2158
|
-
"description" : "
|
|
2159
|
-
"operationId" : "
|
|
2352
|
+
"/apps/{appId}" : {
|
|
2353
|
+
"delete" : {
|
|
2354
|
+
"description" : "Delete an app",
|
|
2355
|
+
"operationId" : "deleteAppById",
|
|
2160
2356
|
"parameters" : [ {
|
|
2161
2357
|
"description" : "ID of the app",
|
|
2162
2358
|
"in" : "path",
|
|
@@ -2165,10 +2361,50 @@
|
|
|
2165
2361
|
"schema" : {
|
|
2166
2362
|
"type" : "string"
|
|
2167
2363
|
}
|
|
2168
|
-
},
|
|
2169
|
-
|
|
2170
|
-
"
|
|
2171
|
-
|
|
2364
|
+
} ],
|
|
2365
|
+
"responses" : {
|
|
2366
|
+
"204" : {
|
|
2367
|
+
"description" : "App deleted successfully"
|
|
2368
|
+
}
|
|
2369
|
+
},
|
|
2370
|
+
"summary" : "Delete an app",
|
|
2371
|
+
"tags" : [ "app" ]
|
|
2372
|
+
},
|
|
2373
|
+
"get" : {
|
|
2374
|
+
"description" : "Get an app",
|
|
2375
|
+
"operationId" : "getAppById",
|
|
2376
|
+
"parameters" : [ {
|
|
2377
|
+
"description" : "ID of the app",
|
|
2378
|
+
"in" : "path",
|
|
2379
|
+
"name" : "appId",
|
|
2380
|
+
"required" : true,
|
|
2381
|
+
"schema" : {
|
|
2382
|
+
"type" : "string"
|
|
2383
|
+
}
|
|
2384
|
+
} ],
|
|
2385
|
+
"responses" : {
|
|
2386
|
+
"200" : {
|
|
2387
|
+
"content" : {
|
|
2388
|
+
"application/json" : {
|
|
2389
|
+
"schema" : {
|
|
2390
|
+
"$ref" : "#/components/schemas/App"
|
|
2391
|
+
}
|
|
2392
|
+
}
|
|
2393
|
+
},
|
|
2394
|
+
"description" : "App retrieved successfully"
|
|
2395
|
+
}
|
|
2396
|
+
},
|
|
2397
|
+
"summary" : "Get an app",
|
|
2398
|
+
"tags" : [ "app" ]
|
|
2399
|
+
},
|
|
2400
|
+
"patch" : {
|
|
2401
|
+
"description" : "Update an app",
|
|
2402
|
+
"operationId" : "updateAppById",
|
|
2403
|
+
"parameters" : [ {
|
|
2404
|
+
"description" : "ID of the app",
|
|
2405
|
+
"in" : "path",
|
|
2406
|
+
"name" : "appId",
|
|
2407
|
+
"required" : true,
|
|
2172
2408
|
"schema" : {
|
|
2173
2409
|
"type" : "string"
|
|
2174
2410
|
}
|
|
@@ -2177,7 +2413,7 @@
|
|
|
2177
2413
|
"content" : {
|
|
2178
2414
|
"application/json" : {
|
|
2179
2415
|
"schema" : {
|
|
2180
|
-
"$ref" : "#/components/schemas/
|
|
2416
|
+
"$ref" : "#/components/schemas/AppUpdateRequest"
|
|
2181
2417
|
}
|
|
2182
2418
|
}
|
|
2183
2419
|
},
|
|
@@ -2188,22 +2424,23 @@
|
|
|
2188
2424
|
"content" : {
|
|
2189
2425
|
"application/json" : {
|
|
2190
2426
|
"schema" : {
|
|
2191
|
-
"
|
|
2192
|
-
"type" : "object"
|
|
2427
|
+
"$ref" : "#/components/schemas/App"
|
|
2193
2428
|
}
|
|
2194
2429
|
}
|
|
2195
2430
|
},
|
|
2196
|
-
"description" : "App
|
|
2431
|
+
"description" : "App updated successfully"
|
|
2432
|
+
},
|
|
2433
|
+
"404" : {
|
|
2434
|
+
"description" : "App not found"
|
|
2197
2435
|
}
|
|
2198
2436
|
},
|
|
2199
|
-
"summary" : "
|
|
2437
|
+
"summary" : "Update an app",
|
|
2200
2438
|
"tags" : [ "app" ]
|
|
2201
2439
|
}
|
|
2202
2440
|
},
|
|
2203
|
-
"/apps/{appId}/
|
|
2441
|
+
"/apps/{appId}/profile-picture" : {
|
|
2204
2442
|
"post" : {
|
|
2205
|
-
"
|
|
2206
|
-
"operationId" : "setStatus",
|
|
2443
|
+
"operationId" : "updateAppProfilePicture",
|
|
2207
2444
|
"parameters" : [ {
|
|
2208
2445
|
"description" : "ID of the app",
|
|
2209
2446
|
"in" : "path",
|
|
@@ -2212,44 +2449,37 @@
|
|
|
2212
2449
|
"schema" : {
|
|
2213
2450
|
"type" : "string"
|
|
2214
2451
|
}
|
|
2215
|
-
}, {
|
|
2216
|
-
"description" : "Instance id",
|
|
2217
|
-
"in" : "query",
|
|
2218
|
-
"name" : "instanceId",
|
|
2219
|
-
"schema" : {
|
|
2220
|
-
"type" : "string"
|
|
2221
|
-
}
|
|
2222
2452
|
} ],
|
|
2223
2453
|
"requestBody" : {
|
|
2224
2454
|
"content" : {
|
|
2225
2455
|
"application/json" : {
|
|
2226
2456
|
"schema" : {
|
|
2227
|
-
"$ref" : "#/components/schemas/
|
|
2457
|
+
"$ref" : "#/components/schemas/FileCreationRequest"
|
|
2228
2458
|
}
|
|
2229
2459
|
}
|
|
2230
2460
|
},
|
|
2231
2461
|
"required" : true
|
|
2232
2462
|
},
|
|
2233
2463
|
"responses" : {
|
|
2234
|
-
"
|
|
2464
|
+
"201" : {
|
|
2235
2465
|
"content" : {
|
|
2236
2466
|
"application/json" : {
|
|
2237
2467
|
"schema" : {
|
|
2238
|
-
"$ref" : "#/components/schemas/
|
|
2468
|
+
"$ref" : "#/components/schemas/S3UploadBody"
|
|
2239
2469
|
}
|
|
2240
2470
|
}
|
|
2241
2471
|
},
|
|
2242
|
-
"description" : "
|
|
2472
|
+
"description" : "Profile picture updated successfully"
|
|
2243
2473
|
}
|
|
2244
2474
|
},
|
|
2245
|
-
"summary" : "
|
|
2475
|
+
"summary" : "Update profile picture for an app",
|
|
2246
2476
|
"tags" : [ "app" ]
|
|
2247
2477
|
}
|
|
2248
2478
|
},
|
|
2249
|
-
"/apps/{appId}/
|
|
2250
|
-
"
|
|
2251
|
-
"description" : "
|
|
2252
|
-
"operationId" : "
|
|
2479
|
+
"/apps/{appId}/flows" : {
|
|
2480
|
+
"post" : {
|
|
2481
|
+
"description" : "Start a conversation with a flow.",
|
|
2482
|
+
"operationId" : "createAppFlow",
|
|
2253
2483
|
"parameters" : [ {
|
|
2254
2484
|
"description" : "ID of the app",
|
|
2255
2485
|
"in" : "path",
|
|
@@ -2265,25 +2495,45 @@
|
|
|
2265
2495
|
"schema" : {
|
|
2266
2496
|
"type" : "string"
|
|
2267
2497
|
}
|
|
2268
|
-
}
|
|
2269
|
-
|
|
2270
|
-
"
|
|
2271
|
-
|
|
2272
|
-
|
|
2498
|
+
}, {
|
|
2499
|
+
"description" : "If true, the resource will not appear in history and will be deleted after a certain time.",
|
|
2500
|
+
"in" : "query",
|
|
2501
|
+
"name" : "ephemeral",
|
|
2502
|
+
"required" : false,
|
|
2503
|
+
"schema" : {
|
|
2504
|
+
"type" : "boolean"
|
|
2505
|
+
}
|
|
2506
|
+
} ],
|
|
2507
|
+
"requestBody" : {
|
|
2508
|
+
"content" : {
|
|
2509
|
+
"application/json" : {
|
|
2510
|
+
"schema" : {
|
|
2511
|
+
"$ref" : "#/components/schemas/AppFlowCreateRequest"
|
|
2512
|
+
}
|
|
2513
|
+
}
|
|
2514
|
+
},
|
|
2515
|
+
"required" : true
|
|
2516
|
+
},
|
|
2517
|
+
"responses" : {
|
|
2518
|
+
"200" : {
|
|
2519
|
+
"content" : {
|
|
2520
|
+
"application/json" : {
|
|
2273
2521
|
"schema" : {
|
|
2274
|
-
"$ref" : "#/components/schemas/
|
|
2522
|
+
"$ref" : "#/components/schemas/Flow"
|
|
2275
2523
|
}
|
|
2276
2524
|
}
|
|
2277
2525
|
},
|
|
2278
|
-
"description" : "App
|
|
2526
|
+
"description" : "App Flow created successfully"
|
|
2279
2527
|
}
|
|
2280
2528
|
},
|
|
2281
|
-
"summary" : "
|
|
2529
|
+
"summary" : "Start a chat with a flow",
|
|
2282
2530
|
"tags" : [ "app" ]
|
|
2283
|
-
}
|
|
2531
|
+
}
|
|
2532
|
+
},
|
|
2533
|
+
"/apps/{appId}/chats" : {
|
|
2284
2534
|
"post" : {
|
|
2285
|
-
"description" : "
|
|
2286
|
-
"operationId" : "
|
|
2535
|
+
"description" : "Initialize a chat",
|
|
2536
|
+
"operationId" : "createAppChat",
|
|
2287
2537
|
"parameters" : [ {
|
|
2288
2538
|
"description" : "ID of the app",
|
|
2289
2539
|
"in" : "path",
|
|
@@ -2299,30 +2549,45 @@
|
|
|
2299
2549
|
"schema" : {
|
|
2300
2550
|
"type" : "string"
|
|
2301
2551
|
}
|
|
2552
|
+
}, {
|
|
2553
|
+
"description" : "If true, the resource will not appear in history and will be deleted after a certain time.",
|
|
2554
|
+
"in" : "query",
|
|
2555
|
+
"name" : "ephemeral",
|
|
2556
|
+
"required" : false,
|
|
2557
|
+
"schema" : {
|
|
2558
|
+
"type" : "boolean"
|
|
2559
|
+
}
|
|
2302
2560
|
} ],
|
|
2303
2561
|
"requestBody" : {
|
|
2304
2562
|
"content" : {
|
|
2305
2563
|
"application/json" : {
|
|
2306
2564
|
"schema" : {
|
|
2307
|
-
"$ref" : "#/components/schemas/
|
|
2565
|
+
"$ref" : "#/components/schemas/AppChatCreateRequest"
|
|
2308
2566
|
}
|
|
2309
2567
|
}
|
|
2310
2568
|
},
|
|
2311
2569
|
"required" : true
|
|
2312
2570
|
},
|
|
2313
2571
|
"responses" : {
|
|
2314
|
-
"
|
|
2315
|
-
"
|
|
2572
|
+
"200" : {
|
|
2573
|
+
"content" : {
|
|
2574
|
+
"application/json" : {
|
|
2575
|
+
"schema" : {
|
|
2576
|
+
"$ref" : "#/components/schemas/AppChatCreateResponse"
|
|
2577
|
+
}
|
|
2578
|
+
}
|
|
2579
|
+
},
|
|
2580
|
+
"description" : "App Chat created successfully"
|
|
2316
2581
|
}
|
|
2317
2582
|
},
|
|
2318
|
-
"summary" : "
|
|
2583
|
+
"summary" : "Initialize a chat",
|
|
2319
2584
|
"tags" : [ "app" ]
|
|
2320
2585
|
}
|
|
2321
2586
|
},
|
|
2322
|
-
"/apps/{appId}/
|
|
2587
|
+
"/apps/{appId}/chats/{chatId}" : {
|
|
2323
2588
|
"post" : {
|
|
2324
|
-
"description" : "
|
|
2325
|
-
"operationId" : "
|
|
2589
|
+
"description" : "Submit a new message to a chat",
|
|
2590
|
+
"operationId" : "submitNewMessageToChat",
|
|
2326
2591
|
"parameters" : [ {
|
|
2327
2592
|
"description" : "ID of the app",
|
|
2328
2593
|
"in" : "path",
|
|
@@ -2332,30 +2597,9 @@
|
|
|
2332
2597
|
"type" : "string"
|
|
2333
2598
|
}
|
|
2334
2599
|
}, {
|
|
2335
|
-
"description" : "
|
|
2336
|
-
"in" : "query",
|
|
2337
|
-
"name" : "instanceId",
|
|
2338
|
-
"schema" : {
|
|
2339
|
-
"type" : "string"
|
|
2340
|
-
}
|
|
2341
|
-
} ],
|
|
2342
|
-
"responses" : {
|
|
2343
|
-
"204" : {
|
|
2344
|
-
"description" : "App probe refreshed successfully"
|
|
2345
|
-
}
|
|
2346
|
-
},
|
|
2347
|
-
"summary" : "Refresh the app probe",
|
|
2348
|
-
"tags" : [ "app" ]
|
|
2349
|
-
}
|
|
2350
|
-
},
|
|
2351
|
-
"/apps/{appId}/appConfiguration" : {
|
|
2352
|
-
"delete" : {
|
|
2353
|
-
"description" : "Delete app configuration",
|
|
2354
|
-
"operationId" : "deleteAppConfiguration",
|
|
2355
|
-
"parameters" : [ {
|
|
2356
|
-
"description" : "ID of the app",
|
|
2600
|
+
"description" : "ID of the chat",
|
|
2357
2601
|
"in" : "path",
|
|
2358
|
-
"name" : "
|
|
2602
|
+
"name" : "chatId",
|
|
2359
2603
|
"required" : true,
|
|
2360
2604
|
"schema" : {
|
|
2361
2605
|
"type" : "string"
|
|
@@ -2368,17 +2612,36 @@
|
|
|
2368
2612
|
"type" : "string"
|
|
2369
2613
|
}
|
|
2370
2614
|
} ],
|
|
2615
|
+
"requestBody" : {
|
|
2616
|
+
"content" : {
|
|
2617
|
+
"application/json" : {
|
|
2618
|
+
"schema" : {
|
|
2619
|
+
"$ref" : "#/components/schemas/AppChatSubmitMessageRequest"
|
|
2620
|
+
}
|
|
2621
|
+
}
|
|
2622
|
+
},
|
|
2623
|
+
"required" : true
|
|
2624
|
+
},
|
|
2371
2625
|
"responses" : {
|
|
2372
|
-
"
|
|
2373
|
-
"
|
|
2626
|
+
"200" : {
|
|
2627
|
+
"content" : {
|
|
2628
|
+
"application/json" : {
|
|
2629
|
+
"schema" : {
|
|
2630
|
+
"$ref" : "#/components/schemas/Flow"
|
|
2631
|
+
}
|
|
2632
|
+
}
|
|
2633
|
+
},
|
|
2634
|
+
"description" : "App Chat created successfully"
|
|
2374
2635
|
}
|
|
2375
2636
|
},
|
|
2376
|
-
"summary" : "
|
|
2637
|
+
"summary" : "Submit a new message to a chat",
|
|
2377
2638
|
"tags" : [ "app" ]
|
|
2378
|
-
}
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2639
|
+
}
|
|
2640
|
+
},
|
|
2641
|
+
"/apps/{appId}/say" : {
|
|
2642
|
+
"post" : {
|
|
2643
|
+
"description" : "Make the app say something",
|
|
2644
|
+
"operationId" : "saySomething",
|
|
2382
2645
|
"parameters" : [ {
|
|
2383
2646
|
"description" : "ID of the app",
|
|
2384
2647
|
"in" : "path",
|
|
@@ -2395,27 +2658,36 @@
|
|
|
2395
2658
|
"type" : "string"
|
|
2396
2659
|
}
|
|
2397
2660
|
} ],
|
|
2661
|
+
"requestBody" : {
|
|
2662
|
+
"content" : {
|
|
2663
|
+
"application/json" : {
|
|
2664
|
+
"schema" : {
|
|
2665
|
+
"$ref" : "#/components/schemas/AppChatSayRequest"
|
|
2666
|
+
}
|
|
2667
|
+
}
|
|
2668
|
+
},
|
|
2669
|
+
"required" : true
|
|
2670
|
+
},
|
|
2398
2671
|
"responses" : {
|
|
2399
2672
|
"200" : {
|
|
2400
2673
|
"content" : {
|
|
2401
2674
|
"application/json" : {
|
|
2402
2675
|
"schema" : {
|
|
2403
|
-
"$ref" : "#/components/schemas/
|
|
2676
|
+
"$ref" : "#/components/schemas/AppChatSayResponse"
|
|
2404
2677
|
}
|
|
2405
2678
|
}
|
|
2406
2679
|
},
|
|
2407
|
-
"description" : "App
|
|
2408
|
-
},
|
|
2409
|
-
"404" : {
|
|
2410
|
-
"description" : "App configuration not found"
|
|
2680
|
+
"description" : "App said something"
|
|
2411
2681
|
}
|
|
2412
2682
|
},
|
|
2413
|
-
"summary" : "
|
|
2683
|
+
"summary" : "Make the app say something",
|
|
2414
2684
|
"tags" : [ "app" ]
|
|
2415
|
-
}
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2685
|
+
}
|
|
2686
|
+
},
|
|
2687
|
+
"/apps/{appId}/messages" : {
|
|
2688
|
+
"post" : {
|
|
2689
|
+
"description" : "Submit new message",
|
|
2690
|
+
"operationId" : "submitNewMessage",
|
|
2419
2691
|
"parameters" : [ {
|
|
2420
2692
|
"description" : "ID of the app",
|
|
2421
2693
|
"in" : "path",
|
|
@@ -2436,25 +2708,33 @@
|
|
|
2436
2708
|
"content" : {
|
|
2437
2709
|
"application/json" : {
|
|
2438
2710
|
"schema" : {
|
|
2439
|
-
"$ref" : "#/components/schemas/
|
|
2711
|
+
"$ref" : "#/components/schemas/AppSubmitMessageRequest"
|
|
2440
2712
|
}
|
|
2441
2713
|
}
|
|
2442
2714
|
},
|
|
2443
2715
|
"required" : true
|
|
2444
2716
|
},
|
|
2445
2717
|
"responses" : {
|
|
2446
|
-
"
|
|
2447
|
-
"
|
|
2718
|
+
"200" : {
|
|
2719
|
+
"content" : {
|
|
2720
|
+
"application/json" : {
|
|
2721
|
+
"schema" : {
|
|
2722
|
+
"additionalProperties" : true,
|
|
2723
|
+
"type" : "object"
|
|
2724
|
+
}
|
|
2725
|
+
}
|
|
2726
|
+
},
|
|
2727
|
+
"description" : "App message submitted successfully"
|
|
2448
2728
|
}
|
|
2449
2729
|
},
|
|
2450
|
-
"summary" : "
|
|
2730
|
+
"summary" : "Submit new message",
|
|
2451
2731
|
"tags" : [ "app" ]
|
|
2452
2732
|
}
|
|
2453
2733
|
},
|
|
2454
|
-
"/apps/{appId}/
|
|
2734
|
+
"/apps/{appId}/status" : {
|
|
2455
2735
|
"post" : {
|
|
2456
|
-
"description" : "
|
|
2457
|
-
"operationId" : "
|
|
2736
|
+
"description" : "Set app status",
|
|
2737
|
+
"operationId" : "setStatus",
|
|
2458
2738
|
"parameters" : [ {
|
|
2459
2739
|
"description" : "ID of the app",
|
|
2460
2740
|
"in" : "path",
|
|
@@ -2464,10 +2744,9 @@
|
|
|
2464
2744
|
"type" : "string"
|
|
2465
2745
|
}
|
|
2466
2746
|
}, {
|
|
2467
|
-
"description" : "
|
|
2468
|
-
"in" : "
|
|
2469
|
-
"name" : "
|
|
2470
|
-
"required" : true,
|
|
2747
|
+
"description" : "Instance id",
|
|
2748
|
+
"in" : "query",
|
|
2749
|
+
"name" : "instanceId",
|
|
2471
2750
|
"schema" : {
|
|
2472
2751
|
"type" : "string"
|
|
2473
2752
|
}
|
|
@@ -2476,32 +2755,32 @@
|
|
|
2476
2755
|
"content" : {
|
|
2477
2756
|
"application/json" : {
|
|
2478
2757
|
"schema" : {
|
|
2479
|
-
"$ref" : "#/components/schemas/
|
|
2758
|
+
"$ref" : "#/components/schemas/AppStatusRequest"
|
|
2480
2759
|
}
|
|
2481
2760
|
}
|
|
2482
2761
|
},
|
|
2483
2762
|
"required" : true
|
|
2484
2763
|
},
|
|
2485
2764
|
"responses" : {
|
|
2486
|
-
"
|
|
2765
|
+
"200" : {
|
|
2487
2766
|
"content" : {
|
|
2488
2767
|
"application/json" : {
|
|
2489
2768
|
"schema" : {
|
|
2490
|
-
"$ref" : "#/components/schemas/
|
|
2769
|
+
"$ref" : "#/components/schemas/AppStatusResponse"
|
|
2491
2770
|
}
|
|
2492
2771
|
}
|
|
2493
2772
|
},
|
|
2494
|
-
"description" : "
|
|
2773
|
+
"description" : "App status set successfully"
|
|
2495
2774
|
}
|
|
2496
2775
|
},
|
|
2497
|
-
"summary" : "
|
|
2776
|
+
"summary" : "Set app status",
|
|
2498
2777
|
"tags" : [ "app" ]
|
|
2499
2778
|
}
|
|
2500
2779
|
},
|
|
2501
|
-
"/apps/{appId}/
|
|
2502
|
-
"
|
|
2503
|
-
"description" : "
|
|
2504
|
-
"operationId" : "
|
|
2780
|
+
"/apps/{appId}/probe" : {
|
|
2781
|
+
"get" : {
|
|
2782
|
+
"description" : "Probe the app",
|
|
2783
|
+
"operationId" : "getAppProbe",
|
|
2505
2784
|
"parameters" : [ {
|
|
2506
2785
|
"description" : "ID of the app",
|
|
2507
2786
|
"in" : "path",
|
|
@@ -2519,31 +2798,23 @@
|
|
|
2519
2798
|
}
|
|
2520
2799
|
} ],
|
|
2521
2800
|
"responses" : {
|
|
2522
|
-
"
|
|
2801
|
+
"200" : {
|
|
2523
2802
|
"content" : {
|
|
2524
2803
|
"application/json" : {
|
|
2525
2804
|
"schema" : {
|
|
2526
|
-
"$ref" : "#/components/schemas/
|
|
2805
|
+
"$ref" : "#/components/schemas/AppProbeResponse"
|
|
2527
2806
|
}
|
|
2528
2807
|
}
|
|
2529
2808
|
},
|
|
2530
|
-
"description" : "App
|
|
2531
|
-
},
|
|
2532
|
-
"404" : {
|
|
2533
|
-
"description" : "App not found"
|
|
2534
|
-
},
|
|
2535
|
-
"400" : {
|
|
2536
|
-
"description" : "Invalid instance ID"
|
|
2809
|
+
"description" : "App probe retrieved successfully"
|
|
2537
2810
|
}
|
|
2538
2811
|
},
|
|
2539
|
-
"summary" : "
|
|
2812
|
+
"summary" : "Probe the app",
|
|
2540
2813
|
"tags" : [ "app" ]
|
|
2541
|
-
}
|
|
2542
|
-
},
|
|
2543
|
-
"/apps/{appId}/text-to-speech" : {
|
|
2814
|
+
},
|
|
2544
2815
|
"post" : {
|
|
2545
|
-
"description" : "
|
|
2546
|
-
"operationId" : "
|
|
2816
|
+
"description" : "Probe the app",
|
|
2817
|
+
"operationId" : "probeApp",
|
|
2547
2818
|
"parameters" : [ {
|
|
2548
2819
|
"description" : "ID of the app",
|
|
2549
2820
|
"in" : "path",
|
|
@@ -2552,40 +2823,37 @@
|
|
|
2552
2823
|
"schema" : {
|
|
2553
2824
|
"type" : "string"
|
|
2554
2825
|
}
|
|
2826
|
+
}, {
|
|
2827
|
+
"description" : "Instance id",
|
|
2828
|
+
"in" : "query",
|
|
2829
|
+
"name" : "instanceId",
|
|
2830
|
+
"schema" : {
|
|
2831
|
+
"type" : "string"
|
|
2832
|
+
}
|
|
2555
2833
|
} ],
|
|
2556
2834
|
"requestBody" : {
|
|
2557
2835
|
"content" : {
|
|
2558
2836
|
"application/json" : {
|
|
2559
2837
|
"schema" : {
|
|
2560
|
-
"$ref" : "#/components/schemas/
|
|
2838
|
+
"$ref" : "#/components/schemas/AppProbeRequest"
|
|
2561
2839
|
}
|
|
2562
2840
|
}
|
|
2563
2841
|
},
|
|
2564
2842
|
"required" : true
|
|
2565
2843
|
},
|
|
2566
2844
|
"responses" : {
|
|
2567
|
-
"
|
|
2568
|
-
"
|
|
2569
|
-
"application/json" : {
|
|
2570
|
-
"schema" : {
|
|
2571
|
-
"$ref" : "#/components/schemas/AppTextToSpeechResponse"
|
|
2572
|
-
}
|
|
2573
|
-
}
|
|
2574
|
-
},
|
|
2575
|
-
"description" : "Text to speech"
|
|
2576
|
-
},
|
|
2577
|
-
"404" : {
|
|
2578
|
-
"description" : "App not found"
|
|
2845
|
+
"204" : {
|
|
2846
|
+
"description" : "App probed successfully"
|
|
2579
2847
|
}
|
|
2580
2848
|
},
|
|
2581
|
-
"summary" : "
|
|
2849
|
+
"summary" : "Probe the app",
|
|
2582
2850
|
"tags" : [ "app" ]
|
|
2583
2851
|
}
|
|
2584
2852
|
},
|
|
2585
|
-
"/apps/{appId}/
|
|
2586
|
-
"
|
|
2587
|
-
"description" : "
|
|
2588
|
-
"operationId" : "
|
|
2853
|
+
"/apps/{appId}/probe/refresh" : {
|
|
2854
|
+
"post" : {
|
|
2855
|
+
"description" : "Refresh the app probe",
|
|
2856
|
+
"operationId" : "refreshAppProbe",
|
|
2589
2857
|
"parameters" : [ {
|
|
2590
2858
|
"description" : "ID of the app",
|
|
2591
2859
|
"in" : "path",
|
|
@@ -2594,31 +2862,130 @@
|
|
|
2594
2862
|
"schema" : {
|
|
2595
2863
|
"type" : "string"
|
|
2596
2864
|
}
|
|
2597
|
-
}
|
|
2865
|
+
}, {
|
|
2866
|
+
"description" : "Instance id",
|
|
2867
|
+
"in" : "query",
|
|
2868
|
+
"name" : "instanceId",
|
|
2869
|
+
"schema" : {
|
|
2870
|
+
"type" : "string"
|
|
2871
|
+
}
|
|
2872
|
+
} ],
|
|
2873
|
+
"responses" : {
|
|
2874
|
+
"204" : {
|
|
2875
|
+
"description" : "App probe refreshed successfully"
|
|
2876
|
+
}
|
|
2877
|
+
},
|
|
2878
|
+
"summary" : "Refresh the app probe",
|
|
2879
|
+
"tags" : [ "app" ]
|
|
2880
|
+
}
|
|
2881
|
+
},
|
|
2882
|
+
"/apps/{appId}/appConfiguration" : {
|
|
2883
|
+
"delete" : {
|
|
2884
|
+
"description" : "Delete app configuration",
|
|
2885
|
+
"operationId" : "deleteAppConfiguration",
|
|
2886
|
+
"parameters" : [ {
|
|
2887
|
+
"description" : "ID of the app",
|
|
2888
|
+
"in" : "path",
|
|
2889
|
+
"name" : "appId",
|
|
2890
|
+
"required" : true,
|
|
2891
|
+
"schema" : {
|
|
2892
|
+
"type" : "string"
|
|
2893
|
+
}
|
|
2894
|
+
}, {
|
|
2895
|
+
"description" : "Instance id",
|
|
2896
|
+
"in" : "query",
|
|
2897
|
+
"name" : "instanceId",
|
|
2898
|
+
"schema" : {
|
|
2899
|
+
"type" : "string"
|
|
2900
|
+
}
|
|
2901
|
+
} ],
|
|
2902
|
+
"responses" : {
|
|
2903
|
+
"204" : {
|
|
2904
|
+
"description" : "App configuration deleted successfully"
|
|
2905
|
+
}
|
|
2906
|
+
},
|
|
2907
|
+
"summary" : "Delete app configuration",
|
|
2908
|
+
"tags" : [ "app" ]
|
|
2909
|
+
},
|
|
2910
|
+
"get" : {
|
|
2911
|
+
"description" : "Get app configuration",
|
|
2912
|
+
"operationId" : "getAppConfiguration",
|
|
2913
|
+
"parameters" : [ {
|
|
2914
|
+
"description" : "ID of the app",
|
|
2915
|
+
"in" : "path",
|
|
2916
|
+
"name" : "appId",
|
|
2917
|
+
"required" : true,
|
|
2918
|
+
"schema" : {
|
|
2919
|
+
"type" : "string"
|
|
2920
|
+
}
|
|
2921
|
+
}, {
|
|
2922
|
+
"description" : "Instance id",
|
|
2923
|
+
"in" : "query",
|
|
2924
|
+
"name" : "instanceId",
|
|
2925
|
+
"schema" : {
|
|
2926
|
+
"type" : "string"
|
|
2927
|
+
}
|
|
2928
|
+
} ],
|
|
2598
2929
|
"responses" : {
|
|
2599
2930
|
"200" : {
|
|
2600
2931
|
"content" : {
|
|
2601
2932
|
"application/json" : {
|
|
2602
2933
|
"schema" : {
|
|
2603
|
-
"
|
|
2604
|
-
"$ref" : "#/components/schemas/AppInstanceListItem"
|
|
2605
|
-
},
|
|
2606
|
-
"type" : "array"
|
|
2934
|
+
"$ref" : "#/components/schemas/AppConfiguration"
|
|
2607
2935
|
}
|
|
2608
2936
|
}
|
|
2609
2937
|
},
|
|
2610
|
-
"description" : "
|
|
2938
|
+
"description" : "App configuration retrieved successfully"
|
|
2611
2939
|
},
|
|
2612
2940
|
"404" : {
|
|
2613
|
-
"description" : "App not found"
|
|
2941
|
+
"description" : "App configuration not found"
|
|
2614
2942
|
}
|
|
2615
2943
|
},
|
|
2616
|
-
"summary" : "
|
|
2944
|
+
"summary" : "Get app configuration",
|
|
2617
2945
|
"tags" : [ "app" ]
|
|
2618
2946
|
},
|
|
2947
|
+
"put" : {
|
|
2948
|
+
"description" : "Update app configuration",
|
|
2949
|
+
"operationId" : "updateAppConfiguration",
|
|
2950
|
+
"parameters" : [ {
|
|
2951
|
+
"description" : "ID of the app",
|
|
2952
|
+
"in" : "path",
|
|
2953
|
+
"name" : "appId",
|
|
2954
|
+
"required" : true,
|
|
2955
|
+
"schema" : {
|
|
2956
|
+
"type" : "string"
|
|
2957
|
+
}
|
|
2958
|
+
}, {
|
|
2959
|
+
"description" : "Instance id",
|
|
2960
|
+
"in" : "query",
|
|
2961
|
+
"name" : "instanceId",
|
|
2962
|
+
"schema" : {
|
|
2963
|
+
"type" : "string"
|
|
2964
|
+
}
|
|
2965
|
+
} ],
|
|
2966
|
+
"requestBody" : {
|
|
2967
|
+
"content" : {
|
|
2968
|
+
"application/json" : {
|
|
2969
|
+
"schema" : {
|
|
2970
|
+
"$ref" : "#/components/schemas/AppConfiguration"
|
|
2971
|
+
}
|
|
2972
|
+
}
|
|
2973
|
+
},
|
|
2974
|
+
"required" : true
|
|
2975
|
+
},
|
|
2976
|
+
"responses" : {
|
|
2977
|
+
"204" : {
|
|
2978
|
+
"description" : "App configuration updated successfully"
|
|
2979
|
+
}
|
|
2980
|
+
},
|
|
2981
|
+
"summary" : "Update app configuration",
|
|
2982
|
+
"tags" : [ "app" ]
|
|
2983
|
+
}
|
|
2984
|
+
},
|
|
2985
|
+
"/apps/{appId}/appConfiguration/files/{type}" : {
|
|
2619
2986
|
"post" : {
|
|
2620
|
-
"description" : "
|
|
2621
|
-
"operationId" : "
|
|
2987
|
+
"description" : "Add file to app configuration",
|
|
2988
|
+
"operationId" : "addAppConfigurationFile",
|
|
2622
2989
|
"parameters" : [ {
|
|
2623
2990
|
"description" : "ID of the app",
|
|
2624
2991
|
"in" : "path",
|
|
@@ -2627,12 +2994,20 @@
|
|
|
2627
2994
|
"schema" : {
|
|
2628
2995
|
"type" : "string"
|
|
2629
2996
|
}
|
|
2997
|
+
}, {
|
|
2998
|
+
"description" : "Type of the file",
|
|
2999
|
+
"in" : "path",
|
|
3000
|
+
"name" : "type",
|
|
3001
|
+
"required" : true,
|
|
3002
|
+
"schema" : {
|
|
3003
|
+
"type" : "string"
|
|
3004
|
+
}
|
|
2630
3005
|
} ],
|
|
2631
3006
|
"requestBody" : {
|
|
2632
3007
|
"content" : {
|
|
2633
3008
|
"application/json" : {
|
|
2634
3009
|
"schema" : {
|
|
2635
|
-
"$ref" : "#/components/schemas/
|
|
3010
|
+
"$ref" : "#/components/schemas/FileCreationRequest"
|
|
2636
3011
|
}
|
|
2637
3012
|
}
|
|
2638
3013
|
},
|
|
@@ -2643,24 +3018,21 @@
|
|
|
2643
3018
|
"content" : {
|
|
2644
3019
|
"application/json" : {
|
|
2645
3020
|
"schema" : {
|
|
2646
|
-
"$ref" : "#/components/schemas/
|
|
3021
|
+
"$ref" : "#/components/schemas/FileCreationResponse"
|
|
2647
3022
|
}
|
|
2648
3023
|
}
|
|
2649
3024
|
},
|
|
2650
|
-
"description" : "
|
|
2651
|
-
},
|
|
2652
|
-
"404" : {
|
|
2653
|
-
"description" : "App not found"
|
|
3025
|
+
"description" : "File created successfully (return upload link)"
|
|
2654
3026
|
}
|
|
2655
3027
|
},
|
|
2656
|
-
"summary" : "
|
|
3028
|
+
"summary" : "Add file to app configuration",
|
|
2657
3029
|
"tags" : [ "app" ]
|
|
2658
3030
|
}
|
|
2659
3031
|
},
|
|
2660
|
-
"/apps/{appId}/
|
|
2661
|
-
"
|
|
2662
|
-
"description" : "
|
|
2663
|
-
"operationId" : "
|
|
3032
|
+
"/apps/{appId}/interrupts" : {
|
|
3033
|
+
"post" : {
|
|
3034
|
+
"description" : "Interrupt app",
|
|
3035
|
+
"operationId" : "interruptApp",
|
|
2664
3036
|
"parameters" : [ {
|
|
2665
3037
|
"description" : "ID of the app",
|
|
2666
3038
|
"in" : "path",
|
|
@@ -2670,37 +3042,39 @@
|
|
|
2670
3042
|
"type" : "string"
|
|
2671
3043
|
}
|
|
2672
3044
|
}, {
|
|
2673
|
-
"description" : "
|
|
2674
|
-
"in" : "
|
|
2675
|
-
"name" : "
|
|
2676
|
-
"required" : true,
|
|
3045
|
+
"description" : "Instance id",
|
|
3046
|
+
"in" : "query",
|
|
3047
|
+
"name" : "instanceId",
|
|
2677
3048
|
"schema" : {
|
|
2678
3049
|
"type" : "string"
|
|
2679
3050
|
}
|
|
2680
3051
|
} ],
|
|
2681
3052
|
"responses" : {
|
|
2682
|
-
"
|
|
3053
|
+
"201" : {
|
|
2683
3054
|
"content" : {
|
|
2684
|
-
"
|
|
3055
|
+
"application/json" : {
|
|
2685
3056
|
"schema" : {
|
|
2686
|
-
"
|
|
3057
|
+
"$ref" : "#/components/schemas/BodyWithId"
|
|
2687
3058
|
}
|
|
2688
3059
|
}
|
|
2689
3060
|
},
|
|
2690
|
-
"description" : "App
|
|
3061
|
+
"description" : "App interrupted"
|
|
2691
3062
|
},
|
|
2692
3063
|
"404" : {
|
|
2693
|
-
"description" : "App not found
|
|
3064
|
+
"description" : "App not found"
|
|
3065
|
+
},
|
|
3066
|
+
"400" : {
|
|
3067
|
+
"description" : "Invalid instance ID"
|
|
2694
3068
|
}
|
|
2695
3069
|
},
|
|
2696
|
-
"summary" : "
|
|
3070
|
+
"summary" : "Interrupt app",
|
|
2697
3071
|
"tags" : [ "app" ]
|
|
2698
3072
|
}
|
|
2699
3073
|
},
|
|
2700
|
-
"/apps/{appId}/
|
|
3074
|
+
"/apps/{appId}/text-to-speech" : {
|
|
2701
3075
|
"post" : {
|
|
2702
|
-
"description" : "
|
|
2703
|
-
"operationId" : "
|
|
3076
|
+
"description" : "Text to speech",
|
|
3077
|
+
"operationId" : "textToSpeech",
|
|
2704
3078
|
"parameters" : [ {
|
|
2705
3079
|
"description" : "ID of the app",
|
|
2706
3080
|
"in" : "path",
|
|
@@ -2714,7 +3088,7 @@
|
|
|
2714
3088
|
"content" : {
|
|
2715
3089
|
"application/json" : {
|
|
2716
3090
|
"schema" : {
|
|
2717
|
-
"$ref" : "#/components/schemas/
|
|
3091
|
+
"$ref" : "#/components/schemas/AppTextToSpeechRequest"
|
|
2718
3092
|
}
|
|
2719
3093
|
}
|
|
2720
3094
|
},
|
|
@@ -2725,24 +3099,24 @@
|
|
|
2725
3099
|
"content" : {
|
|
2726
3100
|
"application/json" : {
|
|
2727
3101
|
"schema" : {
|
|
2728
|
-
"$ref" : "#/components/schemas/
|
|
3102
|
+
"$ref" : "#/components/schemas/AppTextToSpeechResponse"
|
|
2729
3103
|
}
|
|
2730
3104
|
}
|
|
2731
3105
|
},
|
|
2732
|
-
"description" : "
|
|
3106
|
+
"description" : "Text to speech"
|
|
2733
3107
|
},
|
|
2734
|
-
"
|
|
2735
|
-
"description" : "
|
|
3108
|
+
"404" : {
|
|
3109
|
+
"description" : "App not found"
|
|
2736
3110
|
}
|
|
2737
3111
|
},
|
|
2738
|
-
"summary" : "
|
|
3112
|
+
"summary" : "Text to speech",
|
|
2739
3113
|
"tags" : [ "app" ]
|
|
2740
3114
|
}
|
|
2741
3115
|
},
|
|
2742
|
-
"/apps/{appId}/
|
|
2743
|
-
"
|
|
2744
|
-
"description" : "
|
|
2745
|
-
"operationId" : "
|
|
3116
|
+
"/apps/{appId}/instances" : {
|
|
3117
|
+
"get" : {
|
|
3118
|
+
"description" : "List persisted instances for an app (excludes ephemeral instances)",
|
|
3119
|
+
"operationId" : "getInstancesForAppId",
|
|
2746
3120
|
"parameters" : [ {
|
|
2747
3121
|
"description" : "ID of the app",
|
|
2748
3122
|
"in" : "path",
|
|
@@ -2751,38 +3125,31 @@
|
|
|
2751
3125
|
"schema" : {
|
|
2752
3126
|
"type" : "string"
|
|
2753
3127
|
}
|
|
2754
|
-
}, {
|
|
2755
|
-
"description" : "ID of the animation",
|
|
2756
|
-
"in" : "path",
|
|
2757
|
-
"name" : "animationId",
|
|
2758
|
-
"required" : true,
|
|
2759
|
-
"schema" : {
|
|
2760
|
-
"type" : "string"
|
|
2761
|
-
}
|
|
2762
3128
|
} ],
|
|
2763
3129
|
"responses" : {
|
|
2764
3130
|
"200" : {
|
|
2765
3131
|
"content" : {
|
|
2766
3132
|
"application/json" : {
|
|
2767
3133
|
"schema" : {
|
|
2768
|
-
"
|
|
3134
|
+
"items" : {
|
|
3135
|
+
"$ref" : "#/components/schemas/AppInstanceListItem"
|
|
3136
|
+
},
|
|
3137
|
+
"type" : "array"
|
|
2769
3138
|
}
|
|
2770
3139
|
}
|
|
2771
3140
|
},
|
|
2772
|
-
"description" : "
|
|
3141
|
+
"description" : "Instances retrieved successfully"
|
|
2773
3142
|
},
|
|
2774
3143
|
"404" : {
|
|
2775
|
-
"description" : "
|
|
3144
|
+
"description" : "App not found"
|
|
2776
3145
|
}
|
|
2777
3146
|
},
|
|
2778
|
-
"summary" : "
|
|
3147
|
+
"summary" : "List app instances",
|
|
2779
3148
|
"tags" : [ "app" ]
|
|
2780
|
-
}
|
|
2781
|
-
},
|
|
2782
|
-
"/apps/{appId}/sequences" : {
|
|
3149
|
+
},
|
|
2783
3150
|
"post" : {
|
|
2784
|
-
"description" : "
|
|
2785
|
-
"operationId" : "
|
|
3151
|
+
"description" : "Create instance",
|
|
3152
|
+
"operationId" : "createInstance",
|
|
2786
3153
|
"parameters" : [ {
|
|
2787
3154
|
"description" : "ID of the app",
|
|
2788
3155
|
"in" : "path",
|
|
@@ -2796,7 +3163,7 @@
|
|
|
2796
3163
|
"content" : {
|
|
2797
3164
|
"application/json" : {
|
|
2798
3165
|
"schema" : {
|
|
2799
|
-
"$ref" : "#/components/schemas/
|
|
3166
|
+
"$ref" : "#/components/schemas/AppInstanceCreateRequest"
|
|
2800
3167
|
}
|
|
2801
3168
|
}
|
|
2802
3169
|
},
|
|
@@ -2811,20 +3178,20 @@
|
|
|
2811
3178
|
}
|
|
2812
3179
|
}
|
|
2813
3180
|
},
|
|
2814
|
-
"description" : "
|
|
3181
|
+
"description" : "Instance created"
|
|
2815
3182
|
},
|
|
2816
|
-
"
|
|
2817
|
-
"description" : "
|
|
3183
|
+
"404" : {
|
|
3184
|
+
"description" : "App not found"
|
|
2818
3185
|
}
|
|
2819
3186
|
},
|
|
2820
|
-
"summary" : "
|
|
3187
|
+
"summary" : "Create instance",
|
|
2821
3188
|
"tags" : [ "app" ]
|
|
2822
3189
|
}
|
|
2823
3190
|
},
|
|
2824
|
-
"/apps/{appId}/
|
|
2825
|
-
"
|
|
2826
|
-
"description" : "
|
|
2827
|
-
"operationId" : "
|
|
3191
|
+
"/apps/{appId}/configuration/{property}" : {
|
|
3192
|
+
"get" : {
|
|
3193
|
+
"description" : "Get app configuration property",
|
|
3194
|
+
"operationId" : "getAppConfigurationProperty",
|
|
2828
3195
|
"parameters" : [ {
|
|
2829
3196
|
"description" : "ID of the app",
|
|
2830
3197
|
"in" : "path",
|
|
@@ -2834,9 +3201,9 @@
|
|
|
2834
3201
|
"type" : "string"
|
|
2835
3202
|
}
|
|
2836
3203
|
}, {
|
|
2837
|
-
"description" : "
|
|
3204
|
+
"description" : "Property to retrieve",
|
|
2838
3205
|
"in" : "path",
|
|
2839
|
-
"name" : "
|
|
3206
|
+
"name" : "property",
|
|
2840
3207
|
"required" : true,
|
|
2841
3208
|
"schema" : {
|
|
2842
3209
|
"type" : "string"
|
|
@@ -2845,26 +3212,190 @@
|
|
|
2845
3212
|
"responses" : {
|
|
2846
3213
|
"200" : {
|
|
2847
3214
|
"content" : {
|
|
2848
|
-
"
|
|
3215
|
+
"text/plain" : {
|
|
2849
3216
|
"schema" : {
|
|
2850
|
-
"
|
|
3217
|
+
"type" : "string"
|
|
2851
3218
|
}
|
|
2852
3219
|
}
|
|
2853
3220
|
},
|
|
2854
|
-
"description" : "
|
|
3221
|
+
"description" : "App configuration property"
|
|
2855
3222
|
},
|
|
2856
3223
|
"404" : {
|
|
2857
|
-
"description" : "
|
|
3224
|
+
"description" : "App not found or invalid property"
|
|
2858
3225
|
}
|
|
2859
3226
|
},
|
|
2860
|
-
"summary" : "
|
|
3227
|
+
"summary" : "Get app configuration property",
|
|
2861
3228
|
"tags" : [ "app" ]
|
|
2862
3229
|
}
|
|
2863
3230
|
},
|
|
2864
|
-
"/apps/{appId}/
|
|
2865
|
-
"
|
|
2866
|
-
"description" : "
|
|
2867
|
-
"operationId" : "
|
|
3231
|
+
"/apps/{appId}/animations" : {
|
|
3232
|
+
"post" : {
|
|
3233
|
+
"description" : "Add an animation to an app",
|
|
3234
|
+
"operationId" : "addAnimation",
|
|
3235
|
+
"parameters" : [ {
|
|
3236
|
+
"description" : "ID of the app",
|
|
3237
|
+
"in" : "path",
|
|
3238
|
+
"name" : "appId",
|
|
3239
|
+
"required" : true,
|
|
3240
|
+
"schema" : {
|
|
3241
|
+
"type" : "string"
|
|
3242
|
+
}
|
|
3243
|
+
} ],
|
|
3244
|
+
"requestBody" : {
|
|
3245
|
+
"content" : {
|
|
3246
|
+
"application/json" : {
|
|
3247
|
+
"schema" : {
|
|
3248
|
+
"$ref" : "#/components/schemas/AnimationCreateRequest"
|
|
3249
|
+
}
|
|
3250
|
+
}
|
|
3251
|
+
},
|
|
3252
|
+
"required" : true
|
|
3253
|
+
},
|
|
3254
|
+
"responses" : {
|
|
3255
|
+
"201" : {
|
|
3256
|
+
"content" : {
|
|
3257
|
+
"application/json" : {
|
|
3258
|
+
"schema" : {
|
|
3259
|
+
"$ref" : "#/components/schemas/BodyWithId"
|
|
3260
|
+
}
|
|
3261
|
+
}
|
|
3262
|
+
},
|
|
3263
|
+
"description" : "Animation added successfully"
|
|
3264
|
+
},
|
|
3265
|
+
"409" : {
|
|
3266
|
+
"description" : "Animation already exists"
|
|
3267
|
+
}
|
|
3268
|
+
},
|
|
3269
|
+
"summary" : "Add an animation to an app",
|
|
3270
|
+
"tags" : [ "app" ]
|
|
3271
|
+
}
|
|
3272
|
+
},
|
|
3273
|
+
"/apps/{appId}/animations/{animationId}" : {
|
|
3274
|
+
"delete" : {
|
|
3275
|
+
"description" : "Remove an animation from an app",
|
|
3276
|
+
"operationId" : "removeAnimation",
|
|
3277
|
+
"parameters" : [ {
|
|
3278
|
+
"description" : "ID of the app",
|
|
3279
|
+
"in" : "path",
|
|
3280
|
+
"name" : "appId",
|
|
3281
|
+
"required" : true,
|
|
3282
|
+
"schema" : {
|
|
3283
|
+
"type" : "string"
|
|
3284
|
+
}
|
|
3285
|
+
}, {
|
|
3286
|
+
"description" : "ID of the animation",
|
|
3287
|
+
"in" : "path",
|
|
3288
|
+
"name" : "animationId",
|
|
3289
|
+
"required" : true,
|
|
3290
|
+
"schema" : {
|
|
3291
|
+
"type" : "string"
|
|
3292
|
+
}
|
|
3293
|
+
} ],
|
|
3294
|
+
"responses" : {
|
|
3295
|
+
"200" : {
|
|
3296
|
+
"content" : {
|
|
3297
|
+
"application/json" : {
|
|
3298
|
+
"schema" : {
|
|
3299
|
+
"$ref" : "#/components/schemas/BodyWithMessage"
|
|
3300
|
+
}
|
|
3301
|
+
}
|
|
3302
|
+
},
|
|
3303
|
+
"description" : "Animation removed successfully"
|
|
3304
|
+
},
|
|
3305
|
+
"404" : {
|
|
3306
|
+
"description" : "Animation not found"
|
|
3307
|
+
}
|
|
3308
|
+
},
|
|
3309
|
+
"summary" : "Remove an animation from an app",
|
|
3310
|
+
"tags" : [ "app" ]
|
|
3311
|
+
}
|
|
3312
|
+
},
|
|
3313
|
+
"/apps/{appId}/sequences" : {
|
|
3314
|
+
"post" : {
|
|
3315
|
+
"description" : "Add a sequence to an app",
|
|
3316
|
+
"operationId" : "addSequence",
|
|
3317
|
+
"parameters" : [ {
|
|
3318
|
+
"description" : "ID of the app",
|
|
3319
|
+
"in" : "path",
|
|
3320
|
+
"name" : "appId",
|
|
3321
|
+
"required" : true,
|
|
3322
|
+
"schema" : {
|
|
3323
|
+
"type" : "string"
|
|
3324
|
+
}
|
|
3325
|
+
} ],
|
|
3326
|
+
"requestBody" : {
|
|
3327
|
+
"content" : {
|
|
3328
|
+
"application/json" : {
|
|
3329
|
+
"schema" : {
|
|
3330
|
+
"$ref" : "#/components/schemas/SequenceCreateRequest"
|
|
3331
|
+
}
|
|
3332
|
+
}
|
|
3333
|
+
},
|
|
3334
|
+
"required" : true
|
|
3335
|
+
},
|
|
3336
|
+
"responses" : {
|
|
3337
|
+
"201" : {
|
|
3338
|
+
"content" : {
|
|
3339
|
+
"application/json" : {
|
|
3340
|
+
"schema" : {
|
|
3341
|
+
"$ref" : "#/components/schemas/BodyWithId"
|
|
3342
|
+
}
|
|
3343
|
+
}
|
|
3344
|
+
},
|
|
3345
|
+
"description" : "Sequence added successfully"
|
|
3346
|
+
},
|
|
3347
|
+
"409" : {
|
|
3348
|
+
"description" : "Sequence already exists"
|
|
3349
|
+
}
|
|
3350
|
+
},
|
|
3351
|
+
"summary" : "Add a sequence to an app",
|
|
3352
|
+
"tags" : [ "app" ]
|
|
3353
|
+
}
|
|
3354
|
+
},
|
|
3355
|
+
"/apps/{appId}/sequences/{sequenceId}" : {
|
|
3356
|
+
"delete" : {
|
|
3357
|
+
"description" : "Remove a sequence from an app",
|
|
3358
|
+
"operationId" : "removeSequence",
|
|
3359
|
+
"parameters" : [ {
|
|
3360
|
+
"description" : "ID of the app",
|
|
3361
|
+
"in" : "path",
|
|
3362
|
+
"name" : "appId",
|
|
3363
|
+
"required" : true,
|
|
3364
|
+
"schema" : {
|
|
3365
|
+
"type" : "string"
|
|
3366
|
+
}
|
|
3367
|
+
}, {
|
|
3368
|
+
"description" : "ID of the sequence",
|
|
3369
|
+
"in" : "path",
|
|
3370
|
+
"name" : "sequenceId",
|
|
3371
|
+
"required" : true,
|
|
3372
|
+
"schema" : {
|
|
3373
|
+
"type" : "string"
|
|
3374
|
+
}
|
|
3375
|
+
} ],
|
|
3376
|
+
"responses" : {
|
|
3377
|
+
"200" : {
|
|
3378
|
+
"content" : {
|
|
3379
|
+
"application/json" : {
|
|
3380
|
+
"schema" : {
|
|
3381
|
+
"$ref" : "#/components/schemas/BodyWithMessage"
|
|
3382
|
+
}
|
|
3383
|
+
}
|
|
3384
|
+
},
|
|
3385
|
+
"description" : "Sequence removed successfully"
|
|
3386
|
+
},
|
|
3387
|
+
"404" : {
|
|
3388
|
+
"description" : "Sequence not found"
|
|
3389
|
+
}
|
|
3390
|
+
},
|
|
3391
|
+
"summary" : "Remove a sequence from an app",
|
|
3392
|
+
"tags" : [ "app" ]
|
|
3393
|
+
}
|
|
3394
|
+
},
|
|
3395
|
+
"/apps/{appId}/conversations" : {
|
|
3396
|
+
"get" : {
|
|
3397
|
+
"description" : "Get paginated conversations for an app",
|
|
3398
|
+
"operationId" : "getAppConversations",
|
|
2868
3399
|
"parameters" : [ {
|
|
2869
3400
|
"description" : "ID of the app",
|
|
2870
3401
|
"in" : "path",
|
|
@@ -3413,21 +3944,24 @@
|
|
|
3413
3944
|
},
|
|
3414
3945
|
"/configuration/upload-limits" : {
|
|
3415
3946
|
"get" : {
|
|
3416
|
-
"description" : "
|
|
3947
|
+
"description" : "Retrieves file upload size limits for the application",
|
|
3417
3948
|
"operationId" : "getUploadLimits",
|
|
3418
3949
|
"responses" : {
|
|
3419
3950
|
"200" : {
|
|
3420
3951
|
"content" : {
|
|
3421
3952
|
"application/json" : {
|
|
3422
3953
|
"schema" : {
|
|
3423
|
-
"$ref" : "#/components/schemas/
|
|
3954
|
+
"$ref" : "#/components/schemas/getUploadLimits_200_response"
|
|
3424
3955
|
}
|
|
3425
3956
|
}
|
|
3426
3957
|
},
|
|
3427
3958
|
"description" : "Upload limits"
|
|
3959
|
+
},
|
|
3960
|
+
"401" : {
|
|
3961
|
+
"description" : "Unauthorized"
|
|
3428
3962
|
}
|
|
3429
3963
|
},
|
|
3430
|
-
"summary" : "Get
|
|
3964
|
+
"summary" : "Get upload limits",
|
|
3431
3965
|
"tags" : [ "configuration" ]
|
|
3432
3966
|
}
|
|
3433
3967
|
},
|
|
@@ -4824,11 +5358,669 @@
|
|
|
4824
5358
|
"tags" : [ "guardians" ]
|
|
4825
5359
|
},
|
|
4826
5360
|
"get" : {
|
|
4827
|
-
"operationId" : "getGuardian",
|
|
5361
|
+
"operationId" : "getGuardian",
|
|
5362
|
+
"parameters" : [ {
|
|
5363
|
+
"description" : "ID of the guardian",
|
|
5364
|
+
"in" : "path",
|
|
5365
|
+
"name" : "guardianId",
|
|
5366
|
+
"required" : true,
|
|
5367
|
+
"schema" : {
|
|
5368
|
+
"type" : "string"
|
|
5369
|
+
}
|
|
5370
|
+
} ],
|
|
5371
|
+
"responses" : {
|
|
5372
|
+
"200" : {
|
|
5373
|
+
"content" : {
|
|
5374
|
+
"application/json" : {
|
|
5375
|
+
"schema" : {
|
|
5376
|
+
"$ref" : "#/components/schemas/Guardian"
|
|
5377
|
+
}
|
|
5378
|
+
}
|
|
5379
|
+
},
|
|
5380
|
+
"description" : "Guardian details"
|
|
5381
|
+
},
|
|
5382
|
+
"401" : {
|
|
5383
|
+
"description" : "Unauthorized"
|
|
5384
|
+
},
|
|
5385
|
+
"403" : {
|
|
5386
|
+
"description" : "Forbidden - User cannot access this guardian"
|
|
5387
|
+
},
|
|
5388
|
+
"404" : {
|
|
5389
|
+
"description" : "Guardian not found"
|
|
5390
|
+
},
|
|
5391
|
+
"500" : {
|
|
5392
|
+
"description" : "Server error"
|
|
5393
|
+
}
|
|
5394
|
+
},
|
|
5395
|
+
"summary" : "Get a specific guardian by ID",
|
|
5396
|
+
"tags" : [ "guardians" ]
|
|
5397
|
+
},
|
|
5398
|
+
"put" : {
|
|
5399
|
+
"description" : "Updates an existing guardian's configuration",
|
|
5400
|
+
"operationId" : "updateGuardian",
|
|
5401
|
+
"parameters" : [ {
|
|
5402
|
+
"description" : "ID of the guardian",
|
|
5403
|
+
"in" : "path",
|
|
5404
|
+
"name" : "guardianId",
|
|
5405
|
+
"required" : true,
|
|
5406
|
+
"schema" : {
|
|
5407
|
+
"type" : "string"
|
|
5408
|
+
}
|
|
5409
|
+
} ],
|
|
5410
|
+
"requestBody" : {
|
|
5411
|
+
"content" : {
|
|
5412
|
+
"application/json" : {
|
|
5413
|
+
"schema" : {
|
|
5414
|
+
"$ref" : "#/components/schemas/GuardianPutRequest"
|
|
5415
|
+
}
|
|
5416
|
+
}
|
|
5417
|
+
},
|
|
5418
|
+
"required" : true
|
|
5419
|
+
},
|
|
5420
|
+
"responses" : {
|
|
5421
|
+
"200" : {
|
|
5422
|
+
"content" : {
|
|
5423
|
+
"application/json" : {
|
|
5424
|
+
"schema" : {
|
|
5425
|
+
"$ref" : "#/components/schemas/Guardian"
|
|
5426
|
+
}
|
|
5427
|
+
}
|
|
5428
|
+
},
|
|
5429
|
+
"description" : "Guardian updated successfully"
|
|
5430
|
+
},
|
|
5431
|
+
"400" : {
|
|
5432
|
+
"description" : "Invalid request body"
|
|
5433
|
+
},
|
|
5434
|
+
"401" : {
|
|
5435
|
+
"description" : "Unauthorized"
|
|
5436
|
+
},
|
|
5437
|
+
"403" : {
|
|
5438
|
+
"description" : "Forbidden - User doesn't have permission"
|
|
5439
|
+
},
|
|
5440
|
+
"404" : {
|
|
5441
|
+
"description" : "Guardian not found"
|
|
5442
|
+
},
|
|
5443
|
+
"500" : {
|
|
5444
|
+
"description" : "Server error"
|
|
5445
|
+
}
|
|
5446
|
+
},
|
|
5447
|
+
"summary" : "Update a guardian",
|
|
5448
|
+
"tags" : [ "guardians" ]
|
|
5449
|
+
}
|
|
5450
|
+
},
|
|
5451
|
+
"/guardians/{guardianId}/excluded-agents" : {
|
|
5452
|
+
"put" : {
|
|
5453
|
+
"description" : "Updates the excluded agents for a guardian",
|
|
5454
|
+
"operationId" : "updateExcludedAgents",
|
|
5455
|
+
"parameters" : [ {
|
|
5456
|
+
"description" : "ID of the guardian",
|
|
5457
|
+
"in" : "path",
|
|
5458
|
+
"name" : "guardianId",
|
|
5459
|
+
"required" : true,
|
|
5460
|
+
"schema" : {
|
|
5461
|
+
"type" : "string"
|
|
5462
|
+
}
|
|
5463
|
+
} ],
|
|
5464
|
+
"requestBody" : {
|
|
5465
|
+
"content" : {
|
|
5466
|
+
"application/json" : {
|
|
5467
|
+
"schema" : {
|
|
5468
|
+
"items" : {
|
|
5469
|
+
"type" : "string"
|
|
5470
|
+
},
|
|
5471
|
+
"type" : "array"
|
|
5472
|
+
}
|
|
5473
|
+
}
|
|
5474
|
+
},
|
|
5475
|
+
"required" : true
|
|
5476
|
+
},
|
|
5477
|
+
"responses" : {
|
|
5478
|
+
"200" : {
|
|
5479
|
+
"content" : {
|
|
5480
|
+
"application/json" : {
|
|
5481
|
+
"schema" : {
|
|
5482
|
+
"$ref" : "#/components/schemas/BodyWithMessage"
|
|
5483
|
+
}
|
|
5484
|
+
}
|
|
5485
|
+
},
|
|
5486
|
+
"description" : "Guardian updated successfully"
|
|
5487
|
+
},
|
|
5488
|
+
"400" : {
|
|
5489
|
+
"description" : "Invalid request body"
|
|
5490
|
+
},
|
|
5491
|
+
"401" : {
|
|
5492
|
+
"description" : "Unauthorized"
|
|
5493
|
+
},
|
|
5494
|
+
"403" : {
|
|
5495
|
+
"description" : "Forbidden - User doesn't have permission"
|
|
5496
|
+
},
|
|
5497
|
+
"404" : {
|
|
5498
|
+
"description" : "Guardian not found"
|
|
5499
|
+
},
|
|
5500
|
+
"500" : {
|
|
5501
|
+
"description" : "Server error"
|
|
5502
|
+
}
|
|
5503
|
+
},
|
|
5504
|
+
"summary" : "Update excluded agents for a guardian",
|
|
5505
|
+
"tags" : [ "guardians" ]
|
|
5506
|
+
}
|
|
5507
|
+
},
|
|
5508
|
+
"/organizations" : {
|
|
5509
|
+
"get" : {
|
|
5510
|
+
"description" : "Lists all organizations for the current user. Admins see all organizations.",
|
|
5511
|
+
"operationId" : "listOrganizations",
|
|
5512
|
+
"responses" : {
|
|
5513
|
+
"200" : {
|
|
5514
|
+
"content" : {
|
|
5515
|
+
"application/json" : {
|
|
5516
|
+
"schema" : {
|
|
5517
|
+
"items" : {
|
|
5518
|
+
"$ref" : "#/components/schemas/Organization"
|
|
5519
|
+
},
|
|
5520
|
+
"type" : "array"
|
|
5521
|
+
}
|
|
5522
|
+
}
|
|
5523
|
+
},
|
|
5524
|
+
"description" : "List of organizations"
|
|
5525
|
+
},
|
|
5526
|
+
"401" : {
|
|
5527
|
+
"description" : "Unauthorized"
|
|
5528
|
+
},
|
|
5529
|
+
"500" : {
|
|
5530
|
+
"description" : "Server error"
|
|
5531
|
+
}
|
|
5532
|
+
},
|
|
5533
|
+
"summary" : "List organizations",
|
|
5534
|
+
"tags" : [ "organizations" ]
|
|
5535
|
+
}
|
|
5536
|
+
},
|
|
5537
|
+
"/organizations/by-slug/{slug}" : {
|
|
5538
|
+
"get" : {
|
|
5539
|
+
"description" : "Retrieves an organization by its slug",
|
|
5540
|
+
"operationId" : "getOrganizationBySlug",
|
|
5541
|
+
"parameters" : [ {
|
|
5542
|
+
"in" : "path",
|
|
5543
|
+
"name" : "slug",
|
|
5544
|
+
"required" : true,
|
|
5545
|
+
"schema" : {
|
|
5546
|
+
"type" : "string"
|
|
5547
|
+
}
|
|
5548
|
+
} ],
|
|
5549
|
+
"responses" : {
|
|
5550
|
+
"200" : {
|
|
5551
|
+
"content" : {
|
|
5552
|
+
"application/json" : {
|
|
5553
|
+
"schema" : {
|
|
5554
|
+
"$ref" : "#/components/schemas/Organization"
|
|
5555
|
+
}
|
|
5556
|
+
}
|
|
5557
|
+
},
|
|
5558
|
+
"description" : "Organization found"
|
|
5559
|
+
},
|
|
5560
|
+
"401" : {
|
|
5561
|
+
"description" : "Unauthorized"
|
|
5562
|
+
},
|
|
5563
|
+
"403" : {
|
|
5564
|
+
"description" : "Forbidden - User doesn't have permission"
|
|
5565
|
+
},
|
|
5566
|
+
"404" : {
|
|
5567
|
+
"description" : "Organization not found"
|
|
5568
|
+
},
|
|
5569
|
+
"500" : {
|
|
5570
|
+
"description" : "Server error"
|
|
5571
|
+
}
|
|
5572
|
+
},
|
|
5573
|
+
"summary" : "Get an organization by slug",
|
|
5574
|
+
"tags" : [ "organizations" ]
|
|
5575
|
+
}
|
|
5576
|
+
},
|
|
5577
|
+
"/organizations/{organizationId}" : {
|
|
5578
|
+
"get" : {
|
|
5579
|
+
"description" : "Retrieves an organization by its ID",
|
|
5580
|
+
"operationId" : "getOrganizationById",
|
|
5581
|
+
"parameters" : [ {
|
|
5582
|
+
"description" : "ID of the organization",
|
|
5583
|
+
"in" : "path",
|
|
5584
|
+
"name" : "organizationId",
|
|
5585
|
+
"required" : true,
|
|
5586
|
+
"schema" : {
|
|
5587
|
+
"type" : "string"
|
|
5588
|
+
}
|
|
5589
|
+
} ],
|
|
5590
|
+
"responses" : {
|
|
5591
|
+
"200" : {
|
|
5592
|
+
"content" : {
|
|
5593
|
+
"application/json" : {
|
|
5594
|
+
"schema" : {
|
|
5595
|
+
"$ref" : "#/components/schemas/Organization"
|
|
5596
|
+
}
|
|
5597
|
+
}
|
|
5598
|
+
},
|
|
5599
|
+
"description" : "Organization found"
|
|
5600
|
+
},
|
|
5601
|
+
"401" : {
|
|
5602
|
+
"description" : "Unauthorized"
|
|
5603
|
+
},
|
|
5604
|
+
"403" : {
|
|
5605
|
+
"description" : "Forbidden - User doesn't have permission"
|
|
5606
|
+
},
|
|
5607
|
+
"404" : {
|
|
5608
|
+
"description" : "Organization not found"
|
|
5609
|
+
},
|
|
5610
|
+
"500" : {
|
|
5611
|
+
"description" : "Server error"
|
|
5612
|
+
}
|
|
5613
|
+
},
|
|
5614
|
+
"summary" : "Get an organization by ID",
|
|
5615
|
+
"tags" : [ "organizations" ]
|
|
5616
|
+
}
|
|
5617
|
+
},
|
|
5618
|
+
"/organizations/{organizationId}/roles" : {
|
|
5619
|
+
"get" : {
|
|
5620
|
+
"description" : "Retrieves all roles configured for the given organization",
|
|
5621
|
+
"operationId" : "listOrganizationRoles",
|
|
5622
|
+
"parameters" : [ {
|
|
5623
|
+
"description" : "ID of the organization",
|
|
5624
|
+
"in" : "path",
|
|
5625
|
+
"name" : "organizationId",
|
|
5626
|
+
"required" : true,
|
|
5627
|
+
"schema" : {
|
|
5628
|
+
"type" : "string"
|
|
5629
|
+
}
|
|
5630
|
+
} ],
|
|
5631
|
+
"responses" : {
|
|
5632
|
+
"200" : {
|
|
5633
|
+
"content" : {
|
|
5634
|
+
"application/json" : {
|
|
5635
|
+
"schema" : {
|
|
5636
|
+
"items" : {
|
|
5637
|
+
"$ref" : "#/components/schemas/Role"
|
|
5638
|
+
},
|
|
5639
|
+
"type" : "array"
|
|
5640
|
+
}
|
|
5641
|
+
}
|
|
5642
|
+
},
|
|
5643
|
+
"description" : "Roles found"
|
|
5644
|
+
},
|
|
5645
|
+
"401" : {
|
|
5646
|
+
"description" : "Unauthorized"
|
|
5647
|
+
},
|
|
5648
|
+
"403" : {
|
|
5649
|
+
"description" : "Forbidden - User doesn't have permission"
|
|
5650
|
+
},
|
|
5651
|
+
"404" : {
|
|
5652
|
+
"description" : "Organization not found"
|
|
5653
|
+
},
|
|
5654
|
+
"500" : {
|
|
5655
|
+
"description" : "Server error"
|
|
5656
|
+
}
|
|
5657
|
+
},
|
|
5658
|
+
"summary" : "List roles of an organization",
|
|
5659
|
+
"tags" : [ "organizations" ]
|
|
5660
|
+
},
|
|
5661
|
+
"post" : {
|
|
5662
|
+
"description" : "Creates a new agent role in the specified organization",
|
|
5663
|
+
"operationId" : "createOrganizationRole",
|
|
5664
|
+
"parameters" : [ {
|
|
5665
|
+
"description" : "ID of the organization",
|
|
5666
|
+
"in" : "path",
|
|
5667
|
+
"name" : "organizationId",
|
|
5668
|
+
"required" : true,
|
|
5669
|
+
"schema" : {
|
|
5670
|
+
"type" : "string"
|
|
5671
|
+
}
|
|
5672
|
+
} ],
|
|
5673
|
+
"requestBody" : {
|
|
5674
|
+
"content" : {
|
|
5675
|
+
"application/json" : {
|
|
5676
|
+
"schema" : {
|
|
5677
|
+
"$ref" : "#/components/schemas/RoleCreateRequest"
|
|
5678
|
+
}
|
|
5679
|
+
}
|
|
5680
|
+
},
|
|
5681
|
+
"required" : true
|
|
5682
|
+
},
|
|
5683
|
+
"responses" : {
|
|
5684
|
+
"201" : {
|
|
5685
|
+
"content" : {
|
|
5686
|
+
"application/json" : {
|
|
5687
|
+
"schema" : {
|
|
5688
|
+
"$ref" : "#/components/schemas/Role"
|
|
5689
|
+
}
|
|
5690
|
+
}
|
|
5691
|
+
},
|
|
5692
|
+
"description" : "Role created successfully"
|
|
5693
|
+
},
|
|
5694
|
+
"400" : {
|
|
5695
|
+
"description" : "Invalid request body"
|
|
5696
|
+
},
|
|
5697
|
+
"401" : {
|
|
5698
|
+
"description" : "Unauthorized"
|
|
5699
|
+
},
|
|
5700
|
+
"403" : {
|
|
5701
|
+
"description" : "Forbidden - User doesn't have permission"
|
|
5702
|
+
},
|
|
5703
|
+
"404" : {
|
|
5704
|
+
"description" : "Organization not found"
|
|
5705
|
+
},
|
|
5706
|
+
"500" : {
|
|
5707
|
+
"description" : "Server error"
|
|
5708
|
+
}
|
|
5709
|
+
},
|
|
5710
|
+
"summary" : "Create a role in an organization",
|
|
5711
|
+
"tags" : [ "organizations" ]
|
|
5712
|
+
}
|
|
5713
|
+
},
|
|
5714
|
+
"/organizations/{organizationId}/roles/{roleId}" : {
|
|
5715
|
+
"delete" : {
|
|
5716
|
+
"description" : "Deletes an agent role from the specified organization",
|
|
5717
|
+
"operationId" : "deleteOrganizationRole",
|
|
5718
|
+
"parameters" : [ {
|
|
5719
|
+
"description" : "ID of the organization",
|
|
5720
|
+
"in" : "path",
|
|
5721
|
+
"name" : "organizationId",
|
|
5722
|
+
"required" : true,
|
|
5723
|
+
"schema" : {
|
|
5724
|
+
"type" : "string"
|
|
5725
|
+
}
|
|
5726
|
+
}, {
|
|
5727
|
+
"description" : "ID of the role to delete",
|
|
5728
|
+
"in" : "path",
|
|
5729
|
+
"name" : "roleId",
|
|
5730
|
+
"required" : true,
|
|
5731
|
+
"schema" : {
|
|
5732
|
+
"type" : "string"
|
|
5733
|
+
}
|
|
5734
|
+
} ],
|
|
5735
|
+
"responses" : {
|
|
5736
|
+
"204" : {
|
|
5737
|
+
"description" : "Role deleted successfully"
|
|
5738
|
+
},
|
|
5739
|
+
"401" : {
|
|
5740
|
+
"description" : "Unauthorized"
|
|
5741
|
+
},
|
|
5742
|
+
"403" : {
|
|
5743
|
+
"description" : "Forbidden - User doesn't have permission"
|
|
5744
|
+
},
|
|
5745
|
+
"404" : {
|
|
5746
|
+
"description" : "Organization not found"
|
|
5747
|
+
},
|
|
5748
|
+
"500" : {
|
|
5749
|
+
"description" : "Server error"
|
|
5750
|
+
}
|
|
5751
|
+
},
|
|
5752
|
+
"summary" : "Delete a role from an organization",
|
|
5753
|
+
"tags" : [ "organizations" ]
|
|
5754
|
+
},
|
|
5755
|
+
"put" : {
|
|
5756
|
+
"description" : "Updates an existing agent role in the specified organization",
|
|
5757
|
+
"operationId" : "updateOrganizationRole",
|
|
5758
|
+
"parameters" : [ {
|
|
5759
|
+
"description" : "ID of the organization",
|
|
5760
|
+
"in" : "path",
|
|
5761
|
+
"name" : "organizationId",
|
|
5762
|
+
"required" : true,
|
|
5763
|
+
"schema" : {
|
|
5764
|
+
"type" : "string"
|
|
5765
|
+
}
|
|
5766
|
+
}, {
|
|
5767
|
+
"description" : "ID of the role to update",
|
|
5768
|
+
"in" : "path",
|
|
5769
|
+
"name" : "roleId",
|
|
5770
|
+
"required" : true,
|
|
5771
|
+
"schema" : {
|
|
5772
|
+
"type" : "string"
|
|
5773
|
+
}
|
|
5774
|
+
} ],
|
|
5775
|
+
"requestBody" : {
|
|
5776
|
+
"content" : {
|
|
5777
|
+
"application/json" : {
|
|
5778
|
+
"schema" : {
|
|
5779
|
+
"$ref" : "#/components/schemas/RoleCreateRequest"
|
|
5780
|
+
}
|
|
5781
|
+
}
|
|
5782
|
+
},
|
|
5783
|
+
"required" : true
|
|
5784
|
+
},
|
|
5785
|
+
"responses" : {
|
|
5786
|
+
"204" : {
|
|
5787
|
+
"description" : "Role updated successfully"
|
|
5788
|
+
},
|
|
5789
|
+
"400" : {
|
|
5790
|
+
"description" : "Invalid request body"
|
|
5791
|
+
},
|
|
5792
|
+
"401" : {
|
|
5793
|
+
"description" : "Unauthorized"
|
|
5794
|
+
},
|
|
5795
|
+
"403" : {
|
|
5796
|
+
"description" : "Forbidden - User doesn't have permission"
|
|
5797
|
+
},
|
|
5798
|
+
"404" : {
|
|
5799
|
+
"description" : "Organization not found"
|
|
5800
|
+
},
|
|
5801
|
+
"500" : {
|
|
5802
|
+
"description" : "Server error"
|
|
5803
|
+
}
|
|
5804
|
+
},
|
|
5805
|
+
"summary" : "Update a role in an organization",
|
|
5806
|
+
"tags" : [ "organizations" ]
|
|
5807
|
+
}
|
|
5808
|
+
},
|
|
5809
|
+
"/organizations/{organizationId}/access-roles" : {
|
|
5810
|
+
"get" : {
|
|
5811
|
+
"operationId" : "listOrganizationAccessRoles",
|
|
5812
|
+
"parameters" : [ {
|
|
5813
|
+
"description" : "ID of the organization",
|
|
5814
|
+
"in" : "path",
|
|
5815
|
+
"name" : "organizationId",
|
|
5816
|
+
"required" : true,
|
|
5817
|
+
"schema" : {
|
|
5818
|
+
"type" : "string"
|
|
5819
|
+
}
|
|
5820
|
+
} ],
|
|
5821
|
+
"responses" : {
|
|
5822
|
+
"200" : {
|
|
5823
|
+
"content" : {
|
|
5824
|
+
"application/json" : {
|
|
5825
|
+
"schema" : {
|
|
5826
|
+
"items" : {
|
|
5827
|
+
"$ref" : "#/components/schemas/AccessRole"
|
|
5828
|
+
},
|
|
5829
|
+
"type" : "array"
|
|
5830
|
+
}
|
|
5831
|
+
}
|
|
5832
|
+
},
|
|
5833
|
+
"description" : "Access roles found"
|
|
5834
|
+
},
|
|
5835
|
+
"401" : {
|
|
5836
|
+
"description" : "Unauthorized"
|
|
5837
|
+
},
|
|
5838
|
+
"404" : {
|
|
5839
|
+
"description" : "Organization not found"
|
|
5840
|
+
}
|
|
5841
|
+
},
|
|
5842
|
+
"summary" : "List access roles of an organization",
|
|
5843
|
+
"tags" : [ "organizations" ]
|
|
5844
|
+
},
|
|
5845
|
+
"post" : {
|
|
5846
|
+
"operationId" : "createOrganizationAccessRole",
|
|
5847
|
+
"parameters" : [ {
|
|
5848
|
+
"description" : "ID of the organization",
|
|
5849
|
+
"in" : "path",
|
|
5850
|
+
"name" : "organizationId",
|
|
5851
|
+
"required" : true,
|
|
5852
|
+
"schema" : {
|
|
5853
|
+
"type" : "string"
|
|
5854
|
+
}
|
|
5855
|
+
} ],
|
|
5856
|
+
"requestBody" : {
|
|
5857
|
+
"content" : {
|
|
5858
|
+
"application/json" : {
|
|
5859
|
+
"schema" : {
|
|
5860
|
+
"$ref" : "#/components/schemas/AccessRoleCreateRequest"
|
|
5861
|
+
}
|
|
5862
|
+
}
|
|
5863
|
+
},
|
|
5864
|
+
"required" : true
|
|
5865
|
+
},
|
|
5866
|
+
"responses" : {
|
|
5867
|
+
"201" : {
|
|
5868
|
+
"content" : {
|
|
5869
|
+
"application/json" : {
|
|
5870
|
+
"schema" : {
|
|
5871
|
+
"$ref" : "#/components/schemas/AccessRole"
|
|
5872
|
+
}
|
|
5873
|
+
}
|
|
5874
|
+
},
|
|
5875
|
+
"description" : "Access role created"
|
|
5876
|
+
},
|
|
5877
|
+
"400" : {
|
|
5878
|
+
"description" : "Invalid request body"
|
|
5879
|
+
},
|
|
5880
|
+
"401" : {
|
|
5881
|
+
"description" : "Unauthorized"
|
|
5882
|
+
},
|
|
5883
|
+
"404" : {
|
|
5884
|
+
"description" : "Organization not found"
|
|
5885
|
+
}
|
|
5886
|
+
},
|
|
5887
|
+
"summary" : "Create an access role in an organization",
|
|
5888
|
+
"tags" : [ "organizations" ]
|
|
5889
|
+
}
|
|
5890
|
+
},
|
|
5891
|
+
"/organizations/{organizationId}/access-roles/{roleId}" : {
|
|
5892
|
+
"delete" : {
|
|
5893
|
+
"operationId" : "deleteOrganizationAccessRole",
|
|
5894
|
+
"parameters" : [ {
|
|
5895
|
+
"description" : "ID of the organization",
|
|
5896
|
+
"in" : "path",
|
|
5897
|
+
"name" : "organizationId",
|
|
5898
|
+
"required" : true,
|
|
5899
|
+
"schema" : {
|
|
5900
|
+
"type" : "string"
|
|
5901
|
+
}
|
|
5902
|
+
}, {
|
|
5903
|
+
"in" : "path",
|
|
5904
|
+
"name" : "roleId",
|
|
5905
|
+
"required" : true,
|
|
5906
|
+
"schema" : {
|
|
5907
|
+
"type" : "string"
|
|
5908
|
+
}
|
|
5909
|
+
} ],
|
|
5910
|
+
"responses" : {
|
|
5911
|
+
"204" : {
|
|
5912
|
+
"description" : "Access role deleted"
|
|
5913
|
+
},
|
|
5914
|
+
"401" : {
|
|
5915
|
+
"description" : "Unauthorized"
|
|
5916
|
+
},
|
|
5917
|
+
"404" : {
|
|
5918
|
+
"description" : "Organization not found"
|
|
5919
|
+
}
|
|
5920
|
+
},
|
|
5921
|
+
"summary" : "Delete an access role from an organization",
|
|
5922
|
+
"tags" : [ "organizations" ]
|
|
5923
|
+
},
|
|
5924
|
+
"put" : {
|
|
5925
|
+
"operationId" : "updateOrganizationAccessRole",
|
|
5926
|
+
"parameters" : [ {
|
|
5927
|
+
"description" : "ID of the organization",
|
|
5928
|
+
"in" : "path",
|
|
5929
|
+
"name" : "organizationId",
|
|
5930
|
+
"required" : true,
|
|
5931
|
+
"schema" : {
|
|
5932
|
+
"type" : "string"
|
|
5933
|
+
}
|
|
5934
|
+
}, {
|
|
5935
|
+
"in" : "path",
|
|
5936
|
+
"name" : "roleId",
|
|
5937
|
+
"required" : true,
|
|
5938
|
+
"schema" : {
|
|
5939
|
+
"type" : "string"
|
|
5940
|
+
}
|
|
5941
|
+
} ],
|
|
5942
|
+
"requestBody" : {
|
|
5943
|
+
"content" : {
|
|
5944
|
+
"application/json" : {
|
|
5945
|
+
"schema" : {
|
|
5946
|
+
"$ref" : "#/components/schemas/AccessRoleUpdateRequest"
|
|
5947
|
+
}
|
|
5948
|
+
}
|
|
5949
|
+
},
|
|
5950
|
+
"required" : true
|
|
5951
|
+
},
|
|
5952
|
+
"responses" : {
|
|
5953
|
+
"204" : {
|
|
5954
|
+
"description" : "Access role updated"
|
|
5955
|
+
},
|
|
5956
|
+
"400" : {
|
|
5957
|
+
"description" : "Invalid request body"
|
|
5958
|
+
},
|
|
5959
|
+
"401" : {
|
|
5960
|
+
"description" : "Unauthorized"
|
|
5961
|
+
},
|
|
5962
|
+
"404" : {
|
|
5963
|
+
"description" : "Organization not found"
|
|
5964
|
+
}
|
|
5965
|
+
},
|
|
5966
|
+
"summary" : "Update an access role in an organization",
|
|
5967
|
+
"tags" : [ "organizations" ]
|
|
5968
|
+
}
|
|
5969
|
+
},
|
|
5970
|
+
"/organizations/{organizationId}/access-roles/{roleId}/permissions" : {
|
|
5971
|
+
"put" : {
|
|
5972
|
+
"operationId" : "setOrganizationAccessRolePermissions",
|
|
5973
|
+
"parameters" : [ {
|
|
5974
|
+
"description" : "ID of the organization",
|
|
5975
|
+
"in" : "path",
|
|
5976
|
+
"name" : "organizationId",
|
|
5977
|
+
"required" : true,
|
|
5978
|
+
"schema" : {
|
|
5979
|
+
"type" : "string"
|
|
5980
|
+
}
|
|
5981
|
+
}, {
|
|
5982
|
+
"in" : "path",
|
|
5983
|
+
"name" : "roleId",
|
|
5984
|
+
"required" : true,
|
|
5985
|
+
"schema" : {
|
|
5986
|
+
"type" : "string"
|
|
5987
|
+
}
|
|
5988
|
+
} ],
|
|
5989
|
+
"requestBody" : {
|
|
5990
|
+
"content" : {
|
|
5991
|
+
"application/json" : {
|
|
5992
|
+
"schema" : {
|
|
5993
|
+
"$ref" : "#/components/schemas/AccessRolePermissionsRequest"
|
|
5994
|
+
}
|
|
5995
|
+
}
|
|
5996
|
+
},
|
|
5997
|
+
"required" : true
|
|
5998
|
+
},
|
|
5999
|
+
"responses" : {
|
|
6000
|
+
"204" : {
|
|
6001
|
+
"description" : "Permissions updated"
|
|
6002
|
+
},
|
|
6003
|
+
"400" : {
|
|
6004
|
+
"description" : "Invalid request body"
|
|
6005
|
+
},
|
|
6006
|
+
"401" : {
|
|
6007
|
+
"description" : "Unauthorized"
|
|
6008
|
+
},
|
|
6009
|
+
"404" : {
|
|
6010
|
+
"description" : "Organization not found"
|
|
6011
|
+
}
|
|
6012
|
+
},
|
|
6013
|
+
"summary" : "Set permissions for an access role",
|
|
6014
|
+
"tags" : [ "organizations" ]
|
|
6015
|
+
}
|
|
6016
|
+
},
|
|
6017
|
+
"/organizations/{organizationId}/members/me/permissions" : {
|
|
6018
|
+
"get" : {
|
|
6019
|
+
"operationId" : "getOrganizationMemberPermissions",
|
|
4828
6020
|
"parameters" : [ {
|
|
4829
|
-
"description" : "ID of the
|
|
6021
|
+
"description" : "ID of the organization",
|
|
4830
6022
|
"in" : "path",
|
|
4831
|
-
"name" : "
|
|
6023
|
+
"name" : "organizationId",
|
|
4832
6024
|
"required" : true,
|
|
4833
6025
|
"schema" : {
|
|
4834
6026
|
"type" : "string"
|
|
@@ -4839,89 +6031,65 @@
|
|
|
4839
6031
|
"content" : {
|
|
4840
6032
|
"application/json" : {
|
|
4841
6033
|
"schema" : {
|
|
4842
|
-
"$ref" : "#/components/schemas/
|
|
6034
|
+
"$ref" : "#/components/schemas/MemberPermissions"
|
|
4843
6035
|
}
|
|
4844
6036
|
}
|
|
4845
6037
|
},
|
|
4846
|
-
"description" : "
|
|
6038
|
+
"description" : "Resolved permissions for the current member"
|
|
4847
6039
|
},
|
|
4848
6040
|
"401" : {
|
|
4849
6041
|
"description" : "Unauthorized"
|
|
4850
6042
|
},
|
|
4851
|
-
"403" : {
|
|
4852
|
-
"description" : "Forbidden - User cannot access this guardian"
|
|
4853
|
-
},
|
|
4854
6043
|
"404" : {
|
|
4855
|
-
"description" : "
|
|
4856
|
-
},
|
|
4857
|
-
"500" : {
|
|
4858
|
-
"description" : "Server error"
|
|
6044
|
+
"description" : "Organization not found"
|
|
4859
6045
|
}
|
|
4860
6046
|
},
|
|
4861
|
-
"summary" : "Get
|
|
4862
|
-
"tags" : [ "
|
|
4863
|
-
}
|
|
4864
|
-
|
|
4865
|
-
|
|
4866
|
-
|
|
6047
|
+
"summary" : "Get current member resolved permissions",
|
|
6048
|
+
"tags" : [ "organizations" ]
|
|
6049
|
+
}
|
|
6050
|
+
},
|
|
6051
|
+
"/organizations/{organizationId}/users" : {
|
|
6052
|
+
"get" : {
|
|
6053
|
+
"operationId" : "listOrganizationUsers",
|
|
4867
6054
|
"parameters" : [ {
|
|
4868
|
-
"description" : "ID of the
|
|
6055
|
+
"description" : "ID of the organization",
|
|
4869
6056
|
"in" : "path",
|
|
4870
|
-
"name" : "
|
|
6057
|
+
"name" : "organizationId",
|
|
4871
6058
|
"required" : true,
|
|
4872
6059
|
"schema" : {
|
|
4873
6060
|
"type" : "string"
|
|
4874
6061
|
}
|
|
4875
6062
|
} ],
|
|
4876
|
-
"requestBody" : {
|
|
4877
|
-
"content" : {
|
|
4878
|
-
"application/json" : {
|
|
4879
|
-
"schema" : {
|
|
4880
|
-
"$ref" : "#/components/schemas/GuardianPutRequest"
|
|
4881
|
-
}
|
|
4882
|
-
}
|
|
4883
|
-
},
|
|
4884
|
-
"required" : true
|
|
4885
|
-
},
|
|
4886
6063
|
"responses" : {
|
|
4887
6064
|
"200" : {
|
|
4888
6065
|
"content" : {
|
|
4889
6066
|
"application/json" : {
|
|
4890
6067
|
"schema" : {
|
|
4891
|
-
"
|
|
6068
|
+
"items" : {
|
|
6069
|
+
"$ref" : "#/components/schemas/OrganizationMember"
|
|
6070
|
+
},
|
|
6071
|
+
"type" : "array"
|
|
4892
6072
|
}
|
|
4893
6073
|
}
|
|
4894
6074
|
},
|
|
4895
|
-
"description" : "
|
|
4896
|
-
},
|
|
4897
|
-
"400" : {
|
|
4898
|
-
"description" : "Invalid request body"
|
|
6075
|
+
"description" : "Organization users"
|
|
4899
6076
|
},
|
|
4900
6077
|
"401" : {
|
|
4901
6078
|
"description" : "Unauthorized"
|
|
4902
6079
|
},
|
|
4903
|
-
"403" : {
|
|
4904
|
-
"description" : "Forbidden - User doesn't have permission"
|
|
4905
|
-
},
|
|
4906
6080
|
"404" : {
|
|
4907
|
-
"description" : "
|
|
4908
|
-
},
|
|
4909
|
-
"500" : {
|
|
4910
|
-
"description" : "Server error"
|
|
6081
|
+
"description" : "Organization not found"
|
|
4911
6082
|
}
|
|
4912
6083
|
},
|
|
4913
|
-
"summary" : "
|
|
4914
|
-
"tags" : [ "
|
|
4915
|
-
}
|
|
4916
|
-
|
|
4917
|
-
|
|
4918
|
-
"put" : {
|
|
4919
|
-
"description" : "Updates the excluded agents for a guardian",
|
|
4920
|
-
"operationId" : "updateExcludedAgents",
|
|
6084
|
+
"summary" : "List users of an organization",
|
|
6085
|
+
"tags" : [ "organizations" ]
|
|
6086
|
+
},
|
|
6087
|
+
"post" : {
|
|
6088
|
+
"operationId" : "inviteOrganizationUser",
|
|
4921
6089
|
"parameters" : [ {
|
|
4922
|
-
"description" : "ID of the
|
|
6090
|
+
"description" : "ID of the organization",
|
|
4923
6091
|
"in" : "path",
|
|
4924
|
-
"name" : "
|
|
6092
|
+
"name" : "organizationId",
|
|
4925
6093
|
"required" : true,
|
|
4926
6094
|
"schema" : {
|
|
4927
6095
|
"type" : "string"
|
|
@@ -4931,25 +6099,22 @@
|
|
|
4931
6099
|
"content" : {
|
|
4932
6100
|
"application/json" : {
|
|
4933
6101
|
"schema" : {
|
|
4934
|
-
"
|
|
4935
|
-
"type" : "string"
|
|
4936
|
-
},
|
|
4937
|
-
"type" : "array"
|
|
6102
|
+
"$ref" : "#/components/schemas/OrganizationUserInviteRequest"
|
|
4938
6103
|
}
|
|
4939
6104
|
}
|
|
4940
6105
|
},
|
|
4941
6106
|
"required" : true
|
|
4942
6107
|
},
|
|
4943
6108
|
"responses" : {
|
|
4944
|
-
"
|
|
6109
|
+
"201" : {
|
|
4945
6110
|
"content" : {
|
|
4946
6111
|
"application/json" : {
|
|
4947
6112
|
"schema" : {
|
|
4948
|
-
"$ref" : "#/components/schemas/
|
|
6113
|
+
"$ref" : "#/components/schemas/OrganizationUserInviteResponse"
|
|
4949
6114
|
}
|
|
4950
6115
|
}
|
|
4951
6116
|
},
|
|
4952
|
-
"description" : "
|
|
6117
|
+
"description" : "User invited"
|
|
4953
6118
|
},
|
|
4954
6119
|
"400" : {
|
|
4955
6120
|
"description" : "Invalid request body"
|
|
@@ -4957,93 +6122,54 @@
|
|
|
4957
6122
|
"401" : {
|
|
4958
6123
|
"description" : "Unauthorized"
|
|
4959
6124
|
},
|
|
4960
|
-
"
|
|
4961
|
-
"description" : "
|
|
4962
|
-
},
|
|
4963
|
-
"404" : {
|
|
4964
|
-
"description" : "Guardian not found"
|
|
4965
|
-
},
|
|
4966
|
-
"500" : {
|
|
4967
|
-
"description" : "Server error"
|
|
4968
|
-
}
|
|
4969
|
-
},
|
|
4970
|
-
"summary" : "Update excluded agents for a guardian",
|
|
4971
|
-
"tags" : [ "guardians" ]
|
|
4972
|
-
}
|
|
4973
|
-
},
|
|
4974
|
-
"/organizations" : {
|
|
4975
|
-
"get" : {
|
|
4976
|
-
"description" : "Lists all organizations for the current user. Admins see all organizations.",
|
|
4977
|
-
"operationId" : "listOrganizations",
|
|
4978
|
-
"responses" : {
|
|
4979
|
-
"200" : {
|
|
4980
|
-
"content" : {
|
|
4981
|
-
"application/json" : {
|
|
4982
|
-
"schema" : {
|
|
4983
|
-
"items" : {
|
|
4984
|
-
"$ref" : "#/components/schemas/Organization"
|
|
4985
|
-
},
|
|
4986
|
-
"type" : "array"
|
|
4987
|
-
}
|
|
4988
|
-
}
|
|
4989
|
-
},
|
|
4990
|
-
"description" : "List of organizations"
|
|
4991
|
-
},
|
|
4992
|
-
"401" : {
|
|
4993
|
-
"description" : "Unauthorized"
|
|
4994
|
-
},
|
|
4995
|
-
"500" : {
|
|
4996
|
-
"description" : "Server error"
|
|
6125
|
+
"409" : {
|
|
6126
|
+
"description" : "User already in organization"
|
|
4997
6127
|
}
|
|
4998
6128
|
},
|
|
4999
|
-
"summary" : "
|
|
6129
|
+
"summary" : "Invite a user to an organization",
|
|
5000
6130
|
"tags" : [ "organizations" ]
|
|
5001
6131
|
}
|
|
5002
6132
|
},
|
|
5003
|
-
"/organizations/
|
|
5004
|
-
"
|
|
5005
|
-
"
|
|
5006
|
-
"operationId" : "getOrganizationBySlug",
|
|
6133
|
+
"/organizations/{organizationId}/users/{userId}" : {
|
|
6134
|
+
"delete" : {
|
|
6135
|
+
"operationId" : "deleteOrganizationUser",
|
|
5007
6136
|
"parameters" : [ {
|
|
6137
|
+
"description" : "ID of the organization",
|
|
5008
6138
|
"in" : "path",
|
|
5009
|
-
"name" : "
|
|
6139
|
+
"name" : "organizationId",
|
|
6140
|
+
"required" : true,
|
|
6141
|
+
"schema" : {
|
|
6142
|
+
"type" : "string"
|
|
6143
|
+
}
|
|
6144
|
+
}, {
|
|
6145
|
+
"in" : "path",
|
|
6146
|
+
"name" : "userId",
|
|
5010
6147
|
"required" : true,
|
|
5011
6148
|
"schema" : {
|
|
5012
6149
|
"type" : "string"
|
|
5013
6150
|
}
|
|
5014
6151
|
} ],
|
|
5015
6152
|
"responses" : {
|
|
5016
|
-
"
|
|
5017
|
-
"
|
|
5018
|
-
"application/json" : {
|
|
5019
|
-
"schema" : {
|
|
5020
|
-
"$ref" : "#/components/schemas/Organization"
|
|
5021
|
-
}
|
|
5022
|
-
}
|
|
5023
|
-
},
|
|
5024
|
-
"description" : "Organization found"
|
|
6153
|
+
"204" : {
|
|
6154
|
+
"description" : "User removed"
|
|
5025
6155
|
},
|
|
5026
6156
|
"401" : {
|
|
5027
6157
|
"description" : "Unauthorized"
|
|
5028
6158
|
},
|
|
5029
6159
|
"403" : {
|
|
5030
|
-
"description" : "
|
|
6160
|
+
"description" : "Cannot delete admin user"
|
|
5031
6161
|
},
|
|
5032
6162
|
"404" : {
|
|
5033
|
-
"description" : "Organization not found"
|
|
5034
|
-
},
|
|
5035
|
-
"500" : {
|
|
5036
|
-
"description" : "Server error"
|
|
6163
|
+
"description" : "Organization or user not found"
|
|
5037
6164
|
}
|
|
5038
6165
|
},
|
|
5039
|
-
"summary" : "
|
|
6166
|
+
"summary" : "Remove a user from an organization",
|
|
5040
6167
|
"tags" : [ "organizations" ]
|
|
5041
6168
|
}
|
|
5042
6169
|
},
|
|
5043
|
-
"/organizations/{organizationId}" : {
|
|
6170
|
+
"/organizations/{organizationId}/users/{userId}/access" : {
|
|
5044
6171
|
"get" : {
|
|
5045
|
-
"
|
|
5046
|
-
"operationId" : "getOrganizationById",
|
|
6172
|
+
"operationId" : "getOrganizationUserAccess",
|
|
5047
6173
|
"parameters" : [ {
|
|
5048
6174
|
"description" : "ID of the organization",
|
|
5049
6175
|
"in" : "path",
|
|
@@ -5052,39 +6178,39 @@
|
|
|
5052
6178
|
"schema" : {
|
|
5053
6179
|
"type" : "string"
|
|
5054
6180
|
}
|
|
6181
|
+
}, {
|
|
6182
|
+
"in" : "path",
|
|
6183
|
+
"name" : "userId",
|
|
6184
|
+
"required" : true,
|
|
6185
|
+
"schema" : {
|
|
6186
|
+
"type" : "string"
|
|
6187
|
+
}
|
|
5055
6188
|
} ],
|
|
5056
6189
|
"responses" : {
|
|
5057
6190
|
"200" : {
|
|
5058
6191
|
"content" : {
|
|
5059
6192
|
"application/json" : {
|
|
5060
6193
|
"schema" : {
|
|
5061
|
-
"$ref" : "#/components/schemas/
|
|
6194
|
+
"$ref" : "#/components/schemas/UserAccess"
|
|
5062
6195
|
}
|
|
5063
6196
|
}
|
|
5064
6197
|
},
|
|
5065
|
-
"description" : "
|
|
6198
|
+
"description" : "User access configuration"
|
|
5066
6199
|
},
|
|
5067
6200
|
"401" : {
|
|
5068
6201
|
"description" : "Unauthorized"
|
|
5069
6202
|
},
|
|
5070
|
-
"403" : {
|
|
5071
|
-
"description" : "Forbidden - User doesn't have permission"
|
|
5072
|
-
},
|
|
5073
6203
|
"404" : {
|
|
5074
|
-
"description" : "Organization not found"
|
|
5075
|
-
},
|
|
5076
|
-
"500" : {
|
|
5077
|
-
"description" : "Server error"
|
|
6204
|
+
"description" : "Organization or user not found"
|
|
5078
6205
|
}
|
|
5079
6206
|
},
|
|
5080
|
-
"summary" : "Get
|
|
6207
|
+
"summary" : "Get user access roles and direct permissions",
|
|
5081
6208
|
"tags" : [ "organizations" ]
|
|
5082
6209
|
}
|
|
5083
6210
|
},
|
|
5084
|
-
"/organizations/{organizationId}/roles" : {
|
|
5085
|
-
"
|
|
5086
|
-
"
|
|
5087
|
-
"operationId" : "listOrganizationRoles",
|
|
6211
|
+
"/organizations/{organizationId}/users/{userId}/access-roles" : {
|
|
6212
|
+
"put" : {
|
|
6213
|
+
"operationId" : "setOrganizationUserAccessRoles",
|
|
5088
6214
|
"parameters" : [ {
|
|
5089
6215
|
"description" : "ID of the organization",
|
|
5090
6216
|
"in" : "path",
|
|
@@ -5093,40 +6219,45 @@
|
|
|
5093
6219
|
"schema" : {
|
|
5094
6220
|
"type" : "string"
|
|
5095
6221
|
}
|
|
6222
|
+
}, {
|
|
6223
|
+
"in" : "path",
|
|
6224
|
+
"name" : "userId",
|
|
6225
|
+
"required" : true,
|
|
6226
|
+
"schema" : {
|
|
6227
|
+
"type" : "string"
|
|
6228
|
+
}
|
|
5096
6229
|
} ],
|
|
5097
|
-
"
|
|
5098
|
-
"
|
|
5099
|
-
"
|
|
5100
|
-
"
|
|
5101
|
-
"
|
|
5102
|
-
"items" : {
|
|
5103
|
-
"$ref" : "#/components/schemas/Role"
|
|
5104
|
-
},
|
|
5105
|
-
"type" : "array"
|
|
5106
|
-
}
|
|
6230
|
+
"requestBody" : {
|
|
6231
|
+
"content" : {
|
|
6232
|
+
"application/json" : {
|
|
6233
|
+
"schema" : {
|
|
6234
|
+
"$ref" : "#/components/schemas/UserAccessRolesRequest"
|
|
5107
6235
|
}
|
|
5108
|
-
}
|
|
5109
|
-
|
|
6236
|
+
}
|
|
6237
|
+
},
|
|
6238
|
+
"required" : true
|
|
6239
|
+
},
|
|
6240
|
+
"responses" : {
|
|
6241
|
+
"204" : {
|
|
6242
|
+
"description" : "User access roles updated"
|
|
6243
|
+
},
|
|
6244
|
+
"400" : {
|
|
6245
|
+
"description" : "Invalid request body"
|
|
5110
6246
|
},
|
|
5111
6247
|
"401" : {
|
|
5112
6248
|
"description" : "Unauthorized"
|
|
5113
6249
|
},
|
|
5114
|
-
"403" : {
|
|
5115
|
-
"description" : "Forbidden - User doesn't have permission"
|
|
5116
|
-
},
|
|
5117
6250
|
"404" : {
|
|
5118
|
-
"description" : "Organization not found"
|
|
5119
|
-
},
|
|
5120
|
-
"500" : {
|
|
5121
|
-
"description" : "Server error"
|
|
6251
|
+
"description" : "Organization or user not found"
|
|
5122
6252
|
}
|
|
5123
6253
|
},
|
|
5124
|
-
"summary" : "
|
|
6254
|
+
"summary" : "Set user access roles",
|
|
5125
6255
|
"tags" : [ "organizations" ]
|
|
5126
|
-
}
|
|
5127
|
-
|
|
5128
|
-
|
|
5129
|
-
|
|
6256
|
+
}
|
|
6257
|
+
},
|
|
6258
|
+
"/organizations/{organizationId}/users/{userId}/permissions" : {
|
|
6259
|
+
"put" : {
|
|
6260
|
+
"operationId" : "setOrganizationUserDirectPermissions",
|
|
5130
6261
|
"parameters" : [ {
|
|
5131
6262
|
"description" : "ID of the organization",
|
|
5132
6263
|
"in" : "path",
|
|
@@ -5135,27 +6266,27 @@
|
|
|
5135
6266
|
"schema" : {
|
|
5136
6267
|
"type" : "string"
|
|
5137
6268
|
}
|
|
6269
|
+
}, {
|
|
6270
|
+
"in" : "path",
|
|
6271
|
+
"name" : "userId",
|
|
6272
|
+
"required" : true,
|
|
6273
|
+
"schema" : {
|
|
6274
|
+
"type" : "string"
|
|
6275
|
+
}
|
|
5138
6276
|
} ],
|
|
5139
6277
|
"requestBody" : {
|
|
5140
6278
|
"content" : {
|
|
5141
6279
|
"application/json" : {
|
|
5142
6280
|
"schema" : {
|
|
5143
|
-
"$ref" : "#/components/schemas/
|
|
6281
|
+
"$ref" : "#/components/schemas/UserDirectPermissionsRequest"
|
|
5144
6282
|
}
|
|
5145
6283
|
}
|
|
5146
6284
|
},
|
|
5147
6285
|
"required" : true
|
|
5148
6286
|
},
|
|
5149
6287
|
"responses" : {
|
|
5150
|
-
"
|
|
5151
|
-
"
|
|
5152
|
-
"application/json" : {
|
|
5153
|
-
"schema" : {
|
|
5154
|
-
"$ref" : "#/components/schemas/Role"
|
|
5155
|
-
}
|
|
5156
|
-
}
|
|
5157
|
-
},
|
|
5158
|
-
"description" : "Role created successfully"
|
|
6288
|
+
"204" : {
|
|
6289
|
+
"description" : "User direct permissions updated"
|
|
5159
6290
|
},
|
|
5160
6291
|
"400" : {
|
|
5161
6292
|
"description" : "Invalid request body"
|
|
@@ -5163,24 +6294,17 @@
|
|
|
5163
6294
|
"401" : {
|
|
5164
6295
|
"description" : "Unauthorized"
|
|
5165
6296
|
},
|
|
5166
|
-
"403" : {
|
|
5167
|
-
"description" : "Forbidden - User doesn't have permission"
|
|
5168
|
-
},
|
|
5169
6297
|
"404" : {
|
|
5170
|
-
"description" : "Organization not found"
|
|
5171
|
-
},
|
|
5172
|
-
"500" : {
|
|
5173
|
-
"description" : "Server error"
|
|
6298
|
+
"description" : "Organization or user not found"
|
|
5174
6299
|
}
|
|
5175
6300
|
},
|
|
5176
|
-
"summary" : "
|
|
6301
|
+
"summary" : "Set user direct permissions",
|
|
5177
6302
|
"tags" : [ "organizations" ]
|
|
5178
6303
|
}
|
|
5179
6304
|
},
|
|
5180
|
-
"/organizations/{organizationId}/
|
|
5181
|
-
"
|
|
5182
|
-
"
|
|
5183
|
-
"operationId" : "deleteOrganizationRole",
|
|
6305
|
+
"/organizations/{organizationId}/users/{userId}/agents-access" : {
|
|
6306
|
+
"get" : {
|
|
6307
|
+
"operationId" : "getOrganizationUserAgentsAccess",
|
|
5184
6308
|
"parameters" : [ {
|
|
5185
6309
|
"description" : "ID of the organization",
|
|
5186
6310
|
"in" : "path",
|
|
@@ -5190,37 +6314,36 @@
|
|
|
5190
6314
|
"type" : "string"
|
|
5191
6315
|
}
|
|
5192
6316
|
}, {
|
|
5193
|
-
"description" : "ID of the role to delete",
|
|
5194
6317
|
"in" : "path",
|
|
5195
|
-
"name" : "
|
|
6318
|
+
"name" : "userId",
|
|
5196
6319
|
"required" : true,
|
|
5197
6320
|
"schema" : {
|
|
5198
6321
|
"type" : "string"
|
|
5199
6322
|
}
|
|
5200
6323
|
} ],
|
|
5201
6324
|
"responses" : {
|
|
5202
|
-
"
|
|
5203
|
-
"
|
|
6325
|
+
"200" : {
|
|
6326
|
+
"content" : {
|
|
6327
|
+
"application/json" : {
|
|
6328
|
+
"schema" : {
|
|
6329
|
+
"$ref" : "#/components/schemas/UserAgentAccess"
|
|
6330
|
+
}
|
|
6331
|
+
}
|
|
6332
|
+
},
|
|
6333
|
+
"description" : "User agent access configuration"
|
|
5204
6334
|
},
|
|
5205
6335
|
"401" : {
|
|
5206
6336
|
"description" : "Unauthorized"
|
|
5207
6337
|
},
|
|
5208
|
-
"403" : {
|
|
5209
|
-
"description" : "Forbidden - User doesn't have permission"
|
|
5210
|
-
},
|
|
5211
6338
|
"404" : {
|
|
5212
|
-
"description" : "Organization not found"
|
|
5213
|
-
},
|
|
5214
|
-
"500" : {
|
|
5215
|
-
"description" : "Server error"
|
|
6339
|
+
"description" : "Organization or user not found"
|
|
5216
6340
|
}
|
|
5217
6341
|
},
|
|
5218
|
-
"summary" : "
|
|
6342
|
+
"summary" : "Get user agent access configuration",
|
|
5219
6343
|
"tags" : [ "organizations" ]
|
|
5220
6344
|
},
|
|
5221
6345
|
"put" : {
|
|
5222
|
-
"
|
|
5223
|
-
"operationId" : "updateOrganizationRole",
|
|
6346
|
+
"operationId" : "setOrganizationUserAgentsAccess",
|
|
5224
6347
|
"parameters" : [ {
|
|
5225
6348
|
"description" : "ID of the organization",
|
|
5226
6349
|
"in" : "path",
|
|
@@ -5230,9 +6353,8 @@
|
|
|
5230
6353
|
"type" : "string"
|
|
5231
6354
|
}
|
|
5232
6355
|
}, {
|
|
5233
|
-
"description" : "ID of the role to update",
|
|
5234
6356
|
"in" : "path",
|
|
5235
|
-
"name" : "
|
|
6357
|
+
"name" : "userId",
|
|
5236
6358
|
"required" : true,
|
|
5237
6359
|
"schema" : {
|
|
5238
6360
|
"type" : "string"
|
|
@@ -5242,7 +6364,7 @@
|
|
|
5242
6364
|
"content" : {
|
|
5243
6365
|
"application/json" : {
|
|
5244
6366
|
"schema" : {
|
|
5245
|
-
"$ref" : "#/components/schemas/
|
|
6367
|
+
"$ref" : "#/components/schemas/UserAgentAccessRequest"
|
|
5246
6368
|
}
|
|
5247
6369
|
}
|
|
5248
6370
|
},
|
|
@@ -5250,7 +6372,7 @@
|
|
|
5250
6372
|
},
|
|
5251
6373
|
"responses" : {
|
|
5252
6374
|
"204" : {
|
|
5253
|
-
"description" : "
|
|
6375
|
+
"description" : "User agent access updated"
|
|
5254
6376
|
},
|
|
5255
6377
|
"400" : {
|
|
5256
6378
|
"description" : "Invalid request body"
|
|
@@ -5258,17 +6380,11 @@
|
|
|
5258
6380
|
"401" : {
|
|
5259
6381
|
"description" : "Unauthorized"
|
|
5260
6382
|
},
|
|
5261
|
-
"403" : {
|
|
5262
|
-
"description" : "Forbidden - User doesn't have permission"
|
|
5263
|
-
},
|
|
5264
6383
|
"404" : {
|
|
5265
|
-
"description" : "Organization not found"
|
|
5266
|
-
},
|
|
5267
|
-
"500" : {
|
|
5268
|
-
"description" : "Server error"
|
|
6384
|
+
"description" : "Organization or user not found"
|
|
5269
6385
|
}
|
|
5270
6386
|
},
|
|
5271
|
-
"summary" : "
|
|
6387
|
+
"summary" : "Set user agent access configuration",
|
|
5272
6388
|
"tags" : [ "organizations" ]
|
|
5273
6389
|
}
|
|
5274
6390
|
},
|
|
@@ -8566,11 +9682,10 @@
|
|
|
8566
9682
|
}
|
|
8567
9683
|
},
|
|
8568
9684
|
"sortOrder" : {
|
|
8569
|
-
"description" : "Sort
|
|
9685
|
+
"description" : "Sort order for results",
|
|
8570
9686
|
"in" : "query",
|
|
8571
9687
|
"name" : "sortOrder",
|
|
8572
9688
|
"schema" : {
|
|
8573
|
-
"default" : "desc",
|
|
8574
9689
|
"enum" : [ "asc", "desc" ],
|
|
8575
9690
|
"type" : "string"
|
|
8576
9691
|
}
|
|
@@ -8611,6 +9726,24 @@
|
|
|
8611
9726
|
"type" : "string"
|
|
8612
9727
|
}
|
|
8613
9728
|
},
|
|
9729
|
+
"taskIdPath" : {
|
|
9730
|
+
"description" : "ID of the scheduled task",
|
|
9731
|
+
"in" : "path",
|
|
9732
|
+
"name" : "taskId",
|
|
9733
|
+
"required" : true,
|
|
9734
|
+
"schema" : {
|
|
9735
|
+
"type" : "string"
|
|
9736
|
+
}
|
|
9737
|
+
},
|
|
9738
|
+
"runIdPath" : {
|
|
9739
|
+
"description" : "ID of the scheduled task run",
|
|
9740
|
+
"in" : "path",
|
|
9741
|
+
"name" : "runId",
|
|
9742
|
+
"required" : true,
|
|
9743
|
+
"schema" : {
|
|
9744
|
+
"type" : "string"
|
|
9745
|
+
}
|
|
9746
|
+
},
|
|
8614
9747
|
"appIdPath" : {
|
|
8615
9748
|
"description" : "ID of the app",
|
|
8616
9749
|
"in" : "path",
|
|
@@ -10087,6 +11220,11 @@
|
|
|
10087
11220
|
"id" : {
|
|
10088
11221
|
"type" : "string"
|
|
10089
11222
|
},
|
|
11223
|
+
"type" : {
|
|
11224
|
+
"enum" : [ "chat", "task" ],
|
|
11225
|
+
"nullable" : true,
|
|
11226
|
+
"type" : "string"
|
|
11227
|
+
},
|
|
10090
11228
|
"title" : {
|
|
10091
11229
|
"nullable" : true,
|
|
10092
11230
|
"type" : "string"
|
|
@@ -10364,6 +11502,11 @@
|
|
|
10364
11502
|
"customUserId" : {
|
|
10365
11503
|
"description" : "Optional custom user identifier",
|
|
10366
11504
|
"type" : "string"
|
|
11505
|
+
},
|
|
11506
|
+
"type" : {
|
|
11507
|
+
"description" : "Type of conversation (defaults to 'chat')",
|
|
11508
|
+
"enum" : [ "chat", "task" ],
|
|
11509
|
+
"type" : "string"
|
|
10367
11510
|
}
|
|
10368
11511
|
},
|
|
10369
11512
|
"required" : [ "lang" ],
|
|
@@ -10381,12 +11524,313 @@
|
|
|
10381
11524
|
},
|
|
10382
11525
|
"ConversationAttachmentDownloadUrl" : {
|
|
10383
11526
|
"properties" : {
|
|
10384
|
-
"url" : {
|
|
10385
|
-
"description" : "Presigned download URL or inline data URL for the image attachment",
|
|
11527
|
+
"url" : {
|
|
11528
|
+
"description" : "Presigned download URL or inline data URL for the image attachment",
|
|
11529
|
+
"type" : "string"
|
|
11530
|
+
}
|
|
11531
|
+
},
|
|
11532
|
+
"required" : [ "url" ],
|
|
11533
|
+
"type" : "object"
|
|
11534
|
+
},
|
|
11535
|
+
"ScheduledTaskList" : {
|
|
11536
|
+
"properties" : {
|
|
11537
|
+
"tasks" : {
|
|
11538
|
+
"items" : {
|
|
11539
|
+
"$ref" : "#/components/schemas/ScheduledTask"
|
|
11540
|
+
},
|
|
11541
|
+
"type" : "array"
|
|
11542
|
+
},
|
|
11543
|
+
"total" : {
|
|
11544
|
+
"type" : "integer"
|
|
11545
|
+
}
|
|
11546
|
+
},
|
|
11547
|
+
"required" : [ "tasks", "total" ],
|
|
11548
|
+
"type" : "object"
|
|
11549
|
+
},
|
|
11550
|
+
"ScheduledTask" : {
|
|
11551
|
+
"properties" : {
|
|
11552
|
+
"id" : {
|
|
11553
|
+
"type" : "string"
|
|
11554
|
+
},
|
|
11555
|
+
"agentId" : {
|
|
11556
|
+
"type" : "string"
|
|
11557
|
+
},
|
|
11558
|
+
"organizationId" : {
|
|
11559
|
+
"type" : "string"
|
|
11560
|
+
},
|
|
11561
|
+
"name" : {
|
|
11562
|
+
"type" : "string"
|
|
11563
|
+
},
|
|
11564
|
+
"message" : {
|
|
11565
|
+
"type" : "string"
|
|
11566
|
+
},
|
|
11567
|
+
"mode" : {
|
|
11568
|
+
"enum" : [ "once", "recurring" ],
|
|
11569
|
+
"type" : "string"
|
|
11570
|
+
},
|
|
11571
|
+
"status" : {
|
|
11572
|
+
"enum" : [ "active", "paused", "done" ],
|
|
11573
|
+
"type" : "string"
|
|
11574
|
+
},
|
|
11575
|
+
"schedule" : {
|
|
11576
|
+
"$ref" : "#/components/schemas/TaskSchedule"
|
|
11577
|
+
},
|
|
11578
|
+
"cronExpression" : {
|
|
11579
|
+
"type" : "string"
|
|
11580
|
+
},
|
|
11581
|
+
"timezone" : {
|
|
11582
|
+
"type" : "string"
|
|
11583
|
+
},
|
|
11584
|
+
"lang" : {
|
|
11585
|
+
"type" : "string"
|
|
11586
|
+
},
|
|
11587
|
+
"callbackUrl" : {
|
|
11588
|
+
"type" : "string"
|
|
11589
|
+
},
|
|
11590
|
+
"runCount" : {
|
|
11591
|
+
"type" : "integer"
|
|
11592
|
+
},
|
|
11593
|
+
"nextRunAt" : {
|
|
11594
|
+
"format" : "date-time",
|
|
11595
|
+
"type" : "string"
|
|
11596
|
+
},
|
|
11597
|
+
"endedAt" : {
|
|
11598
|
+
"format" : "date-time",
|
|
11599
|
+
"type" : "string"
|
|
11600
|
+
},
|
|
11601
|
+
"createdAt" : {
|
|
11602
|
+
"format" : "date-time",
|
|
11603
|
+
"type" : "string"
|
|
11604
|
+
},
|
|
11605
|
+
"updatedAt" : {
|
|
11606
|
+
"format" : "date-time",
|
|
11607
|
+
"type" : "string"
|
|
11608
|
+
}
|
|
11609
|
+
},
|
|
11610
|
+
"required" : [ "agentId", "createdAt", "cronExpression", "id", "lang", "message", "mode", "organizationId", "runCount", "schedule", "status", "timezone", "updatedAt" ],
|
|
11611
|
+
"type" : "object"
|
|
11612
|
+
},
|
|
11613
|
+
"TaskSchedule" : {
|
|
11614
|
+
"properties" : {
|
|
11615
|
+
"at" : {
|
|
11616
|
+
"type" : "string"
|
|
11617
|
+
},
|
|
11618
|
+
"freq" : {
|
|
11619
|
+
"enum" : [ "minute", "interval", "daily", "weekly", "monthly", "cron" ],
|
|
11620
|
+
"type" : "string"
|
|
11621
|
+
},
|
|
11622
|
+
"time" : {
|
|
11623
|
+
"pattern" : "^([01]\\d|2[0-3]):[0-5]\\d$",
|
|
11624
|
+
"type" : "string"
|
|
11625
|
+
},
|
|
11626
|
+
"days" : {
|
|
11627
|
+
"items" : {
|
|
11628
|
+
"maximum" : 6,
|
|
11629
|
+
"minimum" : 0,
|
|
11630
|
+
"type" : "integer"
|
|
11631
|
+
},
|
|
11632
|
+
"type" : "array"
|
|
11633
|
+
},
|
|
11634
|
+
"dom" : {
|
|
11635
|
+
"maximum" : 31,
|
|
11636
|
+
"minimum" : 1,
|
|
11637
|
+
"type" : "integer"
|
|
11638
|
+
},
|
|
11639
|
+
"interval" : {
|
|
11640
|
+
"$ref" : "#/components/schemas/TaskScheduleInterval"
|
|
11641
|
+
},
|
|
11642
|
+
"cron" : {
|
|
11643
|
+
"type" : "string"
|
|
11644
|
+
},
|
|
11645
|
+
"start" : {
|
|
11646
|
+
"type" : "string"
|
|
11647
|
+
},
|
|
11648
|
+
"end" : {
|
|
11649
|
+
"$ref" : "#/components/schemas/TaskScheduleEnd"
|
|
11650
|
+
}
|
|
11651
|
+
},
|
|
11652
|
+
"type" : "object"
|
|
11653
|
+
},
|
|
11654
|
+
"TaskScheduleInterval" : {
|
|
11655
|
+
"properties" : {
|
|
11656
|
+
"n" : {
|
|
11657
|
+
"minimum" : 1,
|
|
11658
|
+
"type" : "integer"
|
|
11659
|
+
},
|
|
11660
|
+
"unit" : {
|
|
11661
|
+
"enum" : [ "minutes", "hours", "days" ],
|
|
11662
|
+
"type" : "string"
|
|
11663
|
+
}
|
|
11664
|
+
},
|
|
11665
|
+
"required" : [ "n", "unit" ],
|
|
11666
|
+
"type" : "object"
|
|
11667
|
+
},
|
|
11668
|
+
"TaskScheduleEnd" : {
|
|
11669
|
+
"oneOf" : [ {
|
|
11670
|
+
"$ref" : "#/components/schemas/TaskScheduleEnd_oneOf"
|
|
11671
|
+
}, {
|
|
11672
|
+
"$ref" : "#/components/schemas/TaskScheduleEnd_oneOf_1"
|
|
11673
|
+
}, {
|
|
11674
|
+
"$ref" : "#/components/schemas/TaskScheduleEnd_oneOf_2"
|
|
11675
|
+
} ],
|
|
11676
|
+
"type" : "object"
|
|
11677
|
+
},
|
|
11678
|
+
"ScheduledTaskCreate" : {
|
|
11679
|
+
"properties" : {
|
|
11680
|
+
"message" : {
|
|
11681
|
+
"minLength" : 1,
|
|
11682
|
+
"type" : "string"
|
|
11683
|
+
},
|
|
11684
|
+
"mode" : {
|
|
11685
|
+
"enum" : [ "once", "recurring" ],
|
|
11686
|
+
"type" : "string"
|
|
11687
|
+
},
|
|
11688
|
+
"schedule" : {
|
|
11689
|
+
"$ref" : "#/components/schemas/TaskSchedule"
|
|
11690
|
+
},
|
|
11691
|
+
"name" : {
|
|
11692
|
+
"type" : "string"
|
|
11693
|
+
},
|
|
11694
|
+
"timezone" : {
|
|
11695
|
+
"type" : "string"
|
|
11696
|
+
},
|
|
11697
|
+
"callbackUrl" : {
|
|
11698
|
+
"format" : "uri",
|
|
11699
|
+
"type" : "string"
|
|
11700
|
+
},
|
|
11701
|
+
"lang" : {
|
|
11702
|
+
"minLength" : 2,
|
|
11703
|
+
"type" : "string"
|
|
11704
|
+
}
|
|
11705
|
+
},
|
|
11706
|
+
"required" : [ "message", "mode", "schedule" ],
|
|
11707
|
+
"type" : "object"
|
|
11708
|
+
},
|
|
11709
|
+
"ScheduledTaskStatusToggle" : {
|
|
11710
|
+
"properties" : {
|
|
11711
|
+
"status" : {
|
|
11712
|
+
"enum" : [ "active", "paused" ],
|
|
11713
|
+
"type" : "string"
|
|
11714
|
+
}
|
|
11715
|
+
},
|
|
11716
|
+
"required" : [ "status" ],
|
|
11717
|
+
"type" : "object"
|
|
11718
|
+
},
|
|
11719
|
+
"ScheduledTaskStatusResponse" : {
|
|
11720
|
+
"properties" : {
|
|
11721
|
+
"status" : {
|
|
11722
|
+
"enum" : [ "active", "paused" ],
|
|
11723
|
+
"type" : "string"
|
|
11724
|
+
},
|
|
11725
|
+
"nextRunAt" : {
|
|
11726
|
+
"format" : "date-time",
|
|
11727
|
+
"nullable" : true,
|
|
11728
|
+
"type" : "string"
|
|
11729
|
+
}
|
|
11730
|
+
},
|
|
11731
|
+
"required" : [ "status" ],
|
|
11732
|
+
"type" : "object"
|
|
11733
|
+
},
|
|
11734
|
+
"ScheduledTaskManualRunResponse" : {
|
|
11735
|
+
"properties" : {
|
|
11736
|
+
"runId" : {
|
|
11737
|
+
"type" : "string"
|
|
11738
|
+
}
|
|
11739
|
+
},
|
|
11740
|
+
"required" : [ "runId" ],
|
|
11741
|
+
"type" : "object"
|
|
11742
|
+
},
|
|
11743
|
+
"ScheduledTaskRunList" : {
|
|
11744
|
+
"properties" : {
|
|
11745
|
+
"runs" : {
|
|
11746
|
+
"items" : {
|
|
11747
|
+
"$ref" : "#/components/schemas/ScheduledTaskRun"
|
|
11748
|
+
},
|
|
11749
|
+
"type" : "array"
|
|
11750
|
+
},
|
|
11751
|
+
"nextRun" : {
|
|
11752
|
+
"format" : "date-time",
|
|
11753
|
+
"nullable" : true,
|
|
11754
|
+
"type" : "string"
|
|
11755
|
+
}
|
|
11756
|
+
},
|
|
11757
|
+
"required" : [ "nextRun", "runs" ],
|
|
11758
|
+
"type" : "object"
|
|
11759
|
+
},
|
|
11760
|
+
"ScheduledTaskRun" : {
|
|
11761
|
+
"properties" : {
|
|
11762
|
+
"id" : {
|
|
11763
|
+
"type" : "string"
|
|
11764
|
+
},
|
|
11765
|
+
"taskId" : {
|
|
11766
|
+
"type" : "string"
|
|
11767
|
+
},
|
|
11768
|
+
"status" : {
|
|
11769
|
+
"enum" : [ "pending", "running", "success", "error", "failed_permanently" ],
|
|
11770
|
+
"type" : "string"
|
|
11771
|
+
},
|
|
11772
|
+
"prompt" : {
|
|
11773
|
+
"type" : "string"
|
|
11774
|
+
},
|
|
11775
|
+
"conversationId" : {
|
|
11776
|
+
"type" : "string"
|
|
11777
|
+
},
|
|
11778
|
+
"triggeredAt" : {
|
|
11779
|
+
"format" : "date-time",
|
|
11780
|
+
"type" : "string"
|
|
11781
|
+
},
|
|
11782
|
+
"startedAt" : {
|
|
11783
|
+
"format" : "date-time",
|
|
11784
|
+
"type" : "string"
|
|
11785
|
+
},
|
|
11786
|
+
"finishedAt" : {
|
|
11787
|
+
"format" : "date-time",
|
|
11788
|
+
"type" : "string"
|
|
11789
|
+
},
|
|
11790
|
+
"claimedAt" : {
|
|
11791
|
+
"format" : "date-time",
|
|
11792
|
+
"type" : "string"
|
|
11793
|
+
},
|
|
11794
|
+
"retryCount" : {
|
|
11795
|
+
"type" : "integer"
|
|
11796
|
+
},
|
|
11797
|
+
"steps" : {
|
|
11798
|
+
"items" : {
|
|
11799
|
+
"$ref" : "#/components/schemas/RunStep"
|
|
11800
|
+
},
|
|
11801
|
+
"type" : "array"
|
|
11802
|
+
},
|
|
11803
|
+
"createdAt" : {
|
|
11804
|
+
"format" : "date-time",
|
|
11805
|
+
"type" : "string"
|
|
11806
|
+
}
|
|
11807
|
+
},
|
|
11808
|
+
"required" : [ "createdAt", "id", "prompt", "retryCount", "status", "steps", "taskId", "triggeredAt" ],
|
|
11809
|
+
"type" : "object"
|
|
11810
|
+
},
|
|
11811
|
+
"RunStep" : {
|
|
11812
|
+
"properties" : {
|
|
11813
|
+
"type" : {
|
|
11814
|
+
"enum" : [ "llm_call", "tool_call", "tool_result", "llm_response" ],
|
|
11815
|
+
"type" : "string"
|
|
11816
|
+
},
|
|
11817
|
+
"at" : {
|
|
11818
|
+
"format" : "date-time",
|
|
11819
|
+
"type" : "string"
|
|
11820
|
+
},
|
|
11821
|
+
"tool" : {
|
|
11822
|
+
"type" : "string"
|
|
11823
|
+
},
|
|
11824
|
+
"input" : { },
|
|
11825
|
+
"output" : { },
|
|
11826
|
+
"tokens" : {
|
|
11827
|
+
"type" : "integer"
|
|
11828
|
+
},
|
|
11829
|
+
"error" : {
|
|
10386
11830
|
"type" : "string"
|
|
10387
11831
|
}
|
|
10388
11832
|
},
|
|
10389
|
-
"required" : [ "
|
|
11833
|
+
"required" : [ "at", "type" ],
|
|
10390
11834
|
"type" : "object"
|
|
10391
11835
|
},
|
|
10392
11836
|
"AppLight" : {
|
|
@@ -11362,16 +12806,6 @@
|
|
|
11362
12806
|
"required" : [ "currency", "price" ],
|
|
11363
12807
|
"type" : "object"
|
|
11364
12808
|
},
|
|
11365
|
-
"UploadLimitsResponse" : {
|
|
11366
|
-
"properties" : {
|
|
11367
|
-
"conversationAttachmentMaxBytes" : {
|
|
11368
|
-
"format" : "int64",
|
|
11369
|
-
"type" : "integer"
|
|
11370
|
-
}
|
|
11371
|
-
},
|
|
11372
|
-
"required" : [ "conversationAttachmentMaxBytes" ],
|
|
11373
|
-
"type" : "object"
|
|
11374
|
-
},
|
|
11375
12809
|
"AudioFile" : {
|
|
11376
12810
|
"properties" : {
|
|
11377
12811
|
"id" : {
|
|
@@ -11704,6 +13138,9 @@
|
|
|
11704
13138
|
},
|
|
11705
13139
|
"ProviderValiationRequest" : {
|
|
11706
13140
|
"properties" : {
|
|
13141
|
+
"organizationId" : {
|
|
13142
|
+
"type" : "string"
|
|
13143
|
+
},
|
|
11707
13144
|
"providerType" : {
|
|
11708
13145
|
"type" : "string"
|
|
11709
13146
|
},
|
|
@@ -11711,7 +13148,7 @@
|
|
|
11711
13148
|
"type" : "string"
|
|
11712
13149
|
}
|
|
11713
13150
|
},
|
|
11714
|
-
"required" : [ "apiKey", "providerType" ],
|
|
13151
|
+
"required" : [ "apiKey", "organizationId", "providerType" ],
|
|
11715
13152
|
"type" : "object"
|
|
11716
13153
|
},
|
|
11717
13154
|
"Model" : {
|
|
@@ -12047,6 +13484,234 @@
|
|
|
12047
13484
|
"required" : [ "color", "name" ],
|
|
12048
13485
|
"type" : "object"
|
|
12049
13486
|
},
|
|
13487
|
+
"AccessRole" : {
|
|
13488
|
+
"properties" : {
|
|
13489
|
+
"id" : {
|
|
13490
|
+
"type" : "string"
|
|
13491
|
+
},
|
|
13492
|
+
"organizationId" : {
|
|
13493
|
+
"type" : "string"
|
|
13494
|
+
},
|
|
13495
|
+
"name" : {
|
|
13496
|
+
"type" : "string"
|
|
13497
|
+
},
|
|
13498
|
+
"description" : {
|
|
13499
|
+
"type" : "string"
|
|
13500
|
+
},
|
|
13501
|
+
"slug" : {
|
|
13502
|
+
"nullable" : true,
|
|
13503
|
+
"type" : "string"
|
|
13504
|
+
},
|
|
13505
|
+
"isSystem" : {
|
|
13506
|
+
"type" : "boolean"
|
|
13507
|
+
},
|
|
13508
|
+
"createdAt" : {
|
|
13509
|
+
"type" : "string"
|
|
13510
|
+
},
|
|
13511
|
+
"permissions" : {
|
|
13512
|
+
"items" : {
|
|
13513
|
+
"$ref" : "#/components/schemas/PermissionEntry"
|
|
13514
|
+
},
|
|
13515
|
+
"type" : "array"
|
|
13516
|
+
}
|
|
13517
|
+
},
|
|
13518
|
+
"required" : [ "createdAt", "description", "id", "name", "organizationId", "permissions" ],
|
|
13519
|
+
"type" : "object"
|
|
13520
|
+
},
|
|
13521
|
+
"PermissionEntry" : {
|
|
13522
|
+
"properties" : {
|
|
13523
|
+
"permission" : {
|
|
13524
|
+
"$ref" : "#/components/schemas/OrganizationPermissionKey"
|
|
13525
|
+
},
|
|
13526
|
+
"allowed" : {
|
|
13527
|
+
"type" : "boolean"
|
|
13528
|
+
}
|
|
13529
|
+
},
|
|
13530
|
+
"required" : [ "allowed", "permission" ],
|
|
13531
|
+
"type" : "object"
|
|
13532
|
+
},
|
|
13533
|
+
"OrganizationPermissionKey" : {
|
|
13534
|
+
"enum" : [ "org.read", "agent.read", "agent.update", "agent.delete", "agent.chat", "app.read", "knowledge.read", "knowledge.create", "knowledge.update", "knowledge.delete", "knowledge.file.add", "knowledge.file.delete", "knowledge.file.download", "skill.read", "skill.create", "skill.update", "skill.delete", "skill.file.add", "skill.file.delete", "moderation.read", "moderation.create", "moderation.update", "moderation.delete", "user.read", "user.create", "user.update", "user.delete", "engine.read", "engine.create", "engine.update", "engine.delete", "tool.read", "tool.create", "tool.update", "tool.delete", "flow.read" ],
|
|
13535
|
+
"type" : "string"
|
|
13536
|
+
},
|
|
13537
|
+
"AccessRoleCreateRequest" : {
|
|
13538
|
+
"properties" : {
|
|
13539
|
+
"name" : {
|
|
13540
|
+
"type" : "string"
|
|
13541
|
+
},
|
|
13542
|
+
"description" : {
|
|
13543
|
+
"type" : "string"
|
|
13544
|
+
},
|
|
13545
|
+
"permissions" : {
|
|
13546
|
+
"items" : {
|
|
13547
|
+
"$ref" : "#/components/schemas/PermissionEntry"
|
|
13548
|
+
},
|
|
13549
|
+
"type" : "array"
|
|
13550
|
+
}
|
|
13551
|
+
},
|
|
13552
|
+
"required" : [ "name" ],
|
|
13553
|
+
"type" : "object"
|
|
13554
|
+
},
|
|
13555
|
+
"AccessRoleUpdateRequest" : {
|
|
13556
|
+
"properties" : {
|
|
13557
|
+
"name" : {
|
|
13558
|
+
"type" : "string"
|
|
13559
|
+
},
|
|
13560
|
+
"description" : {
|
|
13561
|
+
"type" : "string"
|
|
13562
|
+
}
|
|
13563
|
+
},
|
|
13564
|
+
"required" : [ "name" ],
|
|
13565
|
+
"type" : "object"
|
|
13566
|
+
},
|
|
13567
|
+
"AccessRolePermissionsRequest" : {
|
|
13568
|
+
"properties" : {
|
|
13569
|
+
"permissions" : {
|
|
13570
|
+
"items" : {
|
|
13571
|
+
"$ref" : "#/components/schemas/PermissionEntry"
|
|
13572
|
+
},
|
|
13573
|
+
"type" : "array"
|
|
13574
|
+
}
|
|
13575
|
+
},
|
|
13576
|
+
"required" : [ "permissions" ],
|
|
13577
|
+
"type" : "object"
|
|
13578
|
+
},
|
|
13579
|
+
"MemberPermissions" : {
|
|
13580
|
+
"additionalProperties" : {
|
|
13581
|
+
"type" : "boolean"
|
|
13582
|
+
},
|
|
13583
|
+
"type" : "object"
|
|
13584
|
+
},
|
|
13585
|
+
"OrganizationMember" : {
|
|
13586
|
+
"properties" : {
|
|
13587
|
+
"id" : {
|
|
13588
|
+
"type" : "string"
|
|
13589
|
+
},
|
|
13590
|
+
"role" : {
|
|
13591
|
+
"type" : "string"
|
|
13592
|
+
},
|
|
13593
|
+
"createdAt" : {
|
|
13594
|
+
"type" : "string"
|
|
13595
|
+
},
|
|
13596
|
+
"user" : {
|
|
13597
|
+
"$ref" : "#/components/schemas/OrganizationMember_user"
|
|
13598
|
+
}
|
|
13599
|
+
},
|
|
13600
|
+
"required" : [ "createdAt", "id", "role", "user" ],
|
|
13601
|
+
"type" : "object"
|
|
13602
|
+
},
|
|
13603
|
+
"OrganizationUserInviteRequest" : {
|
|
13604
|
+
"properties" : {
|
|
13605
|
+
"email" : {
|
|
13606
|
+
"type" : "string"
|
|
13607
|
+
},
|
|
13608
|
+
"role" : {
|
|
13609
|
+
"type" : "string"
|
|
13610
|
+
}
|
|
13611
|
+
},
|
|
13612
|
+
"required" : [ "email" ],
|
|
13613
|
+
"type" : "object"
|
|
13614
|
+
},
|
|
13615
|
+
"OrganizationUserInviteResponse" : {
|
|
13616
|
+
"properties" : {
|
|
13617
|
+
"userId" : {
|
|
13618
|
+
"type" : "string"
|
|
13619
|
+
}
|
|
13620
|
+
},
|
|
13621
|
+
"required" : [ "userId" ],
|
|
13622
|
+
"type" : "object"
|
|
13623
|
+
},
|
|
13624
|
+
"UserAccess" : {
|
|
13625
|
+
"properties" : {
|
|
13626
|
+
"roleIds" : {
|
|
13627
|
+
"items" : {
|
|
13628
|
+
"type" : "string"
|
|
13629
|
+
},
|
|
13630
|
+
"type" : "array"
|
|
13631
|
+
},
|
|
13632
|
+
"directPermissions" : {
|
|
13633
|
+
"items" : {
|
|
13634
|
+
"$ref" : "#/components/schemas/PermissionEntry"
|
|
13635
|
+
},
|
|
13636
|
+
"type" : "array"
|
|
13637
|
+
}
|
|
13638
|
+
},
|
|
13639
|
+
"required" : [ "directPermissions", "roleIds" ],
|
|
13640
|
+
"type" : "object"
|
|
13641
|
+
},
|
|
13642
|
+
"UserAccessRolesRequest" : {
|
|
13643
|
+
"properties" : {
|
|
13644
|
+
"roleIds" : {
|
|
13645
|
+
"items" : {
|
|
13646
|
+
"type" : "string"
|
|
13647
|
+
},
|
|
13648
|
+
"type" : "array"
|
|
13649
|
+
}
|
|
13650
|
+
},
|
|
13651
|
+
"required" : [ "roleIds" ],
|
|
13652
|
+
"type" : "object"
|
|
13653
|
+
},
|
|
13654
|
+
"UserDirectPermissionsRequest" : {
|
|
13655
|
+
"properties" : {
|
|
13656
|
+
"permissions" : {
|
|
13657
|
+
"items" : {
|
|
13658
|
+
"$ref" : "#/components/schemas/PermissionEntry"
|
|
13659
|
+
},
|
|
13660
|
+
"type" : "array"
|
|
13661
|
+
}
|
|
13662
|
+
},
|
|
13663
|
+
"required" : [ "permissions" ],
|
|
13664
|
+
"type" : "object"
|
|
13665
|
+
},
|
|
13666
|
+
"UserAgentAccess" : {
|
|
13667
|
+
"properties" : {
|
|
13668
|
+
"scoped" : {
|
|
13669
|
+
"description" : "When true, only listed agents are accessible (org-wide agent.read is ignored for listing).",
|
|
13670
|
+
"type" : "boolean"
|
|
13671
|
+
},
|
|
13672
|
+
"agentIds" : {
|
|
13673
|
+
"items" : {
|
|
13674
|
+
"type" : "string"
|
|
13675
|
+
},
|
|
13676
|
+
"type" : "array"
|
|
13677
|
+
},
|
|
13678
|
+
"availableAgents" : {
|
|
13679
|
+
"items" : {
|
|
13680
|
+
"$ref" : "#/components/schemas/UserAgentAccessAgent"
|
|
13681
|
+
},
|
|
13682
|
+
"type" : "array"
|
|
13683
|
+
}
|
|
13684
|
+
},
|
|
13685
|
+
"required" : [ "agentIds", "availableAgents", "scoped" ],
|
|
13686
|
+
"type" : "object"
|
|
13687
|
+
},
|
|
13688
|
+
"UserAgentAccessAgent" : {
|
|
13689
|
+
"properties" : {
|
|
13690
|
+
"id" : {
|
|
13691
|
+
"type" : "string"
|
|
13692
|
+
},
|
|
13693
|
+
"name" : {
|
|
13694
|
+
"type" : "string"
|
|
13695
|
+
}
|
|
13696
|
+
},
|
|
13697
|
+
"required" : [ "id", "name" ],
|
|
13698
|
+
"type" : "object"
|
|
13699
|
+
},
|
|
13700
|
+
"UserAgentAccessRequest" : {
|
|
13701
|
+
"properties" : {
|
|
13702
|
+
"scoped" : {
|
|
13703
|
+
"type" : "boolean"
|
|
13704
|
+
},
|
|
13705
|
+
"agentIds" : {
|
|
13706
|
+
"items" : {
|
|
13707
|
+
"type" : "string"
|
|
13708
|
+
},
|
|
13709
|
+
"type" : "array"
|
|
13710
|
+
}
|
|
13711
|
+
},
|
|
13712
|
+
"required" : [ "agentIds", "scoped" ],
|
|
13713
|
+
"type" : "object"
|
|
13714
|
+
},
|
|
12050
13715
|
"OrganizationEngine" : {
|
|
12051
13716
|
"additionalProperties" : false,
|
|
12052
13717
|
"description" : "Engine configuration attached to an organization.",
|
|
@@ -12924,7 +14589,7 @@
|
|
|
12924
14589
|
"type" : "boolean"
|
|
12925
14590
|
},
|
|
12926
14591
|
"user" : {
|
|
12927
|
-
"$ref" : "#/components/schemas/
|
|
14592
|
+
"$ref" : "#/components/schemas/OrganizationMember_user"
|
|
12928
14593
|
},
|
|
12929
14594
|
"createdAt" : {
|
|
12930
14595
|
"type" : "string"
|
|
@@ -13087,6 +14752,16 @@
|
|
|
13087
14752
|
"required" : [ "message" ],
|
|
13088
14753
|
"type" : "object"
|
|
13089
14754
|
},
|
|
14755
|
+
"getUploadLimits_200_response" : {
|
|
14756
|
+
"properties" : {
|
|
14757
|
+
"conversationAttachmentMaxBytes" : {
|
|
14758
|
+
"description" : "Maximum size in bytes for conversation attachments",
|
|
14759
|
+
"type" : "number"
|
|
14760
|
+
}
|
|
14761
|
+
},
|
|
14762
|
+
"required" : [ "conversationAttachmentMaxBytes" ],
|
|
14763
|
+
"type" : "object"
|
|
14764
|
+
},
|
|
13090
14765
|
"updateConversationTitle_request" : {
|
|
13091
14766
|
"properties" : {
|
|
13092
14767
|
"title" : {
|
|
@@ -13501,6 +15176,43 @@
|
|
|
13501
15176
|
"required" : [ "latitude", "longitude" ],
|
|
13502
15177
|
"type" : "object"
|
|
13503
15178
|
},
|
|
15179
|
+
"TaskScheduleEnd_oneOf" : {
|
|
15180
|
+
"properties" : {
|
|
15181
|
+
"type" : {
|
|
15182
|
+
"enum" : [ "never" ],
|
|
15183
|
+
"type" : "string"
|
|
15184
|
+
}
|
|
15185
|
+
},
|
|
15186
|
+
"required" : [ "type" ],
|
|
15187
|
+
"type" : "object"
|
|
15188
|
+
},
|
|
15189
|
+
"TaskScheduleEnd_oneOf_1" : {
|
|
15190
|
+
"properties" : {
|
|
15191
|
+
"type" : {
|
|
15192
|
+
"enum" : [ "count" ],
|
|
15193
|
+
"type" : "string"
|
|
15194
|
+
},
|
|
15195
|
+
"count" : {
|
|
15196
|
+
"minimum" : 1,
|
|
15197
|
+
"type" : "integer"
|
|
15198
|
+
}
|
|
15199
|
+
},
|
|
15200
|
+
"required" : [ "count", "type" ],
|
|
15201
|
+
"type" : "object"
|
|
15202
|
+
},
|
|
15203
|
+
"TaskScheduleEnd_oneOf_2" : {
|
|
15204
|
+
"properties" : {
|
|
15205
|
+
"type" : {
|
|
15206
|
+
"enum" : [ "date" ],
|
|
15207
|
+
"type" : "string"
|
|
15208
|
+
},
|
|
15209
|
+
"date" : {
|
|
15210
|
+
"type" : "string"
|
|
15211
|
+
}
|
|
15212
|
+
},
|
|
15213
|
+
"required" : [ "date", "type" ],
|
|
15214
|
+
"type" : "object"
|
|
15215
|
+
},
|
|
13504
15216
|
"App_commands_inner" : {
|
|
13505
15217
|
"properties" : {
|
|
13506
15218
|
"name" : {
|
|
@@ -13942,6 +15654,15 @@
|
|
|
13942
15654
|
"required" : [ "id" ],
|
|
13943
15655
|
"type" : "object"
|
|
13944
15656
|
},
|
|
15657
|
+
"OrganizationMember_user" : {
|
|
15658
|
+
"properties" : {
|
|
15659
|
+
"email" : {
|
|
15660
|
+
"type" : "string"
|
|
15661
|
+
}
|
|
15662
|
+
},
|
|
15663
|
+
"required" : [ "email" ],
|
|
15664
|
+
"type" : "object"
|
|
15665
|
+
},
|
|
13945
15666
|
"KnowledgeFileSummary_knowledgeBaseId" : {
|
|
13946
15667
|
"oneOf" : [ {
|
|
13947
15668
|
"type" : "string"
|
|
@@ -14116,15 +15837,6 @@
|
|
|
14116
15837
|
}
|
|
14117
15838
|
},
|
|
14118
15839
|
"type" : "object"
|
|
14119
|
-
},
|
|
14120
|
-
"User_user" : {
|
|
14121
|
-
"properties" : {
|
|
14122
|
-
"email" : {
|
|
14123
|
-
"type" : "string"
|
|
14124
|
-
}
|
|
14125
|
-
},
|
|
14126
|
-
"required" : [ "email" ],
|
|
14127
|
-
"type" : "object"
|
|
14128
15840
|
}
|
|
14129
15841
|
},
|
|
14130
15842
|
"securitySchemes" : {
|