API/Text to Json

Transform Text to JSON

Transforms unstructured text into structured JSON according to a provided schema. This utility endpoint extracts specific data patterns from free-form content.

POSThttps://api.sully.aihttps://api-testing.sully.ai/v1/utils/text-to-jsonTry itcURLPythonJavaScriptPHPGoJavaCopy

curl --request POST \
  --url https://api.sully.ai/v1/utils/text-to-json \
  --header 'Content-Type: application/json' \
  --header 'X-ACCOUNT-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "text": "Patient is a 45-year-old male presenting with chest pain...",
  "schema": {
    "type": "object",
    "properties": {
      "patientInfo": {
        "type": "object",
        "properties": {
          "age": {
            "type": "number"
          },
          "gender": {
            "type": "string"
          },
          "allergies": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "age",
          "gender",
          "allergies"
        ]
      },
      "symptoms": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "diagnosis": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "severityLevel": {
        "type": "string",
        "enum": [
          "mild",
          "moderate",
          "severe",
          "critical"
        ]
      },
      "notes": {
        "type": [
          "string",
          "null"
        ],
        "description": "Optional clinical notes that might be null"
      }
    },
    "required": [
      "patientInfo",
      "symptoms",
      "diagnosis",
      "severityLevel",
      "notes"
    ]
  }
}'

200400500Copy

{
  "data": {
    "patientInfo": {
      "age": 45,
      "gender": "male",
      "allergies": null
    },
    "symptoms": [
      "chest pain"
    ],
    "diagnosis": [],
    "severityLevel": "moderate",
    "notes": null
  }
}

Authorizations

X-API-KEYstringheaderrequiredX-ACCOUNT-IDstringheaderrequired

Body

application/json

Text and schema for transformation

Request payload for transforming unstructured text into structured JSON

textstringrequired

Unstructured text to transform

Example:

"Patient is a 45-year-old male presenting with chest pain..."

schemaobjectrequired

JSON Schema for transforming text into structured data

Example:

{
  "type": "object",
  "properties": {
    "patientInfo": {
      "type": "object",
      "properties": {
        "age": { "type": "number" },
        "gender": { "type": "string" },
        "allergies": {
          "type": ["array", "null"],
          "items": { "type": "string" }
        }
      },
      "required": ["age", "gender", "allergies"]
    },
    "symptoms": {
      "type": "array",
      "items": { "type": "string" }
    },
    "diagnosis": {
      "type": "array",
      "items": { "type": "string" }
    },
    "severityLevel": {
      "type": "string",
      "enum": ["mild", "moderate", "severe", "critical"]
    },
    "notes": {
      "type": ["string", "null"],
      "description": "Optional clinical notes that might be null"
    }
  },
  "required": [
    "patientInfo",
    "symptoms",
    "diagnosis",
    "severityLevel",
    "notes"
  ]
}

Response

204 application/json

JSON data extracted from text

Response containing the structured JSON data extracted from text

data object

Extracted structured data that conforms to the provided schema

Example:

{
  "patientInfo": {
    "age": 45,
    "gender": "male",
    "allergies": null
  },
  "symptoms": ["chest pain"],
  "diagnosis": [],
  "severityLevel": "moderate",
  "notes": null
}

Last updated