Skip to main content
POST
/
v1
/
documents
/
upload-document-url
Upload Document From Url
curl --request POST \
  --url https://api.simplicity.ai/v1/documents/upload-document-url \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>"
}
'
{
  "task_id": "<string>",
  "status": "processing"
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
document_type
enum<string> | null
default:SOURCE_DOCUMENT

Set to FORM_DOCUMENT for the PDF form to fill, or SOURCE_DOCUMENT for knowledge or reference files—including images. Classifies an uploaded document for the form-filling workflow.

  • FORM_DOCUMENT — The PDF form to be filled. Use this for the actual application, intake, or questionnaire file the AI should complete. Only PDF is supported for form documents.

  • SOURCE_DOCUMENT — Supporting material used as context when filling a form: PDFs, images (for example photos of IDs or receipts), and other reference files (policies, prior submissions, spreadsheets, notes). This is the default when the parameter is omitted. Upload multiple source documents and reference them when creating or autofilling a form alongside a FORM_DOCUMENT.

Available options:
FORM_DOCUMENT,
SOURCE_DOCUMENT

Body

application/json
​
url
string<uri>
required
Required string length: 1 - 2083

Response

Successful Response

​
task_id
string
required
​
status
enum<string>
default:processing
required
Available options:
pending,
processing,
completed,
failed