Ingest Document From 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"
}
'import requests
url = "https://api.fieldwise.ai/api/v1/documents/ingest/url"
payload = {
"external_id": "doc123",
"metadata": {
"category": "finance",
"details": { "year": 2023 },
"tags": ["quarterly", "report"]
},
"url": "https://example.com/document.pdf"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_id: 'doc123',
metadata: {category: 'finance', details: {year: 2023}, tags: ['quarterly', 'report']},
url: 'https://example.com/document.pdf'
})
};
fetch('https://api.fieldwise.ai/api/v1/documents/ingest/url', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fieldwise.ai/api/v1/documents/ingest/url",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_id' => 'doc123',
'metadata' => [
'category' => 'finance',
'details' => [
'year' => 2023
],
'tags' => [
'quarterly',
'report'
]
],
'url' => 'https://example.com/document.pdf'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fieldwise.ai/api/v1/documents/ingest/url"
payload := strings.NewReader("{\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"category\": \"finance\",\n \"details\": {\n \"year\": 2023\n },\n \"tags\": [\n \"quarterly\",\n \"report\"\n ]\n },\n \"url\": \"https://example.com/document.pdf\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fieldwise.ai/api/v1/documents/ingest/url")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"category\": \"finance\",\n \"details\": {\n \"year\": 2023\n },\n \"tags\": [\n \"quarterly\",\n \"report\"\n ]\n },\n \"url\": \"https://example.com/document.pdf\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fieldwise.ai/api/v1/documents/ingest/url")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"category\": \"finance\",\n \"details\": {\n \"year\": 2023\n },\n \"tags\": [\n \"quarterly\",\n \"report\"\n ]\n },\n \"url\": \"https://example.com/document.pdf\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"task_identifier": "<string>",
"file_path": "<string>",
"external_id": "<string>"
},
"success": true,
"error": {
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"version": "1.0"
}
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}Documents
Ingest Document From Url
Ingest a document from a URL.
POST
/
api
/
v1
/
documents
/
ingest
/
url
Ingest Document From 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"
}
'import requests
url = "https://api.fieldwise.ai/api/v1/documents/ingest/url"
payload = {
"external_id": "doc123",
"metadata": {
"category": "finance",
"details": { "year": 2023 },
"tags": ["quarterly", "report"]
},
"url": "https://example.com/document.pdf"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_id: 'doc123',
metadata: {category: 'finance', details: {year: 2023}, tags: ['quarterly', 'report']},
url: 'https://example.com/document.pdf'
})
};
fetch('https://api.fieldwise.ai/api/v1/documents/ingest/url', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fieldwise.ai/api/v1/documents/ingest/url",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_id' => 'doc123',
'metadata' => [
'category' => 'finance',
'details' => [
'year' => 2023
],
'tags' => [
'quarterly',
'report'
]
],
'url' => 'https://example.com/document.pdf'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fieldwise.ai/api/v1/documents/ingest/url"
payload := strings.NewReader("{\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"category\": \"finance\",\n \"details\": {\n \"year\": 2023\n },\n \"tags\": [\n \"quarterly\",\n \"report\"\n ]\n },\n \"url\": \"https://example.com/document.pdf\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fieldwise.ai/api/v1/documents/ingest/url")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"category\": \"finance\",\n \"details\": {\n \"year\": 2023\n },\n \"tags\": [\n \"quarterly\",\n \"report\"\n ]\n },\n \"url\": \"https://example.com/document.pdf\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fieldwise.ai/api/v1/documents/ingest/url")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_id\": \"doc123\",\n \"metadata\": {\n \"category\": \"finance\",\n \"details\": {\n \"year\": 2023\n },\n \"tags\": [\n \"quarterly\",\n \"report\"\n ]\n },\n \"url\": \"https://example.com/document.pdf\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"task_identifier": "<string>",
"file_path": "<string>",
"external_id": "<string>"
},
"success": true,
"error": {
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"version": "1.0"
}
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}Authorizations
Headers
Body
application/json
Response
Successful Response
Response data
Show child attributes
Show child attributes
Schema for API error responses.
Show child attributes
Show child attributes
Example:
{
"error_code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}
Metadata for API responses
Show child attributes
Show child attributes
⌘I