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= \
  --form uploads.items='@example-file'

import requests

url = "https://app.synthpop.ai/public/v1/task/create"

files = { "uploads.items": ("example-file", open("example-file", "rb")) }
payload = {
    "task_type": "",
    "request_spec": "{}",
    "external_id": "",
    "name": "",
    "callback_template": ""
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, 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', '');
form.append('uploads.items', '{
  "fileName": "example-file"
}');

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\r\nContent-Disposition: form-data; name=\"uploads.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\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\r\nContent-Disposition: form-data; name=\"uploads.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\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\r\nContent-Disposition: form-data; name=\"uploads.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\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\r\nContent-Disposition: form-data; name=\"uploads.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_type": "<string>",
  "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": "<string>",
      "tag": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "data_type": "<string>",
      "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": {}
    }
  ]
}

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= \
  --form uploads.items='@example-file'

import requests

url = "https://app.synthpop.ai/public/v1/task/create"

files = { "uploads.items": ("example-file", open("example-file", "rb")) }
payload = {
    "task_type": "",
    "request_spec": "{}",
    "external_id": "",
    "name": "",
    "callback_template": ""
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, 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', '');
form.append('uploads.items', '{
  "fileName": "example-file"
}');

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\r\nContent-Disposition: form-data; name=\"uploads.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\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\r\nContent-Disposition: form-data; name=\"uploads.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\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\r\nContent-Disposition: form-data; name=\"uploads.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\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\r\nContent-Disposition: form-data; name=\"uploads.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_type": "<string>",
  "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": "<string>",
      "tag": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "data_type": "<string>",
      "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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

task_type

string

required

Type of task to run.

Example:

""

uploads

file[]

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.

request_spec

any

default:{}

Optional task-type specific configuration input as a JSON parseable string. (eg: the type of clinical test to authorize).

external_id

string | null

An optional external ID for this task.

Maximum string length: 1024

Example:

""

name

string | null

An optional user-friendly task name. If none is specified, a task name will be created based on extracted medical information.

Example:

""

callback_template

string | null

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: 2048

Example:

""

Response

Successful Response

uuid

string<uuid>

required

A unique ID for the Task.

task_type

string

required

A Task's type. Determines what kind of processing is performed on the input data.

status

enum<string>

required

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

name

string

required

A user friendly name, based on information extracted from inputs.

cleared

string<date-time> | null

required

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.

created

string<date-time>

required

Timestamp indicating when this task was created.

latest_status_change

string<date-time>

required

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.

Overview

Endpoints

Create a New Task.

Authorizations

Body

Response