Skip to content
Last updated

Get Started

Common questions about using the Anesya API.

Documents and processing

When should I use documents, parsing, or extract?

Answer

Use documents when you want a reusable stored file and a stable document ID.

Use parsing when you need to inspect the document itself through OCR output, markdown, pictures, or page-level status details.

Use extract when you already know the business structure you want and only need the final JSON result for one schema.

A common production flow is:

  1. upload a document
  2. create a parsing
  3. inspect the parsing if needed
  4. create an extract from that parsing

See Documents, Parsing, and Extract.

Can I send a public URL instead of uploading a file first?

Answer

Yes. Both parsing and extract support a public or pre-signed URL as input.

This is useful when your files already live in object storage or are generated by another system.

If the same file will be reused later, uploading it once through /v0/documents is usually cleaner because you then work with a stable internal document ID instead of an external URL that may expire.

Can I process multiple documents at once?

Answer

Parsing documents supports a documented URL-list input. If you send a list of public or pre-signed URLs to POST /v0/parsing, the API returns an array of parsing resources.

Extract does not document the same URL-list behavior. If you need one extract per file, the safe workflow is:

  1. create multiple parsings from the URL list
  2. poll each parsing
  3. create one extract per parsing

See Parsing.

Why does POST /v0/parsing sometimes return an array instead of one object?

Answer

Because the endpoint has two create behaviors:

  • one parsing object for one document input
  • an array of parsing objects when document is a list of URLs

This is a common integration mistake in no-code tools and coding agents. Your client should branch on the input format instead of assuming a single fixed response shape.

How do I reduce unnecessary processing?

Answer

The two main levers are:

  • reuse stored documents and existing parsings when possible
  • trim PDFs early with pdf_page_start and pdf_page_end during document upload

If you only need a few pages from a long PDF, trimming at upload time is often the simplest way to reduce downstream work for both parsing and extract.

See Documents and Credit usage.

Statuses and polling

Why is my result not ready immediately after creation?

Answer

Parsing and extract are asynchronous workflows. Creating the resource means the job has been accepted, not that the final output is ready.

After POST /v0/parsing or POST /v0/extract, poll the resource until it reaches a final status.

See API quickstart.

What does PARTIAL_FINISHED mean?

Answer

PARTIAL_FINISHED is a parsing status meaning the job completed but one or more pages failed.

It is not the same as FINISHED, and it is not a total failure either. Many workflows can still continue if the failed pages are not business-critical.

Before deciding what to do, inspect:

  • pages_total
  • pages_success
  • pages_failed
  • error

Which statuses should stop polling?

Answer

For parsing, stop when status is:

  • FINISHED
  • PARTIAL_FINISHED
  • ERROR

For extract, stop when status is:

  • FINISHED
  • ERROR

Anything else means the resource is still progressing.

Why does my extract fail when I pass a parsing ID?

Answer

The most common reason is that the parsing is not ready yet.

If you create an extract from a parsing, wait for the parsing to reach a usable final state first. In practice, that means FINISHED or, when your workflow tolerates it, PARTIAL_FINISHED.

See Extract.

Quality and debugging

How do I debug a poor extract result?

Answer

Start with the parsing, not the schema output.

Extract depends on parsing. If the document content is missing, badly OCRed, or only partially processed, the extract result will also be weak.

The safest debugging sequence is:

  1. retrieve the parsing
  2. inspect markdown_content, ocr_content, and page counters
  3. confirm the needed information is actually present
  4. only then review the schema and extract logic

See Parsing and Extract.

When should I enable picture descriptions or table verification?

Answer

Enable picture_description_enabled when image understanding matters to the workflow.

Enable table_verification_enabled when table accuracy matters more than keeping the request as simple as possible.

If your use case does not depend on those features, leave them disabled and keep the request minimal.

How do I trim a PDF before parsing or extract?

Answer

Use the query parameters on document creation:

  • pdf_page_start
  • pdf_page_end

This trims the PDF at upload time and stores only the selected page range as the document resource you reuse later.

See Documents.

Why does the document download endpoint return a redirect?

Answer

GET /v0/documents/{id}/download is documented as a 302 redirect.

That means your HTTP client must follow the redirect, or you must manually handle the returned location, to access the underlying file.

Billing and support

How are credits calculated?

Answer

Credits are calculated per page, according to the endpoint being used.

The documented base rates are:

  • parsing standard: 2 credits per page
  • extract: 3 credits per page
  • split: 2 credits per page
  • classify: 1 credit per page

See Credit usage.

How do I authenticate requests?

Answer

Send your API key in the X-API-Key header:

curl -X GET "https://api.anesya.app/v0/documents" \
  -H "X-API-Key: $ANESYA_API_KEY"

If the header is missing or invalid, the API returns 401 Unauthorized.

Where should I look when an API call fails?

Answer

Start with these three checks:

  1. the HTTP status code
  2. the error field on the resource when available
  3. the input type you sent, especially URL vs document ID vs parsing ID

See Error codes.

How do I contact support?

Answer

For API issues or product questions, contact support@anesya.app.


Still have questions?