Surfly REST API Reference

Name: REST API Reference API
Brand: REST API Reference
Availability: InStock

✓ Official Vendor SpecIdentity AuthAuthenticationapiKey32 EndpointsREST

For Agents

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

Install Jentic One Beta

Connect the REST API Reference to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the REST API Reference, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fsurfly.com%2Fsurfly" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fsurfly.com%2Fsurfly" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with REST API Reference API.

Create

List

Get by id

Update

GET STARTED

Start building with REST API Reference API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use REST API Reference API for, with concrete tasks.

★ 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.

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.

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.

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

Key Endpoints

32 endpoints — by using the rest api, you can integrate our co-browsing technology into your own application or build a thin layer around our technology.

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

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

Why Jentic?

What agents get from Jentic-routed access to this vendor.

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 isolation

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.

Intent-based discovery

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.

FAQs

Specific to using REST API Reference API through Jentic.

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.

Surfly REST API Reference

Connect the REST API Reference to your agent

Capabilities

Start building with REST API Reference API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs