Skip to main content
POST
/
consultations
Create consultation in a single step
curl --request POST \
  --url https://apim.doctorassistant.ai/api/sandbox/consultations \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-daai-api-key: <api-key>' \
  --form recording='@example-file' \
  --form professionalId=123456 \
  --form specialty=generic \
  --form notes= \
  --form reason= \
  --form 'metadata={
  "patient_id": "123456",
  "attendance_id": "123456"
}'
import requests

url = "https://apim.doctorassistant.ai/api/sandbox/consultations"

files = { "recording": ("example-file", open("example-file", "rb")) }
payload = {
"professionalId": "123456",
"specialty": "generic",
"notes": "",
"reason": "",
"metadata": "{
\"patient_id\": \"123456\",
\"attendance_id\": \"123456\"
}"
}
headers = {"x-daai-api-key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)
const form = new FormData();
form.append('recording', '<string>');
form.append('professionalId', '123456');
form.append('specialty', 'generic');
form.append('notes', '');
form.append('reason', '');
form.append('metadata', '{
"patient_id": "123456",
"attendance_id": "123456"
}');

const options = {method: 'POST', headers: {'x-daai-api-key': '<api-key>'}};

options.body = form;

fetch('https://apim.doctorassistant.ai/api/sandbox/consultations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://apim.doctorassistant.ai/api/sandbox/consultations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recording\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"professionalId\"\r\n\r\n123456\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"specialty\"\r\n\r\ngeneric\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reason\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n{\r\n \"patient_id\": \"123456\",\r\n \"attendance_id\": \"123456\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-daai-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://apim.doctorassistant.ai/api/sandbox/consultations"

payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recording\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"professionalId\"\r\n\r\n123456\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"specialty\"\r\n\r\ngeneric\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reason\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n{\r\n \"patient_id\": \"123456\",\r\n \"attendance_id\": \"123456\"\r\n}\r\n-----011000010111000001101001--")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-daai-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://apim.doctorassistant.ai/api/sandbox/consultations")
.header("x-daai-api-key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recording\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"professionalId\"\r\n\r\n123456\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"specialty\"\r\n\r\ngeneric\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reason\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n{\r\n \"patient_id\": \"123456\",\r\n \"attendance_id\": \"123456\"\r\n}\r\n-----011000010111000001101001--")
.asString();
require 'uri'
require 'net/http'

url = URI("https://apim.doctorassistant.ai/api/sandbox/consultations")

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

request = Net::HTTP::Post.new(url)
request["x-daai-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recording\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"professionalId\"\r\n\r\n123456\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"specialty\"\r\n\r\ngeneric\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reason\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n{\r\n \"patient_id\": \"123456\",\r\n \"attendance_id\": \"123456\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "id": "s0q0ud3fi1d9kcwjrt8vs50n",
  "transcription": "",
  "recording": {},
  "report": {
    "specialty": "generic",
    "content": {}
  },
  "metadata": {}
}
{
"message": "Unauthorized",
"statusCode": 401
}
{
"message": [
"recording is required"
],
"error": "Unprocessable Entity",
"statusCode": 422
}

Authorizations

x-daai-api-key
string
header
required

API key for authentication

Body

multipart/form-data
recording
file
required

Consultation audio file

professionalId
string
required

Professional ID

Example:

"123456"

specialty
string
default:generic

Consultation specialty. If not provided, will be considered as 'generic'

Example:

"generic"

notes
string

Additional notes

Example:

""

reason
string

Consultation reason

Example:

""

metadata
object

Additional consultation metadata

Example:
{
"patient_id": "123456",
"attendance_id": "123456"
}

Response

Consultation created successfully

id
string
required

Consultation ID

Example:

"s0q0ud3fi1d9kcwjrt8vs50n"

transcription
string
required

Consultation transcription

Example:

""

recording
object
required

Recording information

Example:
{}
report
object
required

Consultation report

metadata
object
required

Consultation metadata

Example:
{}