POST
/
api
/
v1
/
documents
/
ingest
/
url
curl --request POST \
  --url https://api.fieldwise.ai/api/v1/documents/ingest/url \
  --header 'Content-Type: application/json' \
  --data '{
  "external_id": "doc123",
  "metadata": {
    "category": "finance",
    "details": {
      "year": 2023
    },
    "tags": [
      "quarterly",
      "report"
    ]
  },
  "url": "https://example.com/document.pdf"
}'
{
  "success": true,
  "data": {
    "task_identifier": "<string>",
    "file_path": "<string>",
    "external_id": "<string>"
  },
  "error": {
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0"
  }
}

Headers

​
X-API-Key
string | null

Body

application/json

Request model for ingesting documents via URL.

​
url
string
required

URL of the document to ingest

​
metadata
object | null

Document metadata (must be primitive types, arrays, or nested objects)

​
external_id
string | null

External identifier

Maximum length: 255
​
extract_paragraphs
boolean
default:false

Whether to extract paragraphs and sentences from the document

Response

201
application/json
Successful Response
​
data
object
required

Response data

​
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