Upload File

curl -X POST "https://api.moorcheh.ai/v1/namespaces/my-documents/upload-url" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"file_name": "document.pdf"}'

{
  "upload_url": "https://s3.us-east-1.amazonaws.com/...",
  "key": "ownerId/namespace/document.pdf",
  "content_type": "application/pdf",
  "expires_in": 900,
  "method": "PUT",
  "hint": "Upload the file with: PUT <upload_url> with header Content-Type: application/pdf and body = file bytes"
}

{
  "error": "file_name is required"
}

{
  "error": "File type '.exe' is not supported. Allowed types: .pdf, .docx, .xlsx, .json, .txt, .csv, .md"
}

{
  "error": "Unauthorized: API key is required"
}

{
  "error": "Namespace 'example-namespace' not found"
}

POST

namespaces

{namespace_name}

upload-url

curl -X POST "https://api.moorcheh.ai/v1/namespaces/my-documents/upload-url" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"file_name": "document.pdf"}'

{
  "upload_url": "https://s3.us-east-1.amazonaws.com/...",
  "key": "ownerId/namespace/document.pdf",
  "content_type": "application/pdf",
  "expires_in": 900,
  "method": "PUT",
  "hint": "Upload the file with: PUT <upload_url> with header Content-Type: application/pdf and body = file bytes"
}

{
  "error": "file_name is required"
}

{
  "error": "File type '.exe' is not supported. Allowed types: .pdf, .docx, .xlsx, .json, .txt, .csv, .md"
}

{
  "error": "Unauthorized: API key is required"
}

{
  "error": "Namespace 'example-namespace' not found"
}

Overview

Returns a pre-signed S3 PUT URL so you can upload files directly to S3. This bypasses API Gateway’s 10MB limit and allows uploads up to 5GB.

Use this endpoint for large files (up to 5GB). The pre-signed URL flow avoids API Gateway size limits.

How It Works

Step 1: Get Pre-signed URL

Call this endpoint with your desired file_name to get the upload URL

Step 2: Upload File to S3

Use the upload_url with a PUT request, setting the Content-Type header to the content_type value from the response

Step 3: Automatic Processing

After upload, the file is automatically processed through the document pipeline

The pre-signed URL expires in 15 minutes. Upload your file before it expires.

Step 1: Get Pre-signed URL

Authentication

string

required

Your API key for authentication

string

required

Must be application/json

Path Parameters

string

required

Name of the text namespace to upload files to

Body Parameters

string

required

Target filename including extension (e.g., document.pdf). Content-Type is auto-detected from the file extension.

Preferred field names are snake_case. Legacy camelCase (fileName) is still accepted for backward compatibility and returns deprecation headers (Deprecation, Sunset, Warning). CamelCase support is deprecated and scheduled for removal on 1 May 2026.

curl -X POST "https://api.moorcheh.ai/v1/namespaces/my-documents/upload-url" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"file_name": "document.pdf"}'

{
  "upload_url": "https://s3.us-east-1.amazonaws.com/...",
  "key": "ownerId/namespace/document.pdf",
  "content_type": "application/pdf",
  "expires_in": 900,
  "method": "PUT",
  "hint": "Upload the file with: PUT <upload_url> with header Content-Type: application/pdf and body = file bytes"
}

{
  "error": "file_name is required"
}

{
  "error": "File type '.exe' is not supported. Allowed types: .pdf, .docx, .xlsx, .json, .txt, .csv, .md"
}

{
  "error": "Unauthorized: API key is required"
}

{
  "error": "Namespace 'example-namespace' not found"
}

Response Fields

string

Pre-signed S3 URL for uploading the file via PUT request

string

S3 object key where the file will be stored

string

Content-Type header to use when uploading (auto-detected from file_name)

number

URL expiration time in seconds (default: 900 = 15 minutes)

string

HTTP method to use for upload (always PUT)

string

Human-readable instructions for uploading the file

Step 2: Upload File to S3

Use the upload_url from the response above to upload your file directly to S3.

Upload File to S3

curl -X PUT "<upload_url>" \
  -H "Content-Type: <content_type>" \
  --data-binary "@/path/to/document.pdf"

Supported File Types

Use the corresponding Content-Type when uploading:

Extension	Content-Type
`.pdf`	`application/pdf`
`.docx`	`application/vnd.openxmlformats-officedocument.wordprocessingml.document`
`.xlsx`	`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
`.json`	`application/json`
`.txt`	`text/plain`
`.csv`	`text/csv`
`.md`	`text/markdown`

S3 Upload Errors

403 - URL Expired

<Error>
  <Code>AccessDenied</Code>
  <Message>Request has expired</Message>
</Error>

If you receive the expired URL error, request a new pre-signed URL from Step 1.

List Files - List uploaded files in a namespace
Upload Text - Upload text content directly
Search - Search uploaded files and documents
Get Documents - Retrieve document information

Getting Started

Namespace Management

Search & Discovery

AI Generation

Data Operations

File storage

Overview

How It Works

Step 1: Get Pre-signed URL

Authentication

Path Parameters

Body Parameters

Response Fields

Step 2: Upload File to S3

Supported File Types

S3 Upload Errors

​Overview

​How It Works

​Step 1: Get Pre-signed URL

​Authentication

​Path Parameters

​Body Parameters

​Response Fields

​Step 2: Upload File to S3

​Supported File Types

​S3 Upload Errors

​Related Endpoints

Overview

How It Works

Step 1: Get Pre-signed URL

Authentication

Path Parameters

Body Parameters

Response Fields

Step 2: Upload File to S3

Supported File Types

S3 Upload Errors

Related Endpoints