Emboss

Emboss Forms API

The Forms API from Emboss — 25 operation(s) for forms.

GitHub OpenAPI

Operations 27

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /forms/quote Quote the account price for processing a form · Account Quote #
Ask an LLM
“What would it cost my account to process this PDF before I commit?”
“Can I get a price quote for a form plus supporting context on my account?”
Tell an agent
Quote my account price for processing {file}.
Give me an account quote for {file} filled from context {context}.
POST /forms Upload a PDF and make it a fillable form · Create Form #
Ask an LLM
“How do I upload a PDF so Emboss detects its fields?”
“Can I create a form from a library catalogue entry instead of uploading a file?”
Tell an agent
Create a form from {file}.
Create a form from library entry {library} with retention {retention}.
GET /forms List my uploaded forms · List Forms #
Ask an LLM
“Which forms have I uploaded to my account?”
“Can I filter my forms by processing state, like only the ready ones?”
Tell an agent
List my forms.
Show my forms in state {states}, {limit} at a time.
GET /forms/{form_id} Get a form and its processing status · Get Form #
Ask an LLM
“Is my uploaded form done extracting yet?”
“What do I get back when I look up a single form?”
Tell an agent
Get form {form_id}.
Check whether form {form_id} is ready.
DELETE /forms/{form_id} Delete a form and its documents · Delete Form #
Ask an LLM
“How do I delete a form and its stored documents?”
“Why would deleting a form return a 409 conflict?”
Tell an agent destructive · confirm first
Delete form {form_id}.
Remove form {form_id} and all its documents.
GET /forms/{form_id}/contract Get a form's field contract · Get Contract #
Ask an LLM
“What fields does my form have and which are required?”
“Can I get the machine-readable field contract for a form?”
Tell an agent
Get the field contract for form {form_id}.
Show me the detected field schema of {form_id}.
GET /forms/{form_id}/fillable Download the fillable PDF of a form · Get Fillable #
Ask an LLM
“Where do I download the fillable version of a flat PDF I uploaded?”
“Can I get the PDF with fillable fields added back from a form?”
Tell an agent
Download the fillable PDF for form {form_id}.
Give me the blank fillable version of {form_id}.
GET /forms/{form_id}/thumbnail Get a form's thumbnail image · Get Thumbnail #
Ask an LLM
“Can I get a small preview image of one of my forms?”
“What does a form's first page look like as a thumbnail?”
Tell an agent
Fetch the thumbnail of form {form_id}.
Show a preview image for {form_id}.
POST /forms/with-context Upload a new PDF and fill it from context · Create With Context #
Ask an LLM
“Can I upload a blank form and have it filled from my supporting documents in one step?”
“How do I fill a library form from context without uploading the PDF myself?”
Tell an agent
Fill new PDF {file} using context {context}.
Fill library form {library} from {context} and call {callback_url} when done.
POST /forms/{form_id}/with-context Fill an existing form from context documents · Fill Existing With Context #
Ask an LLM
“How do I fill a form I already uploaded using new supporting documents?”
“Does refilling an existing form from context re-extract its fields or bill extraction again?”
Tell an agent
Fill my existing form {form_id} from {context}.
Fill existing form {form_id} from context with policy {policy}.
GET /forms/with-context/{job_id} Check a context-fill job's result · Get With Context #
Ask an LLM
“Has my fill-from-context job finished?”
“What did the context fill job produce?”
Tell an agent
Check context fill job {job_id}.
Get the result of with-context job {job_id}.
POST /forms/{form_id}/prepare Prepare a fill proposal for an existing form · Prepare Existing #
Ask an LLM
“Can I review proposed answers for a form I already uploaded before anything is rendered?”
“What's the difference between preparing a form and filling it directly?”
Tell an agent
Prepare a proposal for existing form {form_id} from {context}.
Draft proposed answers for form {form_id} without rendering a PDF.
POST /forms/prepare Upload a PDF and prepare a fill proposal · Prepare New #
Ask an LLM
“Can I upload a new PDF and get proposed answers to review in a single call?”
“How do I get a proposal for a brand new form from my context documents?”
Tell an agent
Extract {file} and prepare a proposal from {context}.
Upload new PDF {file} and draft answers for review.
POST /forms/{form_id}/verify Check whether a filled PDF is complete · Verify Filled Pdf #
Ask an LLM
“Is this filled PDF actually done, or are fields still missing?”
“Can I verify a form I filled by hand against its field contract?”
Tell an agent
Verify filled PDF {file} against form {form_id}.
Check if {file} completes every required field of {form_id}.
POST /forms/{form_id}/preview-fill Preview how a form would be filled · Preview Fill #
Ask an LLM
“Can I see what values would go into a form before filling it for real?”
“Can I lock certain fields when previewing a fill?”
Tell an agent
Preview filling form {form_id} from {context}.
Preview a fill of {form_id} keeping fields {locked} locked.
POST /forms/{form_id}/suggest-mapping Suggest spreadsheet columns for form fields · Suggest Mapping Endpoint #
Ask an LLM
“Which spreadsheet columns match which fields on my form?”
“Can Emboss guess the column mapping before I run a batch fill?”
Tell an agent
Suggest a column mapping from {file} to form {form_id}.
Match the columns in spreadsheet {file} to the fields of {form_id}.
POST /forms/{form_id}/fill-batch Batch-fill a form from a spreadsheet · Fill Batch #
Ask an LLM
“How do I fill one copy of a form for every row of a spreadsheet?”
“Am I billed per row when batch filling?”
Tell an agent
Batch fill form {form_id} from {file} using mapping {mapping}.
Generate a filled {form_id} for each row of {file} with column mapping {mapping}.
GET /forms/fill-batch/{batch_id} Check a batch fill's progress · Batch Status #
Ask an LLM
“How many rows of my batch fill are done?”
“Did any rows in my spreadsheet batch fail?”
Tell an agent
Check the status of batch {batch_id}.
Show row-by-row progress for batch fill {batch_id}.
GET /forms/fill-batch/{batch_id}/rows/{n}/pdf Download one row's PDF from a batch fill · Batch Row Pdf #
Ask an LLM
“Can I download the filled PDF for just one spreadsheet row?”
“Where is the output for a single row of a batch?”
Tell an agent
Download the PDF for row {n} of batch {batch_id}.
Get batch {batch_id}'s filled form for row number {n}.
GET /forms/fill-batch/{batch_id}/zip Download all batch-filled PDFs as a ZIP · Batch Zip #
Ask an LLM
“Can I download every filled PDF from a batch in one archive?”
“Is there a zip file of all my batch results?”
Tell an agent
Download the zip for batch {batch_id}.
Bundle every filled PDF from batch {batch_id} into one archive.
POST /forms/read Read values out of a filled PDF on my account · Read Form #
Ask an LLM
“Can I extract the answers from a filled PDF using my account key?”
“Will reading a filled PDF against one of my forms tell me if it's complete?”
Tell an agent
Read the field values from {file}.
Read {file} as a filled copy of my form {form_id}.
POST /pay/make-fillable Pay per use to make a flat PDF fillable · Turn a flat or scanned PDF form into a fillable PDF with detected fields #
Ask an LLM
“Can I turn a scanned PDF into a fillable form without an account by paying per use?”
“Does the pay-per-use make-fillable work on XFA or LiveCycle forms?”
Tell an agent
Pay to make {file} fillable.
Add fillable fields to the PDF at {pdf_url} on the pay door.
POST /pay/fill-with-context Pay per use to fill a PDF from documents · Fill a PDF form using facts found in supporting documents #
Ask an LLM
“Can I pay per use to pre-fill a government form from a resume or supporting paperwork?”
“Which context inputs can a paid fill-with-context accept: files, text or URLs?”
Tell an agent
Pay to fill {file} from context documents {context}.
Pay to fill the PDF at {pdf_url} using notes {context_text}.
POST /pay/fill Pay per use to fill a PDF from JSON values · Fill a PDF form from structured data such as JSON or key-value answers #
Ask an LLM
“Can I fill a PDF with answers I already have as JSON, paying per use?”
“What shape should the values be in for a paid structured fill?”
Tell an agent
Pay to fill {file} with values {values}.
Write the answers {values} into the PDF at {pdf_url} on the pay door.
POST /pay/read Pay per use to read a filled PDF into data · Read the values out of a filled PDF form, labelled by field, with a… #
Ask an LLM
“Can I turn a filled PDF into JSON without signing up, paying per use?”
“Does the paid read tell me whether a known form is complete?”
Tell an agent
Pay to read the answers out of {file}.
Extract field values from the filled PDF at {pdf_url} via the pay door.
POST /pay/fax Pay per page to fax a PDF · Send a PDF to a fax number and track delivery, priced per transmitted page #
Ask an LLM
“Can an agent fax a PDF to an agency and pay per transmitted page?”
“Is there a minimum charge when paying for a fax by card?”
Tell an agent
Pay to fax {file} to {to}.
Fax artifact {artifact_id} to {to} using artifact token {artifact_token}.
POST /pay/quote Get a free price check for a PDF · Free price check for a PDF #
Ask an LLM
“How much will each operation cost for this PDF before I pay?”
“Does the free quote tell me whether my PDF already has form fields?”
Tell an agent
Get a free price check for {file}.
Quote every operation's price for the PDF at {pdf_url} with context {context_text}.

