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

# Surfly REST API Reference

By using the REST API, you can integrate our Co-browsing technology into your own application or build a thin layer around our technology. You can completely customize Surfly and automate the management of client and agent creation through the REST API. The Surfly REST API allows you to integrate the functionality of our dashboard in a programmatic manner. With our API you can do the following thi. The API exposes 32 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create, list. Covers 32 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- Create
- List
- Get by id
- Update
- Delete
- Generate an access token

## Use cases

### Identity and Authentication Operations

Use the REST API Reference to perform identity auth operations programmatically. The API provides 32 endpoints covering core functionality including create, list, get by id.

Example prompt: Call POST /agents/?api_key={API_KEY} to create

### Automated Clients Management

Automate clients operations by combining multiple REST API Reference endpoints. Agents can list and then get by id in a single workflow.

Example prompt: Call GET /agents/?api_key={API_KEY} to list, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call REST API Reference 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', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/agents/?api_key={API_KEY}` | Create |
| GET | `/agents/?api_key={API_KEY}` | List |
| GET | `/agents/{AGENT_ID}/?api_key={API_KEY}` | Get by id |
| PUT | `/agents/{AGENT_ID}/?api_key={API_KEY}` | Update |
| DELETE | `/agents/{AGENT_ID}/?api_key={API_KEY}` | Delete |
| POST | `/agents/access-token/?api_key={API_KEY}` | Generate an access token |
| POST | `/sessions/?api_key={API_KEY}` | Create |
| GET | `/sessions/?api_key={API_KEY}` | List |

## Key resources

- **Clients** — > (2018-03-19) `RESELLER_KEY` is deprecated. In order to make old API calls compatible, we replaced
- **Agents** — Operations related to Agents
- **Sessions** — Operations related to Sessions
- **Webhooks** — Operations related to Webhooks
- **Company** — Operations related to Company

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 35 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 50 / 100
  - Developer Experience & Jentic Compatibility: 59 / 100
  - AI-Readiness & Agent Experience: 21 / 100
  - Agent Usability: 94 / 100
  - Security: 15 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/surfly.com/surfly/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Surfly REST API by hand means passing your API key as a query parameter on every call to surfly.com/v2 and handling retries yourself. Through Jentic you install once, import the Surfly REST API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Surfly REST API puts the agent id in the URL path (`/agents/{AGENT_ID}`), so a rule can pin your agent to one Surfly agent record: it can read and update that record and nothing else. You choose the operations it may call, so destructive ones like deleting an agent are not included unless you add them.
- **Credential handling:** Your Surfly REST 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 session' or 'list agents', and Jentic returns the matching Surfly REST API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the REST API Reference use?

The REST API Reference 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 with the REST API Reference?

Yes. Use the POST /agents/?api_key={API_KEY} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the REST API Reference?

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 through Jentic?

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

### How many endpoints does the REST API Reference have?

The REST API Reference exposes 32 endpoints covering clients, agents, sessions operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Surfly operations and credentials the agent may use. Since the Surfly API puts the agent id in the URL path (`/agents/{AGENT_ID}`), you can pin the agent to a single Surfly agent record so it only reads and updates that one record. You also choose the operations it may call, so a destructive operation like DELETE `/agents/{AGENT_ID}` is excluded unless you add it.