canonical: https://jentic.com/apis/paraio.com/main

# Paraio Para API

Jentic publishes the only available OpenAPI specification for Para API, keeping it validated and agent-ready. Para is an open-source backend framework providing RESTful API endpoints for CRUD operations, full-text search, user management, and social sign-in. It powers backend infrastructure for web and mobile applications with flexible object storage, authentication, and search capabilities.

## For AI agents

Manage backend objects, authentication, and search across 8 endpoints with flexible object types.

## Scope

Does not handle file storage, real-time synchronization, or cloud functions - use for RESTful object CRUD, search, and JWT authentication only.

## Capabilities

- Sign in and obtain JWT authentication tokens
- Create objects of any custom type
- List objects by type with sorting and pagination
- Read, update, and delete objects by ID
- Search objects with query parameters
- Manage user authentication and sessions

## Use cases

### JWT Authentication

Authenticate with the Para API and obtain JWT access tokens. POST /jwt_auth accepts appid, provider, and token parameters, returning a JWT object with access_token, expires, and refresh timestamps. Essential for securing API access and managing user sessions.

Example prompt: POST /jwt_auth with appid, provider, and token to obtain JWT access_token

### Flexible Object CRUD

Create, read, update, and delete objects of any custom type. POST /{type} creates objects, GET /{type}/{id} reads them, PATCH /{type}/{id} updates, and DELETE /{type}/{id} removes. The type parameter supports any custom object schema (users, posts, comments, etc).

Example prompt: POST /{type} to create, GET /{type}/{id} to read, PATCH to update, DELETE to remove objects

### Object Listing with Pagination

List objects by type with sorting, pagination, and descending order. GET /{type} accepts sort, desc, limit, and page query parameters, returning ObjectListResponse with items array and totalHits. Essential for browsing and displaying object collections.

Example prompt: GET /{type}?sort=timestamp&desc=true&limit=50&page=1 for sorted, paginated results

### Object Search

Search objects across types with query parameters. GET /search accepts q (query string) and type parameters for targeted searches, returning matched objects with relevance scoring. Enables full-text search across the backend object store.

Example prompt: GET /search?q=keyword&type=posts to search posts matching keyword

### Agent-Driven Backend Operations via Jentic

An AI agent managing backend infrastructure can create objects, search data, and handle authentication through Jentic without exposing JWT tokens or credentials in agent context. Jentic resolves intents like 'create a user object' to the right Para endpoint.

Example prompt: Search Jentic for 'create backend object', load the POST /{type} schema, and execute

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /jwt_auth | Sign in and obtain JWT token |
| GET | /{type} | List objects by type |
| POST | /{type} | Create a new object |
| GET | /{type}/{id} | Read an object by ID |
| PATCH | /{type}/{id} | Update an object |
| DELETE | /{type}/{id} | Delete an object |
| GET | /search | Search objects |
| GET | /_me | Get current user profile |

## Key resources

- **ParaObject** — Flexible object with custom type and properties
- **JWT** — JWT authentication token with expiry and refresh

## Why Jentic

- **Setup:** Wiring the Para API by hand means obtaining a JWT through /jwt_auth, carrying it as a bearer token, and shaping the generic /{type} object routes yourself. Through Jentic you install once, import Para from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Para puts the object type and id in the URL path (/{type}/{id}), so a rule can pin your agent to one object type: it can create, read, and search those objects. You choose the operations it may call, so destructive ones like object deletion are not included unless you add them.
- **Credential handling:** Your Para JWT is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a backend object' or 'search objects by type', and Jentic returns the matching Para operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Firebase API** — Google's backend-as-a-service with real-time database, authentication, and cloud functions
- **Supabase API** — Open-source Firebase alternative with PostgreSQL, authentication, and real-time subscriptions

## FAQ

### Why is there no official OpenAPI spec for Para API?

Para is open-source but does not publish a complete OpenAPI specification for their REST API. Jentic generates and maintains this spec so that AI agents and developers can call Para API via structured tooling. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Para API use?

Para API uses JWT bearer token authentication. POST /jwt_auth returns an access_token that must be included in the Authorization header for subsequent requests. Through Jentic, tokens are stored in the encrypted vault and injected at execution time.

### Can I use custom object types?

Yes. The {type} path parameter accepts any custom object type (users, posts, comments, products, etc). Para stores and indexes objects flexibly, allowing you to define your own schemas and relationships.

### How does pagination work?

GET /{type} accepts limit (number of results) and page (page number) query parameters. The response includes totalHits for calculating total pages. Use sort and desc parameters to control ordering.

### Does Para support full-text search?

Yes. GET /search accepts a q (query string) parameter for full-text search across object fields. Optionally specify type to limit search to specific object types. Results include relevance scoring.

### Is Para open-source?

Yes. Para is an open-source backend framework that can be self-hosted or used as a hosted service. The API works identically regardless of deployment model, making it suitable for both development and production.

### Can I limit what my agent is allowed to do with the Para API?

Yes. Because you run Jentic One yourself, your own rules decide which Para operations and credentials the agent may use. Since Para puts the object type and id in the URL path (/{type}/{id}), a rule can pin the agent to a single object type and to specific operations, so it can create, read, list, and search those objects without touching others. Destructive calls like DELETE /{type}/{id} stay out of reach unless you explicitly grant them.
