Skip to main content
POST
/
v1
/
media
Create media
curl --request POST \
  --url https://api.clinikapi.com/v1/media \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "content": {
    "contentType": "<string>",
    "data": "<string>",
    "url": "<string>",
    "title": "<string>"
  },
  "type": "<string>",
  "modality": "<string>",
  "view": "<string>",
  "patientId": "<string>",
  "encounterId": "<string>",
  "createdDateTime": "<string>",
  "issued": "<string>",
  "operatorId": "<string>",
  "reasonCode": [
    "<string>"
  ],
  "bodySite": "<string>",
  "deviceName": "<string>",
  "deviceId": "<string>",
  "height": 123,
  "width": 123,
  "frames": 123,
  "duration": 123,
  "note": "<string>",
  "basedOn": [
    "<string>"
  ]
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
preparation,
in-progress,
not-done,
on-hold,
stopped,
completed
content
object
required
type
string
Maximum string length: 200
modality
string
Maximum string length: 200
view
string
Maximum string length: 200
patientId
string
Maximum string length: 128
encounterId
string
Maximum string length: 128
createdDateTime
string
Maximum string length: 50
issued
string
Maximum string length: 50
operatorId
string
Maximum string length: 128
reasonCode
string[]
Maximum array length: 10
Maximum string length: 500
bodySite
string
Maximum string length: 200
deviceName
string
Maximum string length: 500
deviceId
string
Maximum string length: 128
height
integer
width
integer
frames
integer
duration
number
note
string
Maximum string length: 5000
basedOn
string[]
Maximum array length: 10
Maximum string length: 128

Response

201

Media created