Get upload session
Interface Description
Read upload progress and the next page of entries needed to resume a session.
Endpoint
| Field | Value |
|---|---|
| Method | GET |
| Path | /openapi/v2/knowledge-bases/{knowledgeBaseId}/upload-sessions/{uploadSessionId} |
| Operation ID | getUploadSession |
| Authentication | Bearer OpenAPI key |
Parameters
| Name | Location | Required | Type | Example | Description |
|---|---|---|---|---|---|
knowledgeBaseId | path | Yes | string | knowledge-base-11111111-1111-4111-8111-111111111111 | Knowledge-base identifier returned by knowledge-base APIs. |
uploadSessionId | path | Yes | string | upload-11111111-1111-4111-8111-111111111111 | Upload session identifier returned by createUploadSession. |
limit | query | No | integer | 50 | Maximum number of records to return. The deployment can enforce a lower limit. |
cursor | query | No | string | cursor_123 | Pagination token returned by the same endpoint for reading the next page. |
transferState | query | No | missing | uploaded | missing | Optional filter for the upload progress of each file record. |
Request Body
This operation has no request body.
Request Example
bash
curl -X GET "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/upload-sessions/upload-11111111-1111-4111-8111-111111111111?limit=50" \
-H "Authorization: Bearer <openapi-key>"Successful Responses
200
Current upload session and the requested page of file records.
| Field | Required | Type | Description |
|---|---|---|---|
session | Yes | object | Upload session returned by the request. |
entries | Yes | allOf(Page) | Requested page of upload file records and the token for reading the next page. |
Success Response Example
json
{
"session": {
"id": "upload-11111111-1111-4111-8111-111111111111",
"operationId": "upload-operation-11111111-1111-4111-8111-111111111111",
"knowledgeBaseId": "knowledge-base-11111111-1111-4111-8111-111111111111",
"state": "completed",
"declaredFileCount": 1,
"declaredByteCount": 37,
"counts": {
"selected": 1,
"uploadRequired": 1,
"skippedExisting": 0,
"waitingReservation": 0,
"rejectedDeleting": 0,
"uploaded": 1,
"finalized": 1
},
"errorCode": null,
"expiresAt": "2026-06-18T00:00:00.000Z",
"completedAt": "2026-06-17T00:00:00.000Z",
"createdAt": "2026-06-17T00:00:00.000Z",
"updatedAt": "2026-06-17T00:00:00.000Z",
"actions": {
"operation": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/operations/upload-operation-11111111-1111-4111-8111-111111111111"
}
},
"entries": {
"items": [
{
"id": "upload-entry-11111111-1111-4111-8111-111111111111",
"relativePath": "handbook/onboarding/guide.md",
"directoryPath": "handbook/onboarding",
"name": "guide.md",
"declaredSize": 37,
"receivedSize": 37,
"disposition": "upload_required",
"transferState": "uploaded",
"sourceFileId": "source-file-11111111-1111-4111-8111-111111111111",
"existingResourceRevision": null
}
],
"nextCursor": null
}
}Error Codes
The table below lists every error response documented for this operation.
| HTTP Status | Error Code | Explanation |
|---|---|---|
| 401 | UNAUTHORIZED | The Bearer API key is missing, malformed, unknown, revoked, or deleted. |
| 404 | NOT_FOUND | The requested resource was not found. |
| 422 | VALIDATION_ERROR | The request failed validation. |
| 429 | RATE_LIMITED | The request exceeded the configured rate limits. |
| 500 | INTERNAL_ERROR | The API encountered an internal error. |
| 503 | DATABASE_REPOSITORY_UNAVAILABLE | The data required by this operation is temporarily unavailable. |