Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/mauroperez055/infoJobs/llms.txt

Use this file to discover all available pages before exploring further.

The InfoJobs DevBoard REST API is an Express-based service that exposes job listing data and AI-powered summaries. It is consumed by the React frontend and can be used directly via any HTTP client. All endpoints follow REST conventions, exchange JSON bodies, and respond with consistent error shapes.

Base URL

http://localhost:1234

Authentication

The current API has no authentication. All endpoints are publicly accessible without any token or API key. A JWT-based authentication layer is a planned future feature and is not yet implemented.

Content Type

Requests that include a body (POST, PUT, PATCH) must set the Content-Type header to application/json. All responses are returned as application/json unless otherwise noted — the AI summary endpoint (GET /ai/summary/:id) streams its response as text/plain; charset=utf-8.

Error Format

When a request fails, the API returns a JSON object with a human-readable error field. Zod validation failures additionally include a details array containing the individual field-level errors produced by the schema parser.
{
  "error": "Human-readable error message",
  "details": [...] 
}
Common HTTP status codes returned by the API:
CodeMeaning
200Success
201Resource created
400Validation error (bad request body)
404Resource not found
429Rate limit exceeded
500Internal server error

Pagination

The GET /jobs endpoint supports cursor-free pagination via limit and offset query parameters. If omitted, limit defaults to 10 and offset defaults to 0. Every paginated response includes a total field reflecting the number of records that matched the applied filters — not the number of records in the current page.
GET /jobs?limit=20&offset=40

Endpoints

GET /jobs

List and filter all job listings with pagination support.

GET /jobs/:id

Retrieve a single job listing by its UUID.

POST /jobs

Create a new job listing with Zod-validated input.

PUT and PATCH /jobs/:id

Fully replace or partially update an existing job listing.

DELETE /jobs/:id

Remove a job listing by UUID and receive the deleted record.

GET /ai/summary/:id

Stream an AI-generated job summary via Ollama.

Build docs developers (and LLMs) love