Generate a signed URL for file upload | Sensay API documentation

Generate a signed URL for file upload Beta

GET /v1/replicas/{replicaUUID}/training/files/upload

Creates a signed URL for uploading a file to the knowledge base. This is the first step in the file-based training process. The response includes both a signedURL where you can upload your file and a knowledgeBaseID for tracking. After receiving these, use a PUT request to the signedURL to upload your file (with Content-Type: application/octet-stream). The system will automatically extract text from your file, process it, and make it available for your replica to use. Supported file types include PDF, DOCX, and other text-based formats. Files up to 50MB are supported.

Path parameters

replicaUUID string(uuid) Required

The replica unique identifier (UUID)

Query parameters

filename string Required

The name of the file you want to upload to the knowledge base. This helps identify the file in your knowledge base. Files up to 50MB are supported.

Minimum length is 1.

Responses

200 application/json

The generated signed URL
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates if the signed URL was generated successfully
- signedURL string
  
  The temporary URL where you should upload your file using a PUT request with Content-Type: application/octet-stream
- knowledgeBaseID number
  
  The unique identifier for the newly created knowledge base entry. Use this to track the processing status of your file.
400 application/json

Bad Request
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
404 application/json

Not Found
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- request_id string Required
  
  A unique identifier of the request, useful for reporting
415 application/json

Unsupported Media Type
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
- inner_exception object
  
  The inner exception
  
  Hide inner_exception attributes Show inner_exception attributes object
  
  name string Required
  
  message string Required
  
  cause string
  
  stack string

GET /v1/replicas/{replicaUUID}/training/files/upload

curl \
 --request GET 'https://api.sensay.io/v1/replicas/03db5651-cb61-4bdf-9ef0-89561f7c9c53/training/files/upload?filename=company_handbook.pdf' \
 --header "X-ORGANIZATION-SECRET: $API_KEY"

Response examples (200)

{
  "success": true,
  "signedURL": "https://storage.googleapis.com/replica_files/...",
  "knowledgeBaseID": 12345
}

Response examples (400)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (401)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (404)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab"
}

Response examples (415)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (500)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b",
  "inner_exception": {
    "name": "Server overheated",
    "cause": "Request too complicated",
    "stack": "Error: Server overheated due to an unexpected situation\n    at Object.eval (eval at <anonymous>...",
    "message": "The server overheated due to an unexpected situation"
  }
}