Create a Forecast proof upload session

POST

https://api.sureshake.com/v2/entities/{entityId}/calls/{callId}/evidence/uploads

Path parameters

entityId
required
Any of the following:
string
string
}

callId
string
required
format: uuid

Request body JSON required

filename
string
required
maxLength: 255 · minLength: 1
mimeType
application/pdf
or
image/jpeg
or
image/png
or
image/webp
or
text/plain
or
text/csv
required
byteSize
integer
required
maximum: 26214400 · minimum: 0
sha256
string
required
pattern: ^sha256:[a-f0-9]{64}$

Returns

201

Default Response

JSON

data
object
required
- artifact
  object
  required
  id
  string
  required
  format: uuid
  callId
  string
  required
  format: uuid
  filename
  string
  required
  mimeType
  string
  required
  byteSize
  integer
  required
  minimum: 0
  sha256
  string
  required
  pattern: ^sha256:[a-f0-9]{64}$
  status
  upload_session_created
  or
  scan_pending
  or
  attached
  or
  failed
  required
  scanError
  string
  or null
  required
  eventId
  string
  or null
  required
  format: uuid
  confirmedAt
  string
  or null
  required
  format: date-time
  createdAt
  string
  required
  format: date-time
- uploadUrl
  string
  required
  format: uri
- uploadMethod
  PUT
  required
- uploadHeaders
  map of
  string
  required
- uploadExpiresAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Create a Forecast proof upload session

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"
}
'

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));

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)

Response example

{
  "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"
  }
}

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

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

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

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

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

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

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