canonical: https://jentic.com/apis/swaggerhub.pailkun/config-api

# Pailkun Config API

Global configuration store API. The API exposes 20 endpoints.

## For AI agents

Programmatically create menu, all menus. Covers 20 operations.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- create menu
- all menus
- menu by id
- update menu by id
- delete menu by id

## Use cases

### E-Commerce Operations

Use the Config API to perform e commerce operations programmatically. The API provides 20 endpoints covering core functionality including create menu, all menus, menu by id.

Example prompt: Call POST /menu to create menu

### Automated menu Management

Automate menu operations by combining multiple Config API endpoints. Agents can all menus and then menu by id in a single workflow.

Example prompt: Call GET /menu to all menus, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Config API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'create menu', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/menu` | create menu |
| GET | `/menu` | all menus |
| GET | `/menu/{id}` | menu by id |
| PUT | `/menu/{id}` | update menu by id |
| DELETE | `/menu/{id}` | delete menu by id |
| POST | `/project` | create project |
| GET | `/project` | all projects |
| GET | `/project/{code}` | project by code |

## Key resources

- **menu** — menu items
- **project** — third-party project info
- **coordinate** — map coordinates
- **document** — document info

## Why Jentic

- **Setup:** Wiring the Config API by hand means pointing at its AWS eu-west-1 execution endpoint and calling its menu and project endpoints yourself. Through Jentic you install once, import Config API from the API Directory, store any connection detail once, and your agent calls it.
- **Permission scoping:** Config API puts the menu and project id in the URL path (`/menu/{id}` and `/project/{code}`), so a rule can pin your agent to one menu or project. You choose the operations it may call, so it can stay on reading and creating entries while destructive ones like menu deletion are not included unless you add them.
- **Credential handling:** Any Config API connection detail 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 menu' or 'get a project by code', and Jentic returns the matching Config API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the Config API use?

The Config API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create menu with the Config API?

Yes. Use the POST /menu endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Config API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create menu through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create menu'. Jentic returns the matching Config API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Config API have?

The Config API exposes 20 endpoints covering menu, project, coordinate operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Config API operations and credentials the agent may use. You can allow it to read and create entries with GET /menu, GET /project, and POST /menu while leaving destructive calls like DELETE `/menu/{id}` out unless you add them. Since the menu and project identifiers sit in the URL path, such as `/menu/{id}` and `/project/{code}`, you can also pin the agent to a single menu or project.
