POST
/
api
/
v1
/
documents
/
ingest
/
url
curl --request POST \
  --url https://api.fieldwise.ai/api/v1/documents/ingest/url \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --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"
  }
}

Authorizations

X-API-Key
string
header
required

Headers

X-API-Key
string | null

Body

application/json

Request model for ingesting documents via URL.

Response

201
application/json

Successful Response

The response is of type object.