POST
/
api
/
v1
/
extractions
/
run
/
url
curl --request POST \
  --url https://api.fieldwise.ai/api/v1/extractions/run/url \
  --header 'Content-Type: application/json' \
  --data '{
  "extraction_id": 1,
  "url": "https://example.com/document.pdf"
}'
{
  "data": {
    "extraction_id": 1,
    "file_path": "org_123/extractions/file.pdf",
    "task_identifier": "RunExtraction:123e4567-e89b-12d3-a456-426614174000"
  }
}

Headers

X-API-Key
string | null

Body

application/json

Request model for running extractions via URL.

url
string
required

URL of the file to process

Minimum length: 1
extraction_id
integer
required

ID of the extraction to run

Response

201
application/json
Successful Response
data
object
required

Response data

Example:
{
  "extraction_id": 1,
  "file_path": "org_123/extractions/file.pdf",
  "task_identifier": "RunExtraction:123e4567-e89b-12d3-a456-426614174000"
}
success
boolean
default:true
error
object | null

Schema for API error responses.

Example:
{
  "error_code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found"
}
meta
object

Metadata for API responses