Demo companies API
Copies a prompt that lets an AI coding agent install Crow HR on your server with you.How it works
2 endpoints, generated from packages/core/openapi/v1.snapshot.json (OpenAPI 3.1.0, contract version 1.1). Conventions for lists, errors, money and authentication are on the API conventions page.
POST/api/v1/demo-companies
Start a private demo company: a copy of the fictional sample company, deleted at its expiry
Public. Hands out a ready copy or seeds one while the caller waits. Limited per network per hour and per day, and by the number of live demo companies: past a limit it answers 429 with `details.retryAt` and `Retry-After`. Nobody else is told the short name, which is the key to the copy.
Responses
201 Success. object
slugstringnamestringserverstringconnectUrlstringsignInUrlstringexpiresAtstring (date-time)
- 404
not_found - 429
rate_limited - 503
service_unavailable
GET/api/v1/demo-companies/config
Whether this server offers demo companies, and for how long one lasts (try page)
Responses
200 Success. object
ttlHoursintegermin -9007199254740991
serverstring
- 404
not_found