Forms API overview - Sylvian AI

Use the Forms API to parse PDFs, fill forms from natural-language instructions, and download completed documents.

Base URL

Use your deployed API host: https://api.sylvian.ai

Authentication

Protected endpoints require:

X-API-Key: forms_sk_...

Core workflow

Call POST /parse with a PDF file.
Poll GET /parse/{job_id} until status = succeeded.
Call POST /fill with the parsed file_id and your prompt.
Poll GET /fill/{job_id} until status = succeeded.
Download from the returned download_url.

This API is asynchronous by design. Write clients to submit work, poll status, then continue once a job succeeds.

Parse example

curl -X POST "https://api.sylvian.ai/parse" \
  -H "X-API-Key: forms_sk_your_key" \
  -F "file=@sample.pdf"

Fill example

curl -X POST "https://api.sylvian.ai/fill" \
  -H "X-API-Key: forms_sk_your_key" \
  -F "file_id=<parsed-file-id>" \
  -F "prompt=Fill in the customer name, date, and signature fields."

Endpoints

OpenAPI-backed schemas from openapi.json keep request and response structures in sync with the live API.

GET /
POST /parse
GET /parse/{job_id}
POST /fill
GET /fill/{job_id}
GET /download/{token}