The IndexDocs

Docs

What every service shares: the address, the key, the upload, the bill, the errors and the limits. What each one takes and returns is on its own page, and /openapi.json says the same for software.

Status

Formula is open now, with no key, at its own address on that page. The project services, Count, Tagged PDF, Web page, Report and All of it, are open to anyone with a key. To get one, sign up free at intex.university/signup and confirm the email, then make your keys and add credit on the API page of your portal, app.intex.university/api-keys. Count costs nothing, so it needs no credit.

The address

https://api.intex.institute/v1/SERVICE

Every project service is a POST to its own path under that address: /v1/count, /v1/pdf, /v1/page, /v1/report and /v1/all.

The key

Every request carries your key in a header:

Authorization: Bearer YOUR_KEY

Keys are made on your portal's API page, up to five at a time, and each is shown once, when it is made: we keep only a fingerprint of it. Keep it out of web pages and public code. Anyone who holds it can spend your credit; if one leaks, revoke it on that page and make another.

Sending a project

A form upload (multipart/form-data) with two fields:

FieldWhat goes in it
projectThe project as one .zip or .tar.gz, up to 64 MB: the .tex files, figures, bibliography and any class or style files of your own, as you would build it today. Nothing needs to be rewritten first.
mainOptional. The path of the main .tex file inside the archive. Without it, the main file is found for you, and a project with more than one is answered with a 422 that names them.

Or send the archive itself as the body, as application/zip or application/gzip, with ?main= in the address when it is needed.

PNG and JPEG figures are placed as they are. A figure in PDF, EPS or SVG is answered, for now, with a 422 that names it: save it as a PNG of the same name beside it. Count takes every kind. A .bib or a .bbl both work for the bibliography.

What is billed

Pages: the pages of the PDF your project makes, the same count Count returns for free. Every response to a key says what it cost and what is left in its Intex-Pages, Intex-Cost-Cents and Intex-Credit-Cents headers. A project that cannot be built costs nothing.

ServicePrice
FormulaFree without a key, thirty formulas every ten minutes; with a key, $1 per 1,000
CountFree
Tagged PDF6¢ a page
Web page4¢ a page
Report3¢ a page
All of it: the PDF, the page, the report and an archival copy10¢ a page

Credit is bought ahead: by card on your portal's API page, from $10 to $250 at a time, or by invoice through team@intex.university. Each request takes its cost from it. One your credit cannot cover is answered with a 402 that says both amounts, and costs nothing.

Errors

Every error comes back as JSON with a sentence a person can act on, and, when the trouble is in your source, its place:

{"ok": false, "error": "This '{' is never closed.", "file": "lecture-04.tex", "line": 42}
StatusWhen
400The request is not a project upload: not a form with project, nor a .zip or .tar.gz.
401The key is missing, revoked, or not one of ours.
402The credit on the key's account will not cover this project. Nothing was charged.
403The key's account may not use the API.
413The upload is over 64 MB.
422The project cannot be built, goes past a limit, or needs main. The sentence and the place say why. Nothing was charged.
429More than thirty requests in ten minutes on one key. Wait the seconds in Retry-After.
503The service is paused, or every build slot is busy. Wait the seconds in Retry-After.

Limits

  • One project a request, up to 1,000 pages; thirty requests every ten minutes on one key.
  • A request is answered while you wait. One that runs past five minutes is stopped, answered with the reason, and costs nothing.
  • A project is built on its own and can read nothing outside itself.

Your files

They are read where they arrive, kept only while your request is answered, and deleted the moment the response leaves us. We keep the count of pages, for the bill, and nothing of what was on them.

For agents

What it leaves to you

The services do what software can check, and say plainly where a person is needed. If you want that person to be one of ours, reading every page before it goes to your students, Intex for universities does it at five dollars a page.