Documentation
Doxtract API Endpoints
Get Templates
Endpoint
GET
https://api.soceton.com/doxtract/api/templatesParameters
| Name | Type | Location | Description |
|---|---|---|---|
skip | integer | query | Number of records to skip. Default: 0Minimum: 0 |
limit | integer | query | Maximum number of records to return. Default: 10Minimum: 1 Maximum: 100 |
x-api-key | string | null | header | API key. |
x-api-secret | string | null | header | API secret. |
Example Request
curl -X GET "https://api.soceton.com/doxtract/api/templates?skip=0&limit=10" \
-H "x-api-key: YOUR_API_KEY" \
-H "x-api-secret: YOUR_API_SECRET"Responses
200 - Successful Response
{
"total": int,
"skip": int,
"limit": int,
"data": []
}422 - Validation Error
{
"detail": [
{
"loc": ["string", 0],
"msg": "string",
"type": "string"
}
]
}Extract Data (Read)
Endpoint
POST
https://api.soceton.com/doxtract/api/readHeaders
| Name | Type | Location | Description |
|---|---|---|---|
x-api-key | string | null | header | API key for authentication |
x-api-secret | string | null | header | API secret for authentication |
Request Body
multipart/form-data| Field | Type | Required | Description |
|---|---|---|---|
files | array<string> | Required | Files to process |
data | string | Required | JSON configuration for extraction |
Example Request
curl -X POST "https://api.soceton.com/doxtract/api/read" \
-H "x-api-key: YOUR_API_KEY" \
-H "x-api-secret: YOUR_API_SECRET" \
-F "files=@sample.pdf" \
-F 'data={"template_id":"123"}'Responses
200 - Success
{
"success": True,
"job_id": "string",
"result": {}
}422 - Validation Error
{
"detail": [
{
"loc": ["string", 0],
"msg": "string",
"type": "string"
}
]
}Get Job Status
Endpoint
GET
https://api.soceton.com/doxtract/api/jobs/{job_id}Parameters
| Name | Type | Location | Description |
|---|---|---|---|
job_id | string | path | Unique job identifier |
x-api-key | string | null | header | API key for authentication |
x-api-secret | string | null | header | API secret for authentication |
Example Request
curl -X GET "https://api.soceton.com/doxtract/api/jobs/JOB_ID" \ -H "x-api-key: YOUR_API_KEY" \ -H "x-api-secret: YOUR_API_SECRET"
Responses
200 - Successful Response
{
"processed_pages": int,
"total_pages": int,
"status": string
}422 - Validation Error
{
"detail": [
{
"loc": ["string", 0],
"msg": "string",
"type": "string"
}
]
}Download Job Data
Endpoint
GET
https://api.soceton.com/doxtract/api/download/{job_id}Parameters
| Name | Type | Location | Description |
|---|---|---|---|
job_id | string | path | Unique job identifier |
x-api-key | string | null | header | API key used for authentication |
x-api-secret | string | null | header | API secret used for authentication |
Responses
200 - Successful Response
{
"url": string // download url (signed for 5 minutes)
}422 - Validation Error
{
"detail": [
{
"loc": ["string", 0],
"msg": "string",
"type": "string"
}
]
}