Emboss

Emboss Admin API

The Admin API from Emboss — 40 operation(s) for admin.

GitHub OpenAPI

Operations 43

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

GET /admin/account View an owner's account and retention default · Admin Get Account #
Ask an LLM
“What retention default will new forms inherit for this account owner?”
“Can an admin look up who an account owner is and their default retention policy?”
Tell an agent
Show the account details and retention default for owner {owner}.
Look up which retention policy new forms for {owner} will inherit.
PATCH /admin/account Change an owner's default retention policy · Admin Patch Account #
Ask an LLM
“How do I change the default retention policy for an account as an admin?”
“Does changing the account retention default affect forms that already exist?”
Tell an agent
Update the account default retention for owner {owner}.
Flip the retention default on {owner}'s account so future forms use the new policy.
GET /admin/usage View usage totals for an owner as admin · Admin Usage #
Ask an LLM
“Can an admin see the current usage summary for any account owner?”
“Where does the dashboard get a signed-in owner's usage totals?”
Tell an agent
Get the usage summary for owner {owner}.
Show me how much {owner} has used so far as an admin.
GET /admin/usage/detail Get an owner's detailed usage for a month · Admin Usage Detail #
Ask an LLM
“Can I see a detailed usage breakdown for one owner in a specific month?”
“Which month-level usage detail is available for an account?”
Tell an agent
Show detailed usage for owner {owner} in month {month}.
Pull the {month} usage detail for {owner}.
GET /admin/billing/breakdown Get an owner's billing breakdown for a month · Admin Billing Breakdown #
Ask an LLM
“What will an owner be billed for in a given month, line by line?”
“Can an admin see the billing breakdown for an account's month?”
Tell an agent
Show the billing breakdown for owner {owner} for {month}.
Break down {owner}'s charges for {month}.
GET /admin/forms List an owner's forms as admin · Admin Forms #
Ask an LLM
“Can an admin search through all the forms a particular owner has uploaded?”
“Is there paging when listing an owner's forms from the admin side?”
Tell an agent
List the forms owned by {owner}.
Search {owner}'s forms for {q}, returning {limit} at a time.
POST /admin/forms Upload a fillable form on behalf of an owner · Admin Create Form #
Ask an LLM
“How do I create a fillable form for a customer from the admin batch-fill page?”
“Can an admin upload a PDF as a new form billed to another owner?”
Tell an agent
Create a fillable form from {file} on behalf of owner {owner}.
Acting as {owner}, upload this PDF {file} as a new form.
GET /admin/forms/batch-runs List an owner's batch-fill runs · Admin Batch Runs #
Ask an LLM
“Which batch-fill runs has an owner kicked off?”
“Can an admin page through the history of spreadsheet batch fills for an account?”
Tell an agent
List the batch-fill runs for owner {owner}.
Show the last {limit} batch runs for {owner}.
GET /admin/forms/batch-counts Count an owner's batch-fill runs · Admin Batch Counts #
Ask an LLM
“How many batch fills has an owner run in total?”
“Is there a quick count of batch-fill runs per account?”
Tell an agent
Get the batch-fill counts for owner {owner}.
Tell me how many batch runs {owner} has.
GET /admin/layouts Review shared form layout reuse stats · Admin Layouts #
Ask an LLM
“Which shared form layouts get reused the most, and how many hits do they have?”
“Where can an operator spot layout rows with many loose matches and a low baseline?”
Tell an agent
Show the form layout reuse readout.
List the top {top} most-reused form layouts.
DELETE /admin/forms/{form_id} Delete an owner's form as admin · Admin Delete Form #
Ask an LLM
“Can an admin remove a form from someone else's account?”
“How do I delete a customer's form from the admin dashboard?”
Tell an agent destructive · confirm first
Delete form {form_id} belonging to {owner}.
As admin, remove {owner}'s form {form_id}.
GET /admin/forms/{form_id} Check a form's status on behalf of an owner · Admin Form Status #
Ask an LLM
“Can an admin poll the processing status of a customer's form?”
“Is an owner's uploaded form ready yet, from the admin view?”
Tell an agent
Check the status of form {form_id} for owner {owner}.
Acting as {owner}, poll whether form {form_id} is ready.
GET /admin/forms/{form_id}/thumbnail Get an owner's form thumbnail as admin · Admin Form Thumbnail #
Ask an LLM
“Can an admin fetch the preview image of a customer's form?”
“What does an owner's form look like as a thumbnail?”
Tell an agent
Fetch the thumbnail for form {form_id} owned by {owner}.
Show me a preview image of {owner}'s form {form_id}.
GET /admin/usage/trend Chart an owner's usage trend over days · Admin Usage Trend #
Ask an LLM
“How has an owner's usage changed day by day recently?”
“Can I see a usage trend for an account over the last N days?”
Tell an agent
Show the daily usage trend for owner {owner}.
Plot {owner}'s usage over the last {days} days.
GET /admin/usage/events List an owner's individual usage events · Admin Usage Events #
Ask an LLM
“Which individual billable events did an owner generate?”
“Can I filter an account's usage events by kind and time range?”
Tell an agent
List the usage events for owner {owner}.
Show {owner}'s {kinds} usage events in range {range}.
POST /admin/forms/with-context Start a context fill on behalf of an owner · Admin Create With Context #
Ask an LLM
“Can an admin fill a new PDF from supporting context and bill it to a customer?”
“Which admin call powers the /fill page for a given owner?”
Tell an agent
Acting as {owner}, fill PDF {file} using context {context}.
Start a with-context fill job of {file} for owner {owner}.
GET /admin/forms/with-context/{job_id} Check an owner's context-fill job status · Admin Context Status #
Ask an LLM
“Has an owner's context fill job finished yet?”
“Can an admin poll the progress of a with-context fill job?”
Tell an agent
Check the status of context-fill job {job_id} for {owner}.
Poll {owner}'s with-context job {job_id}.
POST /admin/forms/with-context/{job_id}/render Render an owner's context-fill job to PDF · Admin Context Render #
Ask an LLM
“How do I turn a finished context-fill job into a rendered PDF as admin?”
“Can an admin trigger rendering of a customer's context fill?”
Tell an agent
Render context-fill job {job_id} for owner {owner}.
Acting as {owner}, produce the filled PDF for job {job_id}.
GET /admin/forms/with-context/{job_id}/pdf Download an owner's context-filled PDF · Admin Context Pdf #
Ask an LLM
“Where can an admin download the PDF produced by a customer's context fill?”
“Can I fetch the rendered file from a with-context job for another owner?”
Tell an agent
Download the filled PDF from context job {job_id} for {owner}.
Get {owner}'s rendered PDF for job {job_id}.
POST /admin/forms/{form_id}/with-context Fill an owner's existing form from context · Admin Fill Existing #
Ask an LLM
“Can an admin fill a form a customer already uploaded using new context?”
“Does filling an existing form from context as admin bill the owner?”
Tell an agent
Fill {owner}'s existing form {form_id} from context {context}.
Acting as {owner}, run a context fill on ready form {form_id}.
GET /admin/web-token/limits Get the engine's upload limits · Admin Web Token Limits #
Ask an LLM
“What are the maximum upload limits for browser uploads?”
“Where does the website read the engine's file size limits from?”
Tell an agent
Show the current web upload limits.
Fetch the engine's upload limits for the website.
POST /admin/web-token Mint a short-lived browser upload token · Admin Mint Web Token #
Ask an LLM
“How does the signed-in browser get a token to upload directly to the owner routes?”
“How long does a minted web upload token last, and can it be refreshed?”
Tell an agent
Mint a 15-minute web upload token for owner {owner}.
Issue a browser direct-upload token for {owner}.
POST /admin/forms/{form_id}/suggest-mapping Suggest spreadsheet-to-field mapping for an owner · Admin Suggest Mapping #
Ask an LLM
“Can an admin get suggested column-to-field mappings for a customer's spreadsheet?”
“Is mapping suggestion metered when an admin acts on behalf of an owner?”
Tell an agent
Suggest how spreadsheet {file} maps to {owner}'s form {form_id}.
Acting as {owner}, propose column mappings for form {form_id} from {file}.
POST /admin/forms/{form_id}/fill-batch Batch-fill an owner's form from a spreadsheet · Admin Fill Batch #
Ask an LLM
“How do I batch fill a customer's form from a spreadsheet as admin?”
“Is each row billed when an admin runs a batch fill for an owner?”
Tell an agent
Batch fill {owner}'s form {form_id} from spreadsheet {file} using mapping {mapping}.
Acting as {owner}, fill one copy of form {form_id} per row in {file} with {mapping}.
GET /admin/forms/fill-batch/{batch_id} Check an owner's batch-fill progress · Admin Batch Status #
Ask an LLM
“How far along is a customer's batch fill?”
“Can an admin poll an owner's batch-fill status without being billed?”
Tell an agent
Check batch {batch_id} status for owner {owner}.
Poll {owner}'s batch fill {batch_id}.
GET /admin/forms/fill-batch/{batch_id}/zip Download an owner's batch-fill results as ZIP · Admin Batch Zip #
Ask an LLM
“Can an admin download all of a customer's batch-filled PDFs at once?”
“Where is the zip archive of an owner's batch fill?”
Tell an agent
Download the zip for batch {batch_id} owned by {owner}.
Get {owner}'s batch {batch_id} filled PDFs as one archive.
POST /admin/billing/setup-intent Start adding a payment method for an owner · Admin Billing Setup Intent #
Ask an LLM
“How do I begin saving a card on file for an account?”
“Can an admin create a billing setup intent for an owner?”
Tell an agent
Create a billing setup intent for owner {owner}.
Start payment method setup for {owner}.
GET /admin/billing/payment-method View an owner's saved payment method · Admin Billing Payment Method #
Ask an LLM
“Which payment method does an account currently have on file?”
“Does this owner have a card saved for billing?”
Tell an agent
Show the payment method on file for {owner}.
Check whether owner {owner} has a saved card.
GET /admin/billing/invoices List an owner's invoices · Admin Billing Invoices #
Ask an LLM
“What invoices has an account been sent?”
“Can an admin see an owner's past invoices?”
Tell an agent
List the invoices for owner {owner}.
Show me {owner}'s billing history invoices.
POST /admin/billing/confirm Confirm an owner's billing setup · Admin Billing Confirm #
Ask an LLM
“How do I finish attaching a payment method after the setup intent succeeds?”
“Is there a step to confirm an owner's billing once their card is added?”
Tell an agent
Confirm the billing setup for owner {owner}.
Finalize {owner}'s payment method after setup.
POST /admin/billing/run-invoicing Run the monthly invoicing for a period · Admin Run Invoicing #
Ask an LLM
“How do I run the monthly billing for all owners?”
“Can I preview invoicing with a dry run before charging anyone?”
Tell an agent
Run invoicing for period {period}.
Do a dry run of invoicing for {period} with dry_run {dry_run}.
POST /admin/nudges/run Run the hourly nudge emails and cleanup · Admin Run Nudges #
Ask an LLM
“Which owners would be emailed by the nudge run if I dry-run it?”
“What does the nightly maintenance tick purge besides sending nudges?”
Tell an agent
Run the nudge job now.
Dry-run the nudges for owner {owner} with dry_run {dry_run}.
POST /admin/retention/sweep Run the retention and fax cleanup sweep · Admin Retention Sweep #
Ask an LLM
“How are expired documents and stalled faxes cleaned up?”
“Can I see what the retention sweep would delete without touching anything?”
Tell an agent destructive · confirm first
Run the retention sweep.
Preview the retention sweep with dry_run {dry_run}, capped at {limit} items.
POST /admin/library/{slug}/store Store a fetched copy of a library form · Admin Library Store #
Ask an LLM
“How does the seed script upload a government form into the library catalogue?”
“Which fields does storing a library copy actually trust from the caller?”
Tell an agent
Store PDF {file} as library form {slug} with checksum {sha256}.
Save {file} as revision {revision} of library form {slug}, hash {sha256}.
POST /admin/library/check Run the weekly library freshness check · Admin Library Check #
Ask an LLM
“How do I check whether any catalogue forms have changed at their source?”
“Does the library freshness check change what is served?”
Tell an agent
Run the library freshness check.
Re-fetch every catalogue form and record whether its hash changed.
GET /admin/library List catalogue forms with revision and check status · Admin Library #
Ask an LLM
“Which library forms have never been seeded yet?”
“What is the active revision and last check result for each catalogue form?”
Tell an agent
Show every library catalogue form with its active revision.
List catalogue forms still waiting on a seed run.
GET /admin/library/misses See library searches that found nothing · Admin Library Misses #
Ask an LLM
“Which forms are people searching for that the library doesn't have?”
“What were the most frequent empty library searches recently?”
Tell an agent
List the library search misses, most frequent first.
Show library searches with no result over the last {days} days.
POST /admin/library/{slug}/accept Accept a changed library form revision · Admin Library Accept #
Ask an LLM
“How do I promote a changed government form to the active library revision?”
“Is the previous library revision kept when a new one is accepted?”
Tell an agent
Accept the changed version of library form {slug}.
Refetch {slug}, make it fillable and set it as the active revision.
GET /admin/oauth/pending/{pid} Look up a pending OAuth authorization · Pending #
Ask an LLM
“What client and scopes is a pending OAuth request asking for?”
“Can I inspect an OAuth authorization that is waiting for consent?”
Tell an agent
Show pending OAuth request {pid}.
Look up the details of the OAuth authorization awaiting consent, id {pid}.
POST /admin/oauth/consent Record a user's OAuth consent decision · Consent #
Ask an LLM
“How is a user's approve or deny decision on an OAuth app recorded?”
“Can a user deny a pending OAuth client from the consent screen?”
Tell an agent
Record decision {decision} from user {user_id} on OAuth request {req}.
Approve OAuth request {req} for user {user_id} with decision {decision}.
GET /admin/oauth/grants List a user's OAuth grants · Grants #
Ask an LLM
“Which connected apps has a user granted access to?”
“Can I see all OAuth grants for one user?”
Tell an agent
List the OAuth grants for user {user_id}.
Show which apps {user_id} has authorized.
GET /admin/oauth/clients List OAuth clients registered since a date · Clients Since #
Ask an LLM
“Which directories and gateways have registered as OAuth clients this week?”
“Can I see OAuth client registrations since a specific date for the acquisition report?”
Tell an agent
List OAuth clients registered in the last seven days.
Show OAuth client registrations since {since}.
DELETE /admin/oauth/grants/{gid} Revoke a user's OAuth grant · Revoke Grant #
Ask an LLM
“How do I disconnect an app a user previously authorized?”
“Can a single OAuth grant be revoked without affecting the user's other apps?”
Tell an agent destructive · confirm first
Revoke OAuth grant {gid} for user {user_id}.
Disconnect app grant {gid} from {user_id}'s account.

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-admin-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-admin-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-admin-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fast Admin API
  version: 0.1.0
security:
- bearer: []
- oauth2:
  - forms:read
  - forms:write
tags:


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