POST
/
api
/
v1
/
documents
/
ingest
Ingest Document
curl --request POST \
  --url https://api.fieldwise.ai/api/v1/documents/ingest \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'external_id=<string>' \
  --form 'metadata=<string>' \
  --form file=@example-file
{
  "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

multipart/form-data
file
file
required
external_id
string | null
metadata
string | null

Response

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