---
title: "Upload document"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › documents

`POST /v2/documents/upload`

## Request body

_Required._

- `filename` (`document-upload.filename`; string, required)
  - minLength 1; maxLength 255
- `content` (`document-upload.content`; string, required) — Base64 encoded file content
- `mimetype` (`document-upload.mimetype`; string, required)
  - one of `"application/pdf"`, `"text/plain"`, `"text/markdown"`, `"application/vnd.openxmlformats-officedocument.wordprocessingml.document"`, `"application/json"`, `"text/csv"`, `"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"`, `"application/vnd.ms-excel"`

## Example request

```json
{
  "filename": "string",
  "content": "string",
  "mimetype": "application/pdf"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url https://api.sureshake.com/v2/documents/upload \
  --header 'Content-Type: application/json' \
  --data '
{
  "filename": "string",
  "content": "string",
  "mimetype": "application/pdf"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/documents/upload';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({filename: 'string', content: 'string', mimetype: 'application/pdf'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/documents/upload"

payload = {
    "filename": "string",
    "content": "string",
    "mimetype": "application/pdf"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 201

Default Response

#### Example

```json
{
  "data": {
    "documentKey": "string",
    "documentUrl": "http://example.com",
    "hash": "string",
    "name": "string",
    "type": "string",
    "size": 0,
    "uploadedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`document-upload.response.201.data`; object, required)
  - `documentKey` (`document-upload.response.201.data.documentKey`; string, required)
  - `documentUrl` (`document-upload.response.201.data.documentUrl`; string, required)
    - format `uri`
  - `hash` (`document-upload.response.201.data.hash`; string, required)
  - `name` (`document-upload.response.201.data.name`; string, required)
  - `type` (`document-upload.response.201.data.type`; string, required)
  - `size` (`document-upload.response.201.data.size`; number, required)
  - `uploadedAt` (`document-upload.response.201.data.uploadedAt`; string, required)
    - format `date-time`
- `meta` (`document-upload.response.201.meta`; object, optional)
  - `timestamp` (`document-upload.response.201.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`document-upload.response.400.error`; object, required)
  - `code` (`document-upload.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`document-upload.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`document-upload.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`document-upload.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`document-upload.response.401.error`; object, required)
  - `code` (`document-upload.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`document-upload.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`document-upload.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`document-upload.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`document-upload.response.403.error`; object, required)
  - `code` (`document-upload.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`document-upload.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`document-upload.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`document-upload.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`document-upload.response.404.error`; object, required)
  - `code` (`document-upload.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`document-upload.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`document-upload.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`document-upload.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 413

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`document-upload.response.413.error`; object, required)
  - `code` (`document-upload.response.413.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`document-upload.response.413.error.message`; string, required) — Human-readable error message
  - `details` (`document-upload.response.413.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`document-upload.response.413.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`document-upload.response.500.error`; object, required)
  - `code` (`document-upload.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`document-upload.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`document-upload.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`document-upload.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`document-upload.response.503.error`; object, required)
  - `code` (`document-upload.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`document-upload.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`document-upload.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`document-upload.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/document-upload/index.md