Documents
- POSTIngest Document
- POSTIngest Document From Url
- POSTIngest Document From Embedding
- POSTGet Document Answer
- POSTList Documents
- POSTSearch document pages (deprecated)
- POSTSearch Document Pages
- POSTSearch Document Paragraphs
- POSTSearch Document Sentences
- GETGet Document By External Id
- GETGet Document By Id
- DELDelete Document By Id
- GETGet Document By Task Id
- POSTPreview Delete By Metadata
- POSTDelete Documents By Metadata
Content
Extractions
Tasks
Documents
Ingest Document From Url
Ingest a document from a URL.
POST
/
api
/
v1
/
documents
/
ingest
/
url
Copy
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"
}'
Copy
{
"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
Headers
Body
application/json
Request model for ingesting documents via URL.
Response
201
application/json
Successful Response
The response is of type object
.
Copy
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"
}'
Copy
{
"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"
}
}
Assistant
Responses are generated using AI and may contain mistakes.