For the complete documentation index, see llms.txt. This page is also available as Markdown.

Admin Files

Upload Files

post
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body
uploader_usernamestringRequired
metadatastringRequired
filesstring · binary[]Required
Responses
200

Successful Response

application/json
filenamestring · max: 255Required
sourcestring · max: 255Required
descriptionstring · max: 512 · nullableOptional
storage_pathstring · max: 512Required
uploader_usernamestring · max: 255Required
access_levelstring · max: 50 · nullableOptionalDefault: public
tagsstring[] · nullableOptional
organization_idintegerRequired
active_statusstring · max: 50 · nullableOptionalDefault: active
processing_statusstring · max: 50 · nullableOptionalDefault: uploaded
stagestring · max: 50 · nullableOptional
failure_reasonstring · nullableOptional
post/api/v1/admin/files/upload
POST /api/v1/admin/files/upload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 65

{
  "uploader_username": "text",
  "metadata": "text",
  "files": [
    "binary"
  ]
}
[
  {
    "filename": "text",
    "source": "text",
    "description": "text",
    "storage_path": "text",
    "uploader_username": "text",
    "access_level": "public",
    "tags": [
      "text"
    ],
    "organization_id": 1,
    "active_status": "active",
    "processing_status": "uploaded",
    "stage": "text",
    "failure_reason": "text"
  }
]

List Admin Files

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Query parameters
role_idinteger · nullableOptional
Responses
200

Successful Response

application/json
filenamestring · max: 255Required
sourcestring · max: 255Required
descriptionstring · max: 512 · nullableOptional
storage_pathstring · max: 512Required
uploader_usernamestring · max: 255Required
access_levelstring · max: 50 · nullableOptionalDefault: public
tagsstring[] · nullableOptional
organization_idintegerRequired
active_statusstring · max: 50 · nullableOptionalDefault: active
processing_statusstring · max: 50 · nullableOptionalDefault: uploaded
stagestring · max: 50 · nullableOptional
failure_reasonstring · nullableOptional
file_idintegerRequired
uploaded_atstring · date-timeRequired
updated_atstring · date-time · nullableOptional
get/api/v1/admin/files
GET /api/v1/admin/files HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "filename": "text",
    "source": "text",
    "description": "text",
    "storage_path": "text",
    "uploader_username": "text",
    "access_level": "public",
    "tags": [
      "text"
    ],
    "organization_id": 1,
    "active_status": "active",
    "processing_status": "uploaded",
    "stage": "text",
    "failure_reason": "text",
    "file_id": 1,
    "uploaded_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "profile": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Get Admin File

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
file_idintegerRequired
Responses
200

Successful Response

