Create a File

1 min

POST

https://developer.digitail.io/api/v1/files

Permissions needed: ACCESS_PATIENTS Upload a new file and attach it to a pet, or directly to a client (a client file, not linked to a pet). Send exactly one of pet_id / user_id.

Form Parameters

payloadobject
Description
send it as a stringified JSON
- pet_idinteger
  Example
  1
  Description
  The pet to attach the file to. Required unless user_id is sent; mutually exclusive with user_id.
- user_idinteger
  Example
  1
  Description
  The client (pet owner) to attach the file to directly, with no pet. Required unless pet_id is sent; mutually exclusive with pet_id and record_id.
- record_idinteger
  Example
  1
filestring<binary>
Format
binary

Responses

201successful operation

object
- dataobject
  Description
  A file that was uploaded to the system and that is linked to a pet. No more than 10MB in size. The file can be a photo, a document, a video, etc. A file can also be associated or not with a record.
  - idinteger
    Example
    1
  - pet_idinteger
    Example
    1
    Description
    Null for a client file, which is attached to the client instead of a pet.
  - clinic_idinteger
    Example
    766
  - file_idinteger
    Description
    The id of the record that the uploaded file is associated to.
  - namestring
    Example
    image.jpg
  - name_without_extensionstring
    Example
    image
  - extensionstring
    Example
    jpg
  - thumbnailstring
    Example
    https://vet.digitail.io/images/files/jpg.svg
  - updated_atstring<date-time>
    Example
    2021-10-05T12:52:53.000000Z
    Format
    date-time
  - download_urlstring
    Example
    https://vet.digitail.io/api/v1/files/1/download
  - preview_urlstring
    Example
    https://vet.digitail.io/api/v1/files/1/preview
  - petobject
    Description
    Only present with include=pet; null when the pet no longer exists.
    - object
      - idinteger
        Example
        1
      - nicknamestring
        Example
        Ben
        Description
        The pet's name as stored, without any status decoration.
      - profile_picturestring
        Example
        https://vet.digitail.io/images/petpic.png
        Description
        The pet's profile picture, or the default pet picture when none is set.
      - is_archivedboolean
        Description
        Convenience flag — true when the pet is archived at the file's clinic. See archive for the archive detail (type, date, reason).
      - archiveobject
        Description
        The pet's archive at the file's clinic, or null when the pet is active there.
        typestring
        Example
        Deceased
        Description
        The archive type (e.g. deceased), localized.
        archived_atstring<date-time>
        Example
        2026-01-02T10:00:00.000000Z
        Format
        date-time
        reasonstring
        Example
        Moved to another practice

curl

curl --request POST \
     --url https://developer.digitail.io/api/v1/files \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data' \
     --form 'payload="object"'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "multipart/form-data");

var formdata = new FormData();
formdata.append("payload", "object");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: formdata,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/files", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/files")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "multipart/form-data"
form_data = [['payload', File.open('undefined')]]
request.set_form form_data, 'multipart/form-data'
response = https.request(request)
puts response.read_body

python

import requests

url = "https://developer.digitail.io/api/v1/files"

payload = {}
files=[

]
headers = {
   'accept': 'application/json',
   'content-type': 'multipart/form-data'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

201

// successful operation
{
  "data": {
    "id": 1,
    "pet_id": 1,
    "clinic_id": 766,
    "file_id": 0,
    "name": "image.jpg",
    "name_without_extension": "image",
    "extension": "jpg",
    "thumbnail": "https://vet.digitail.io/images/files/jpg.svg",
    "updated_at": "2021-10-05T12:52:53.000000Z",
    "download_url": "https://vet.digitail.io/api/v1/files/1/download",
    "preview_url": "https://vet.digitail.io/api/v1/files/1/preview",
    "pet": {}
  }
}