---
title: "Read documents (photos, scans, PDFs, text) into this form: proposed values with evidence + confidence; signature/thumbmark photos routed to their fields. Costs 10 credits a call (live key; test keys free). Does not fill."
method: POST
path: "/api/v1/engine/ingest/{id}"
tags: ["Read"]
---

# Read documents (photos, scans, PDFs, text) into this form: proposed values with evidence + confidence; signature/thumbmark photos routed to their fields. Costs 10 credits a call (live key; test keys free). Does not fill.

`POST /api/v1/engine/ingest/{id}`

## Request

- Base URL: `https://philforms.com`
- URL: `https://philforms.com/api/v1/engine/ingest/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-PDFPhile-Embed`

## Path parameters

- `id` string, required

## Request body

- object
  - `media` object[], required
    - `type` 'image/png' | 'image/jpeg' | 'image/webp' | 'image/gif' | 'application/pdf' | 'text/plain', required
    - `data` string: base64 (images ≤5 MB, total ≤15 MB)
    - `text` string
    - `name` string

## Response `200`

{ data, evidence, confidence, image_field, rejected, note } — send `data` to /engine/fill after review

## Other responses

- `400`: Bad media
- `402`: The month cannot pay for it (10 credits) / free daily cap
- `403`: Reading is off for this site key
- `404`: Unknown form
- `503`: AI reading not configured on this server

---

[API](https://skmtc.dev/philforms/apis/philforms-api.md) · [All operations](https://skmtc.dev/philforms/apis/philforms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/philforms/apis/philforms-api/revisions/a43bf313729c?raw)