For AI agents

Read the docs. Act only when asked.

Everything public on this site is open to agents and crawlers. The docs come as Markdown and JSON, so you don't need to scrape the pages. With a token from the customer, you can also open and follow their support requests.

Read without a key

/llms.txt: what the product is, the key facts and links to everything else.
/llms-full.txt: every lesson, the feature index and recent releases in one file.
/docs.md, /docs/<slug>.md and /docs/lab/<slug>.md: each docs page and Lab explainer as Markdown.
/api/agent/v1: the JSON API, described in OpenAPI.
Release notes feed and the sitemap.

Every feature carries a status. Available means it is in the paid Agent today. In review means it is in the next desktop release. Lab means it appears in demos and is not for sale. Please keep that distinction when you answer questions about ParaCrux.

Method	Path	Returns
`GET`	`/docs`	Tracks and lesson cards. Filter with track, level or q.
`GET`	`/docs/{slug}`	One lesson: steps, limits, what you need. Add ?format=markdown for Markdown.
`GET`	`/features`	Every published feature with its status. Filter with status, track or q.
`GET`	`/search?q=`	Lessons and features that contain every term.

Act for a customer

Support routes need a support token from the customer. It works like this:

The customer signs in, opens Support in their dashboard, chooses Connect a computer or agent and creates a code labelled after you.
They give you the code, which starts PCXS1.. Use it within 15 minutes. After the first use it stays valid until they remove it.
Send it on every support call as Authorization: Bearer PCXS1.….

A support token only reaches that customer's support requests. It cannot see licences, seats, billing or activation codes, and it cannot act as a seat.

Method	Path	Does
`GET`	`/me`	Checks the token and shows the account's licence status.
`GET`	`/tickets`	The customer's tickets, 25 per page.
`POST`	`/tickets`	Opens a ticket: subject, message, and an optional category and product (solidworks-connector by default, or paracrux, scene-agent, website, other).
`GET`	`/tickets/{id}`	One ticket with its public messages.
`POST`	`/tickets/{id}/reply`	Adds a message.
`POST`	`/tickets/{id}/human`	Asks for a person. Also reopen and resolve.
`POST`	`/feedback`	A suggestion or a docs correction, filed as a ticket.

curl -X POST https://paracrux.com/api/agent/v1/tickets \
  -H "Authorization: Bearer PCXS1.…" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2a9e-activation-question" \
  -d '{"subject":"Activation code not accepted","category":"activation",
       "message":"The desktop app says the code has expired. Version 0.1.9, Windows 11."}'

The reply includes the ticket and its reference. Support replies show up in GET /tickets/{id}, and the customer also sees them in their dashboard and desktop app.

Rules and limits

Act only for the customer whose token you hold, and only on their instruction.
Don't send passwords, activation codes, payment details or confidential model files. Text that looks like a credential is removed before it is stored.
Send an Idempotency-Key header, 16–100 letters, digits, - or _, with every POST. A retry with the same key returns the first result. Without one, the same request on the same day counts as a retry.
Each account can open 5 tickets an hour and 20 a day, and send 30 messages an hour. Over the limit you get HTTP 429.
Call the API from your server or agent runtime. Support routes refuse cross-origin browser requests. The docs routes are open to any origin.
An assistant may prepare support replies. Those replies are labelled automated, and the customer can always ask for a person.
Errors are always {"error": "…"}, in plain English, with a real HTTP status.

Questions

Email support@paracrux.com. If you build an integration, tell us what you need next.