canonical: https://jentic.com/apis/swaggerhub.quiputech/osm-api

# Quiputech OSM API

Order and Service Management. The API exposes 2 endpoints.

## For AI agents

Programmatically request order execution, request order execution. Covers 2 operations.

## Scope

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

## Capabilities

- request order execution
- Manage e commerce data programmatically
- Integrate OSM API into automated workflows
- Query and filter OSM API records by parameters
- Monitor OSM API operational status and events

## Use cases

### E-Commerce Operations

Use the OSM API to perform e commerce operations programmatically. The API provides 2 endpoints covering core functionality including request order execution, request order execution.

Example prompt: Call POST `/v1/order` to request order execution

### Data Retrieval and Monitoring

Query OSM API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary OSM API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call OSM 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 'request order execution', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/order` | request order execution |
| GET | `/v1/order/{orderId}` | request order execution |

## Key resources

- **operation** — Operations related calls

## Why Jentic

- **Setup:** Wiring the OSM API by hand means coding its order-create and order-lookup calls and handling retries yourself even though it takes no credential. Through Jentic you install once, import the OSM API from the API Directory, and your agent calls it.
- **Permission scoping:** The OSM API puts the order id in the URL path (`/v1/order/{orderId}`), so a rule can pin your agent to reading a specific order. You choose the operations it may call, so order creation is not included unless you add it.
- **Credential handling:** The OSM API needs no credential, so there is nothing to store, and any host configuration is held by your own Jentic One instance and applied at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'request order execution' or 'look up an order by id', and Jentic returns the matching OSM 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 OSM API use?

The OSM 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 request order execution with the OSM API?

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

### What are the rate limits for the OSM 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 request order execution through Jentic?

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

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

The OSM API exposes 2 endpoints covering operation operations.

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

Yes. Jentic One runs self-hosted, so your own rules decide which OSM API operations the agent may call and which it may not. Because the order id sits in the URL path at GET `/v1/order/{orderId}`, you can pin the agent to looking up a specific order, and you choose the operations it can reach, so POST `/v1/order` order creation stays off unless you add it. This API needs no credential, and all host configuration is held by your Jentic One instance and applied at execution time.