eFax

You have the ability to ingest an eFax by creating a phone number or email with Clarity AI. You can also upload an eFax document using the Clarity Files POST endpoint.

The eFax model

The eFax model contains the upload URL and the instructions message.

Properties

Name
uploadURL
Type
string
Description
Upload URL
Name
instructions
Type
string
Description
Instructions for the GPT

POST/v1/eFax

Upload eFax

This endpoint allows you to upload an eFax to one of your Patient and output a File or send to your integrated system. If no Patient is included then it will create one.

Required attributes

Name
conversation_id
Type
string
Description
Unique identifier for the conversation the message belongs to.
Name
message
Type
string
Description
The message content.

Optional attributes

Name
attachments
Type
array
Description
An array of attachment objects associated with the message.

Request

POST

/v1/eFax

curl https://api.clarityapp.ai/v1/eFax \
  -H "Authorization: Bearer {token}" \
  -d conversation_id="xgQQXg3hrtjh7AvZ"

Response

  {
    "uploadUrl": "string",
    "instructions": "string"
  }