FieldwiseAI - API Documentation

Get Extraction Result By Id

curl --request GET \
  --url https://api.fieldwise.ai/api/v1/extractions/results/internal/{result_id} \
  --header 'X-API-Key: <api-key>'

{
  "data": {
    "created_at": "2024-03-21T12:00:00Z",
    "extraction_document_id": 1,
    "extraction_id": 1,
    "id": 1,
    "results": [
      {
        "extracted_field": "value"
      }
    ],
    "task_identifier": "RunExtraction:123e4567-e89b-12d3-a456-426614174000"
  }
}

GET

api

extractions

results

internal

{result_id}

Get Extraction Result By Id

curl --request GET \
  --url https://api.fieldwise.ai/api/v1/extractions/results/internal/{result_id} \
  --header 'X-API-Key: <api-key>'

{
  "data": {
    "created_at": "2024-03-21T12:00:00Z",
    "extraction_document_id": 1,
    "extraction_id": 1,
    "id": 1,
    "results": [
      {
        "extracted_field": "value"
      }
    ],
    "task_identifier": "RunExtraction:123e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

X-API-Key

string

header

required

Headers

X-API-Key

string | null

Path Parameters

result_id

integer

required

Response

Successful Response

data

ExtractionResultData · object

required

Response data

Show child attributes

Example:

{
  "created_at": "2024-03-21T12:00:00Z",
  "extraction_document_id": 1,
  "extraction_id": 1,
  "id": 1,
  "results": [{ "extracted_field": "value" }],
  "task_identifier": "RunExtraction:123e4567-e89b-12d3-a456-426614174000"
}

success

boolean

default:true

error

ErrorDetail · object

Schema for API error responses.

Show child attributes

Example:

{
  "error_code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found"
}