Skip to main content

Fine-Tune Form

Endpoint​

POST /v1/forms/fine-tune

Description​

Triggers a fine-tuning operation for a specific form. This step reprocesses the form using enhanced logic or newer models, improving field detection or layout interpretation accuracy.

The form can be identified either by its form_id or its form_url (or both). If fine_tune is omitted, it defaults to true.

Request​

Headers​

HeaderRequiredDescription
Authorization✓Bearer YOUR_API_KEY
Content-Type✓application/json

Body (JSON)​

{
  "form_id": "6864f06c952b853e44261119",
  "form_url": "https://your-example-url.pdf",
  "fine_tune": true
}

Response​

Success — 200 OK​

Returns the updated form metadata after fine-tuning.

{
    "id": "ft_c57b5036a3d34a069252acb44665abc7",
    "object": "fine_tune",
    "status": "started"
}

Error — 500 Internal Server Error​

Returned when an error occurs during the downstream fine-tuning process.

{
  "id": "error_7d7f52761e134352addbd1b406a15ba0",
  "created": "2024-06-19T13:41:47.499Z",
  "object": "error",
  "error_message": "Error during fine-tune."
}