---
title: "Create a Forecast proof upload session"
---

> 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 › predictions

`POST /v2/entities/{entityId}/calls/{callId}/evidence/uploads`

## Path parameters

- `entityId` (`predictions-create-evidence-upload.path.entityId`; any of, required)
  - any of: `string`, `string`
- `callId` (`predictions-create-evidence-upload.path.callId`; string, required)
  - format `uuid`

## Request body

_Required._

- `filename` (`predictions-create-evidence-upload.filename`; string, required)
  - minLength 1; maxLength 255
- `mimeType` (`predictions-create-evidence-upload.mimeType`; string, required)
  - one of `"application/pdf"`, `"image/jpeg"`, `"image/png"`, `"image/webp"`, `"text/plain"`, `"text/csv"`
- `byteSize` (`predictions-create-evidence-upload.byteSize`; integer, required)
  - min 0; max 26214400
- `sha256` (`predictions-create-evidence-upload.sha256`; string, required)
  - pattern `^sha256:[a-f0-9]{64}$`

## Example request

```json
{
  "filename": "string",
  "mimeType": "application/pdf",
  "byteSize": 0,
  "sha256": "string"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.sureshake.com/v2/entities/<entityId>/calls/<callId>/evidence/uploads' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filename": "string",
  "mimeType": "application/pdf",
  "byteSize": 0,
  "sha256": "string"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/entities/<entityId>/calls/<callId>/evidence/uploads';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({filename: 'string', mimeType: 'application/pdf', byteSize: 0, sha256: 'string'})
};

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/entities/<entityId>/calls/<callId>/evidence/uploads"

payload = {
    "filename": "string",
    "mimeType": "application/pdf",
    "byteSize": 0,
    "sha256": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
```

## Responses

### 201

Default Response

#### Example

```json
{
  "data": {
    "artifact": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "callId": "4722cd84-0ec7-4ef5-8c34-1b0150f45f53",
      "filename": "string",
      "mimeType": "string",
      "byteSize": 0,
      "sha256": "string",
      "status": "upload_session_created",
      "scanError": "string",
      "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",
      "confirmedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z"
    },
    "uploadUrl": "http://example.com",
    "uploadMethod": "PUT",
    "uploadHeaders": {
      "property1": "string",
      "property2": "string"
    },
    "uploadExpiresAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`predictions-create-evidence-upload.response.201.data`; object, required)
  - `artifact` (`predictions-create-evidence-upload.response.201.data.artifact`; object, required)
    - `id` (`predictions-create-evidence-upload.response.201.data.artifact.id`; string, required)
      - format `uuid`
    - `callId` (`predictions-create-evidence-upload.response.201.data.artifact.callId`; string, required)
      - format `uuid`
    - `filename` (`predictions-create-evidence-upload.response.201.data.artifact.filename`; string, required)
    - `mimeType` (`predictions-create-evidence-upload.response.201.data.artifact.mimeType`; string, required)
    - `byteSize` (`predictions-create-evidence-upload.response.201.data.artifact.byteSize`; integer, required)
      - min 0
    - `sha256` (`predictions-create-evidence-upload.response.201.data.artifact.sha256`; string, required)
      - pattern `^sha256:[a-f0-9]{64}$`
    - `status` (`predictions-create-evidence-upload.response.201.data.artifact.status`; string, required)
      - one of `"upload_session_created"`, `"scan_pending"`, `"attached"`, `"failed"`
    - `scanError` (`predictions-create-evidence-upload.response.201.data.artifact.scanError`; string, required, nullable)
    - `eventId` (`predictions-create-evidence-upload.response.201.data.artifact.eventId`; string, required, nullable)
      - format `uuid`
    - `confirmedAt` (`predictions-create-evidence-upload.response.201.data.artifact.confirmedAt`; string, required, nullable)
      - format `date-time`
    - `createdAt` (`predictions-create-evidence-upload.response.201.data.artifact.createdAt`; string, required)
      - format `date-time`
  - `uploadUrl` (`predictions-create-evidence-upload.response.201.data.uploadUrl`; string, required)
    - format `uri`
  - `uploadMethod` (`predictions-create-evidence-upload.response.201.data.uploadMethod`; string, required)
    - one of `"PUT"`
  - `uploadHeaders` (`predictions-create-evidence-upload.response.201.data.uploadHeaders`; map<string>, required)
  - `uploadExpiresAt` (`predictions-create-evidence-upload.response.201.data.uploadExpiresAt`; string, required)
    - format `date-time`
- `meta` (`predictions-create-evidence-upload.response.201.meta`; object, optional)
  - `timestamp` (`predictions-create-evidence-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` (`predictions-create-evidence-upload.response.400.error`; object, required)
  - `code` (`predictions-create-evidence-upload.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-create-evidence-upload.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-create-evidence-upload.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-create-evidence-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` (`predictions-create-evidence-upload.response.401.error`; object, required)
  - `code` (`predictions-create-evidence-upload.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-create-evidence-upload.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-create-evidence-upload.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-create-evidence-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` (`predictions-create-evidence-upload.response.403.error`; object, required)
  - `code` (`predictions-create-evidence-upload.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-create-evidence-upload.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-create-evidence-upload.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-create-evidence-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` (`predictions-create-evidence-upload.response.404.error`; object, required)
  - `code` (`predictions-create-evidence-upload.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-create-evidence-upload.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-create-evidence-upload.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-create-evidence-upload.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

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

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

### 500

Default Response

#### Example

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

- `error` (`predictions-create-evidence-upload.response.500.error`; object, required)
  - `code` (`predictions-create-evidence-upload.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-create-evidence-upload.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-create-evidence-upload.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-create-evidence-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` (`predictions-create-evidence-upload.response.503.error`; object, required)
  - `code` (`predictions-create-evidence-upload.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-create-evidence-upload.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-create-evidence-upload.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-create-evidence-upload.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/predictions-create-evidence-upload/index.md
