Skip to main content
POST
Capture an image from an authorized integration API

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
integration
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
path
string<starts_with>
required
Maximum string length: 8192
Pattern: ^\/.*
idempotencyKey
string
required
Required string length: 1 - 160
headers
object

Response

Media receipt

artifactId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
mediaType
string
required
byteSize
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
sha256
string
required
state
enum<string>
required
Available options:
pending,
uploading,
ready,
deleting,
deleted
uploadUrl
string<uri>
required
readUrl
string<uri>
required