application/json
filenamestring · max: 255Required
sourcestring · max: 255Required
descriptionstring · max: 512 · nullableOptional
storage_pathstring · max: 512Required
uploader_usernamestring · max: 255Required
access_levelstring · max: 50 · nullableOptionalDefault: public
tagsstring[] · nullableOptional
organization_idintegerRequired
active_statusstring · max: 50 · nullableOptionalDefault: active
processing_statusstring · max: 50 · nullableOptionalDefault: uploaded
stagestring · max: 50 · nullableOptional
failure_reasonstring · nullableOptional
file_idintegerRequired
uploaded_atstring · date-timeRequired
updated_atstring · date-time · nullableOptional
get/api/v1/admin/files/{file_id}
GET /api/v1/admin/files/{file_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "filename": "text",
  "source": "text",
  "description": "text",
  "storage_path": "text",
  "uploader_username": "text",
  "access_level": "public",
  "tags": [
    "text"
  ],
  "organization_id": 1,
  "active_status": "active",
  "processing_status": "uploaded",
  "stage": "text",
  "failure_reason": "text",
  "file_id": 1,
  "uploaded_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Delete Admin File

delete
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
file_idintegerRequired
Query parameters
allow_force_deleteboolean · nullableOptional
Responses
200

Successful Response

application/json
anyOptional
delete/api/v1/admin/files/{file_id}
DELETE /api/v1/admin/files/{file_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Admin File

patch
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
file_idintegerRequired
Body
filenamestring · nullableOptional
sourcestring · nullableOptional
descriptionstring · nullableOptional
uploaded_atstring · date-time · nullableOptional
storage_pathstring · nullableOptional
uploader_usernamestring · nullableOptional
access_levelstring · nullableOptional
tagsstring[] · nullableOptional
organization_idinteger · nullableOptional
Responses
200

Successful Response

application/json
filenamestring · max: 255Required
sourcestring · max: 255Required
descriptionstring · max: 512 · nullableOptional
storage_pathstring · max: 512Required
uploader_usernamestring · max: 255Required
access_levelstring · max: 50 · nullableOptionalDefault: public
tagsstring[] · nullableOptional
organization_idintegerRequired
active_statusstring · max: 50 · nullableOptionalDefault: active
processing_statusstring · max: 50 · nullableOptionalDefault: uploaded
stagestring · max: 50 · nullableOptional
failure_reasonstring · nullableOptional
file_idintegerRequired
uploaded_atstring · date-timeRequired
updated_atstring · date-time · nullableOptional
patch/api/v1/admin/files/{file_id}
PATCH /api/v1/admin/files/{file_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "filename": "text",
  "source": "text",
  "description": "text",
  "uploaded_at": "2026-01-01T00:00:00.000Z",
  "storage_path": "text",
  "uploader_username": "text",
  "access_level": "text",
  "tags": [
    "text"
  ],
  "organization_id": 1
}
{
  "filename": "text",
  "source": "text",
  "description": "text",
  "storage_path": "text",
  "uploader_username": "text",
  "access_level": "public",
  "tags": [
    "text"
  ],
  "organization_id": 1,
  "active_status": "active",
  "processing_status": "uploaded",
  "stage": "text",
  "failure_reason": "text",
  "file_id": 1,
  "uploaded_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Retry Admin File Processing

post

Re-run ingestion for an admin file stuck in 'failed' status (NCP-3810).

force=true also accepts 'completed' files (re-profile + re-index).

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
file_idintegerRequired
Query parameters
forcebooleanOptionalDefault: false
Responses
200

Successful Response

application/json
filenamestring · max: 255Required
sourcestring · max: 255Required
descriptionstring · max: 512 · nullableOptional
storage_pathstring · max: 512Required
uploader_usernamestring · max: 255Required
access_levelstring · max: 50 · nullableOptionalDefault: public
tagsstring[] · nullableOptional
organization_idintegerRequired
active_statusstring · max: 50 · nullableOptionalDefault: active
processing_statusstring · max: 50 · nullableOptionalDefault: uploaded
stagestring · max: 50 · nullableOptional
failure_reasonstring · nullableOptional
file_idintegerRequired
uploaded_atstring · date-timeRequired
updated_atstring · date-time · nullableOptional
post/api/v1/admin/files/{file_id}/retry
POST /api/v1/admin/files/{file_id}/retry HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "filename": "text",
  "source": "text",
  "description": "text",
  "storage_path": "text",
  "uploader_username": "text",
  "access_level": "public",
  "tags": [
    "text"
  ],
  "organization_id": 1,
  "active_status": "active",
  "processing_status": "uploaded",
  "stage": "text",
  "failure_reason": "text",
  "file_id": 1,
  "uploaded_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Download Admin File

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
file_idintegerRequired
Responses
200

Successful Response

No content

get/api/v1/admin/files/{file_id}/download
GET /api/v1/admin/files/{file_id}/download HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Sync Admin Files

post
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body
directory_pathstringRequired
uploader_usernamestringRequired
organization_idintegerOptionalDefault: 1
Responses
200

Successful Response

application/json
anyOptional
post/api/v1/admin/files/sync_files
POST /api/v1/admin/files/sync_files HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 72

"directory_path='text'&uploader_username='text'&organization_id=1"

No content

Last updated