Create a New Task.
curl --request POST \
--url https://app.synthpop.ai/public/v1/task/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form task_type= \
--form 'request_spec={}' \
--form external_id= \
--form name= \
--form callback_template=import requests
url = "https://app.synthpop.ai/public/v1/task/create"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_spec\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_template\"\r\n\r\n\r\n-----011000010111000001101001--"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('task_type', '');
form.append('request_spec', '{}');
form.append('external_id', '');
form.append('name', '');
form.append('callback_template', '');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://app.synthpop.ai/public/v1/task/create', 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://app.synthpop.ai/public/v1/task/create",
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=\"task_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_spec\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_template\"\r\n\r\n\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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://app.synthpop.ai/public/v1/task/create"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_spec\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_template\"\r\n\r\n\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.synthpop.ai/public/v1/task/create")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_spec\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_template\"\r\n\r\n\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.synthpop.ai/public/v1/task/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_spec\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_template\"\r\n\r\n\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"task_type": "<string>",
"status": "pending",
"name": "<string>",
"cleared": "2023-11-07T05:31:56Z",
"created": "2023-11-07T05:31:56Z",
"latest_status_change": "2023-11-07T05:31:56Z",
"category": "<string>",
"data_items": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"group": "inputs",
"tag": "<string>",
"created": "2023-11-07T05:31:56Z",
"data_type": "file",
"name": "<string>",
"data_format": "<string>",
"medical_records": [
{
"id": 123,
"record_type": "<string>",
"sections": [
{
"start": 123,
"length": 123,
"content": "<string>",
"fields": {}
}
],
"timestamp": "2023-11-07T05:31:56Z",
"fields": {}
}
],
"alias": "<string>"
}
],
"issues": [
{
"message": "<string>",
"key": "task.llm.other"
}
],
"external_id": "<string>",
"verdicts": [
{
"code": "<string>",
"approved": true,
"issues": [
123
]
}
],
"interceptions": {},
"verdict_summaries": [
{
"code": "<string>",
"conclusion": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Tasks
Create a New Task.
Create a new Task to process input. Upload one or more document(s) to process.
- Create a new task of a given
task_type. Additional type-specific configuration might be passed in viarequest_spec, if needed. - Optionally, a (unique)
external_idor anamefor the task can be specified. - A set of documents (files) to process (typically PDFs, text, or images, but in some cases
audio files as well) can be specified under
uploads.
POST
/
task
/
create
Create a New Task.
curl --request POST \
--url https://app.synthpop.ai/public/v1/task/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form task_type= \
--form 'request_spec={}' \
--form external_id= \
--form name= \
--form callback_template=import requests
url = "https://app.synthpop.ai/public/v1/task/create"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_spec\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_template\"\r\n\r\n\r\n-----011000010111000001101001--"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('task_type', '');
form.append('request_spec', '{}');
form.append('external_id', '');
form.append('name', '');
form.append('callback_template', '');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://app.synthpop.ai/public/v1/task/create', 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://app.synthpop.ai/public/v1/task/create",
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=\"task_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_spec\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_template\"\r\n\r\n\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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://app.synthpop.ai/public/v1/task/create"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_spec\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_template\"\r\n\r\n\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.synthpop.ai/public/v1/task/create")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_spec\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_template\"\r\n\r\n\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.synthpop.ai/public/v1/task/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_spec\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_template\"\r\n\r\n\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"task_type": "<string>",
"status": "pending",
"name": "<string>",
"cleared": "2023-11-07T05:31:56Z",
"created": "2023-11-07T05:31:56Z",
"latest_status_change": "2023-11-07T05:31:56Z",
"category": "<string>",
"data_items": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"group": "inputs",
"tag": "<string>",
"created": "2023-11-07T05:31:56Z",
"data_type": "file",
"name": "<string>",
"data_format": "<string>",
"medical_records": [
{
"id": 123,
"record_type": "<string>",
"sections": [
{
"start": 123,
"length": 123,
"content": "<string>",
"fields": {}
}
],
"timestamp": "2023-11-07T05:31:56Z",
"fields": {}
}
],
"alias": "<string>"
}
],
"issues": [
{
"message": "<string>",
"key": "task.llm.other"
}
],
"external_id": "<string>",
"verdicts": [
{
"code": "<string>",
"approved": true,
"issues": [
123
]
}
],
"interceptions": {},
"verdict_summaries": [
{
"code": "<string>",
"conclusion": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
multipart/form-data
Type of task to run.
Example:
""
Input file(s) for the task. Set the Mime type to application/json when uploading JSON data, or text/plain when uploading text. For all other file types use appropriate Mime types.
Optional task-type specific configuration input as a JSON parseable string. (eg: the type of clinical test to authorize).
An optional external ID for this task.
Maximum string length:
1024Example:
""
An optional user-friendly task name. If none is specified, a task name will be created based on extracted medical information.
Example:
""
An optional HTTP or HTTPS callback template to be invoked when the Task's status finishes processing. The pattern {uuid} will be expanded to the task's UUID, and {external_id} will be expanded to the string "null" or the percent-encoded representation of the specified external id. A GET request will be issued.
Maximum string length:
2048Example:
""
Response
Successful Response
A unique ID for the Task.
A Task's type. Determines what kind of processing is performed on the input data.
Current state of a task.
pending: The task is waiting to be processed.processing: The task is currently being processed.waiting: The task is waiting for additional input.completed: The task has completed processing.failed: An error occurred while the task was being processed.invalid: The data uploaded does not provide any information pertaining to the task to be performed.deferred: The bulk processing task has been put into a deferred state due to high load
Available options:
pending, processing, waiting, completed, failed, invalid, deferred A user friendly name, based on information extracted from inputs.
cleared can be set to a timestamp indicating when follow-ups (work external to Synthpop) related to this Task have been completed. Initialized to null upon Task creation.
Timestamp indicating when this task was created.
Timestamp indicating when the latest status change for this task occurred. This indicates when a Task entered processing, waiting, completed or failed state. For pending tasks this is set to the same value as created.
Suggested task category, as determined by the medical records found.
- DataItemFile
- DataItemJSON
- DataItemText
Show child attributes
Show child attributes
issues
(TaskIssueGenericLLM · object | TaskIssueGenericLogic · object | TaskIssueGenericWarning · object | TaskIssueDataMissing · object | TaskIssueMissingRecord · object | TaskIssueIncorrectDocumentSequence · object | TaskIssueInconsistentData · object | TaskIssueExpired · object | MedicalRecordIssueDataMissing · object)[]
required
Issues detected with this task or any medical records of it.
A generic task issue reported by the LLM.
- TaskIssueGenericLLM
- TaskIssueGenericLogic
- TaskIssueGenericWarning
- TaskIssueDataMissing
- TaskIssueMissingRecord
- TaskIssueIncorrectDocumentSequence
- TaskIssueInconsistentData
- TaskIssueExpired
- MedicalRecordIssueDataMissing
Show child attributes
Show child attributes
An optional third party assigned ID for the task.
Maximum string length:
1024List of verdicts for the task.
Show child attributes
Show child attributes
Optional interception data including structured_data with pages-details.
Show child attributes
Show child attributes
Per-code referral-validation conclusion summaries.
Show child attributes
Show child attributes