PRpremai-io
Files Encrypted

Report file indexing result

Changed on

The Prem API Enclave sends file index results to this callback on the public Prem API Gateway. The callback updates the file's RAG status. The gateway checks the X-Enclave-Secret header before it accepts a result. To begin a file index job, use POST /files/encrypted/index. To read the file status, use GET /files/encrypted/{id}.

post/files/encrypted/index-result

Request

  • Base URL
    https://gateway.prem.io
  • Auth
    API key in header X-Enclave-Secret

Request body

file_idstring required

The ID of the encrypted file

rag_status'running' | 'stopped' | 'failure' | 'success' | 'null' nullable required

The RAG indexing status

Example request

{
  "file_id": "file_0198042e-6dde-7b9c-bc91-452a7e0c833b",
  "rag_status": "success"
}

Response

RAG status updated successfully

status200 | 201 | 202 required

Status code of the response

errorstring nullable

Error message of the response, human readable

messagestring nullable required

Message of the response, human readable

env'development' | 'production' required

API environment

support_idstring uuid nullable

Support ID linked to the response, used to identify it when talking with our team.

Example response

{
  "data": {
    "file_id": "file_0198042e-6dde-7b9c-bc91-452a7e0c833b",
    "rag_status": "success",
    "message": "RAG status updated successfully"
  }
}

Changes