canonical: https://jentic.com/apis/route4me.io/route4me

# Route4Me Route Optimization API

Cloud-based route optimization API for logistics and fleet management. Provides route planning, optimization, and tracking capabilities. The API exposes 5 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create a new optimization, retrieve optimization(s). Covers 5 operations with apiKey authentication.

## Scope

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

## Capabilities

- Create a new optimization
- Retrieve optimization(s)
- Update an optimization
- Delete an optimization
- Get activity feed

## Use cases

### Analytics Operations

Use the Route4Me Route Optimization API to perform analytics operations programmatically. The API provides 5 endpoints covering core functionality including create a new optimization, retrieve optimization(s), update an optimization.

Example prompt: Call POST `/api.v4/optimization_problem.php` to create a new optimization

### Automated Optimizations Management

Automate optimizations operations by combining multiple Route4Me Route Optimization API endpoints. Agents can retrieve optimization(s) and then update an optimization in a single workflow.

Example prompt: Call GET `/api.v4/optimization_problem.php` to retrieve optimization(s), then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Route4Me Route Optimization 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 apiKey tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api.v4/optimization_problem.php` | Create a new optimization |
| GET | `/api.v4/optimization_problem.php` | Retrieve optimization(s) |
| PUT | `/api.v4/optimization_problem.php` | Update an optimization |
| DELETE | `/api.v4/optimization_problem.php` | Delete an optimization |
| GET | `/api/get_activities.php` | Get activity feed |

## Key resources

- **Optimizations** — Route optimization operations
- **Activities** — Activity feed

## Why Jentic

- **Setup:** Wiring the Route4Me Route Optimization API by hand means appending your api_key query parameter to every request and handling the request plumbing yourself. Through Jentic you install once, import the Route4Me Route Optimization API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Route4Me takes the optimization problem in the request rather than the URL path, so limit the agent to the operations it needs, such as creating an optimization or reading activities. You choose which operations it may call, so ones like deleting an optimization problem are not included unless you add them.
- **Credential handling:** Your Route4Me API key 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 new route optimization' or 'get activity history', and Jentic returns the matching Route4Me operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mixpanel** — Alternative analytics API
- **Amplitude** — Alternative analytics API
- **Segment** — Complementary analytics API
- **Pendo** — Complementary analytics API

## FAQ

### What authentication does the Route4Me Route Optimization API use?

The Route4Me Route Optimization API uses an API key passed in the `api_key` query. 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 a new optimization with the Route4Me Route Optimization API?

Yes. Use the POST `/api.v4/optimization_problem.php` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Route4Me Route Optimization 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 a new optimization through Jentic?

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

### How many endpoints does the Route4Me Route Optimization API have?

The Route4Me Route Optimization API exposes 5 endpoints covering optimizations, activities operations.

### Can I limit what my agent is allowed to do with the Route4Me Route Optimization API?

Yes. Because you run Jentic One yourself and your own rules decide which operations and credentials the agent may use, you grant it only the Route4Me operations it needs, such as creating an optimization or reading the activity feed. Route4Me passes the optimization problem in the request body rather than the URL path, so write operations like updating or deleting an optimization stay out of reach unless you explicitly add them. Your API key is injected at execution time under those rules, keeping the agent scoped to exactly the calls you approve.