Skip to content

feat: expose the assistant folder's path in an api #582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kyteinsky merged 3 commits into from
Jul 8, 2026
Merged

feat: expose the assistant folder's path in an api #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
56eee26
feat: expose the assistant folder's path in an api
kyteinsky Jun 18, 2026
dbeaa9d
fix psalm
kyteinsky Jul 8, 2026
24e6bbd
fix(ci): phpunit NC 35 fix
kyteinsky Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/phpunit.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ jobs:
matrix:
php-versions: ['8.2']
databases: ['sqlite']
server-versions: ['stable33', 'master']
server-versions: ['stable33', 'stable34']
include:
- php-versions: '8.3'
server-versions: 'master'

name: php${{ matrix.php-versions }}-${{ matrix.databases }}-${{ matrix.server-versions }}

Expand Down
1 change: 1 addition & 0 deletions appinfo/routes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
['name' => 'assistantApi#getOutputFilePreview', 'url' => '/api/{apiVersion}/task/{ocpTaskId}/output-file/{fileId}/preview', 'verb' => 'GET', 'requirements' => $requirements],
['name' => 'assistantApi#getOutputFile', 'url' => '/api/{apiVersion}/task/{ocpTaskId}/output-file/{fileId}/download', 'verb' => 'GET', 'requirements' => $requirements],
['name' => 'assistantApi#runFileAction', 'url' => '/api/{apiVersion}/file-action/{fileId}/{taskTypeId}', 'verb' => 'POST', 'requirements' => $requirements],
['name' => 'assistantApi#getAssistantFolderPath', 'url' => '/api/{apiVersion}/assistant-folder-path', 'verb' => 'GET', 'requirements' => $requirements],

['name' => 'chattyLLM#newSession', 'url' => '/chat/sessions', 'verb' => 'POST', 'postfix' => 'restful'],
['name' => 'chattyLLM#updateChatSession', 'url' => '/chat/sessions/{sessionId}', 'verb' => 'PUT', 'postfix' => 'restful'],
Expand Down
20 changes: 20 additions & 0 deletions lib/Controller/AssistantApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,4 +447,24 @@ public function runFileAction(int $fileId, string $taskTypeId): DataResponse {
return new DataResponse(['error' => $e->getMessage()], Http::STATUS_BAD_REQUEST);
}
}

/**
* Get the assistant folder's path
*
* Returns the assistant folder's path inside the user's home mount
*
* @return DataResponse<Http::STATUS_OK, array{path: string}, array{}>|DataResponse<Http::STATUS_UNAUTHORIZED, array{error: string}, array{}>
*
* 200: The path is returned in the form: /<userId>/files/Assistant
*/
#[NoAdminRequired]
#[NoCsrfRequired]
public function getAssistantFolderPath(): DataResponse {
if ($this->userId === null) {
return new DataResponse(['error' => 'User should be logged in'], Http::STATUS_UNAUTHORIZED);
}

$folder = $this->assistantService->getAssistantDataFolder($this->userId);
return new DataResponse(['path' => $folder->getPath()]);
}
}
145 changes: 145 additions & 0 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2743,6 +2743,151 @@
}
}
},
"/ocs/v2.php/apps/assistant/api/{apiVersion}/assistant-folder-path": {
"get": {
"operationId": "assistant_api-get-assistant-folder-path",
"summary": "Get the assistant folder's path",
"description": "Returns the assistant folder's path inside the user's home mount",
"tags": [
"assistant_api"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "apiVersion",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"v1"
],
"default": "v1"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
"required": true,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "The path is returned in the form: /<userId>/files/Assistant",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"path"
],
"properties": {
"path": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"401": {
"description": "Current user is not logged in",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
},
{
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
]
}
}
}
}
}
}
},
"/ocs/v2.php/apps/assistant/chat/sessions": {
"post": {
"operationId": "chattyllm-new-session-restful",
Expand Down
Loading