Documentation

📖
Documentation
https://getemboss.ai/docs
📖
APIReference
https://getemboss.ai/docs/reference/create-form
📖
GettingStarted
https://getemboss.ai/docs/quickstart
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/authentication/getemboss-ai-authentication.yml
📖
Authentication
https://getemboss.ai/docs/authentication
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/rate-limits/getemboss-ai-rate-limits.yml
📖
Documentation
https://getemboss.ai/docs/pay-per-call
📖
Documentation
https://getemboss.ai/docs/pay-per-call/mpp
📖
Documentation
https://getemboss.ai/docs/pay-per-call/x402

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/openapi/getemboss-ai-forms-api-openapi.yml

Other Resources

🔗
Console
https://api.getemboss.ai/docs
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/scopes/getemboss-ai-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/conventions/getemboss-ai-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/conventions/getemboss-ai-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/errors/getemboss-ai-problem-types.yml
🔗
ErrorCatalog
https://getemboss.ai/docs/reference/errors
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/data-model/getemboss-ai-data-model.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/sandbox/getemboss-ai-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/asyncapi/getemboss-ai-callbacks.yml
🔗
Webhooks
https://getemboss.ai/docs/callbacks
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/llms/getemboss-ai-pay-llms.txt
🔗
LLMsTxt
https://api.getemboss.ai/pay/llms.txt
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/plans/getemboss-ai-plans-pricing.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/getemboss-ai:getemboss-ai-forms-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

getemboss-ai-forms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Getemboss Ai Forms API
  x-refined-note:
  - x-guidance differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Forms across 2 of this provider''s published API definitions: getemboss-ai-account-openapi.json, getemboss-ai-pay-per-call-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.getemboss.ai
tags:


# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/openapi/getemboss-ai-forms-api-openapi.yml