canonical: https://jentic.com/apis/remote.com/remote

# Remote API

remote.com/main version 1.0.0. The API exposes 206 endpoints secured with basic, bearer, oauth2 authentication.

## For AI agents

Programmatically token, get token identity. Covers 206 operations with basic, bearer, oauth2 authentication.

## Scope

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

## Capabilities

- Token
- Get token identity
- Magic links generator
- Create the SSO Configuration
- Show the current SSO Configuration
- List Benefit Offers By Employment

## Use cases

### Developer Tools Operations

Use the Remote API to perform developer tools operations programmatically. The API provides 206 endpoints covering core functionality including token, get token identity, magic links generator.

Example prompt: Call POST `/auth/oauth2/token` to token

### Automated Auth Management

Automate auth operations by combining multiple Remote API endpoints. Agents can get token identity and then magic links generator in a single workflow.

Example prompt: Call GET `/v1/identity/current` to get token identity, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Remote 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 basic, bearer, oauth2 tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/auth/oauth2/token` | Token |
| GET | `/v1/identity/current` | Get token identity |
| POST | `/v1/magic-link` | Magic links generator |
| POST | `/v1/sso-configuration` | Create the SSO Configuration |
| GET | `/v1/sso-configuration` | Show the current SSO Configuration |
| GET | `/v1/sso-configuration/details` | Show the SSO Configuration Details |
| GET | `/v1/benefit-offers` | List Benefit Offers By Employment |
| GET | `/v1/benefit-offers/country-summaries` | List Benefit Offers |

## Key resources

- **Auth** — Operations for auth
- **Benefit Offers** — Operations for benefit offers
- **Benefit Renewal Requests** — Operations for benefit renewal requests
- **Billing Documents** — Operations for billing documents
- **Bulk Employment Jobs** — Operations for bulk employment jobs

## Why Jentic

- **Setup:** Wiring Remote by hand means picking among its basic, bearer, and OAuth2 schemes, running the client-credentials or authorization-code flow against gateway.remote.com, choosing production versus sandbox, and managing scoped tokens yourself. Through Jentic you install once, import Remote from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Remote grants OAuth2 scopes such as benefit_offer:read and employment:read, so limit the agent to the operations and scopes it needs, such as reading identity or benefit offers. You choose the operations it may call, so writing SSO configuration or magic links is not included unless you add them.
- **Credential handling:** Your Remote credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get the current identity' or 'list benefit offers', and Jentic returns the matching Remote operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Remote API use?

The Remote API uses basic, bearer, oauth2 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 token with the Remote API?

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

### What are the rate limits for the Remote 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 token through Jentic?

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

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

The Remote API exposes 206 endpoints covering auth, benefit offers, benefit renewal requests operations.

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

Yes. Jentic One is self-hosted, so you set the rules that decide which Remote operations and OAuth2 scopes your agent may use. You can restrict it to read-only calls such as GET `/v1/identity/current` and GET `/v1/benefit-offers` under scopes like employment:read and benefit_offer:read, while excluding write operations such as POST `/v1/sso-configuration` or POST `/v1/magic-link.` The agent can only call the operations you have explicitly allowed, and your stored credentials are injected at execution time rather than exposed to the agent.