Retrieve an upload session

Retrieve the details of an upload session.

GET /api/v2/upload-session/{uuid}

Try it

Retrieve an upload session

cURL

curl --request GET \
  --url https://paradigm.lighton.ai/api/v2/upload-session/{uuid} \
  --header 'Authorization: Bearer <token>'

201

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_valid": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "documents": [
    {
      "id": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "workspace": "<string>",
      "title": "<string>",
      "collection": 123,
      "status": "pending"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer token authentication

Path Parameters

uuid · string · required

The UUID of the upload session

Response

201

application/json

Upload session retrieved

Response serializer for upload session details.

uuid · string<uuid> · required

Unique identifier for the upload session

is_valid · boolean · required

Whether the upload session is currently valid and active

created_at · string<date-time> · required

Timestamp when the upload session was created

updated_at · string<date-time> · required

Timestamp when the upload session was last updated

documents · object[] · required

List of documents associated with this upload session

Show child attributes

documents. id · integer · required

documents. updated_at · string<date-time> · required

documents. workspace · string · required

Workspace information associated with the document

documents. title · string | null

Maximum string length: 255

documents. collection · integer | null

documents. status · enum<string>

• pending - Pending
• parsing - Parsing
• parsing_failed - Parsing Failed
• embedding - Embedding
• embedding_failed - Embedding Failed
• embedded - Embedded
• fail - Fail
• updating - Updating

Available options: pending, parsing, parsing_failed, embedding, embedding_failed, embedded, fail, updating