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

# Runscope API

Manage Runscope programmatically. The API exposes 29 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically account resource, create a new bucket. Covers 29 operations with oauth2 authentication.

## Scope

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

## Capabilities

- Account Resource
- Create a new bucket
- Returns a list of buckets.
- Delete a single bucket resource.
- Monitor Runscope API operational status and events

## Use cases

### Communications Operations

Use the Runscope API to perform communications operations programmatically. The API provides 29 endpoints covering core functionality including account resource, create a new bucket, returns a list of buckets..

Example prompt: Call GET /account to account resource

### Automated Account Management

Automate account operations by combining multiple Runscope API endpoints. Agents can create a new bucket and then returns a list of buckets. in a single workflow.

Example prompt: Call POST /buckets to create a new bucket, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Runscope 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 oauth2 tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/account` | Account Resource |
| POST | `/buckets` | Create a new bucket |
| GET | `/buckets` | Returns a list of buckets. |
| GET | `/buckets/{bucketKey}` | Returns a single bucket resource. |
| DELETE | `/buckets/{bucketKey}` | Delete a single bucket resource. |
| POST | `/buckets/{bucketKey}/environments` | Create new shared environment. |
| GET | `/buckets/{bucketKey}/environments` | Returns list of shared environments for a specified bucket. |
| PUT | `/buckets/{bucketKey}/environments/{environmentId}` | Update the details of a shared environment. |

## Key resources

- **Account** — Operations for account
- **Buckets** — Operations for buckets
- **Teams** — Operations for teams

## Why Jentic

- **Setup:** Wiring Runscope by hand means running its OAuth2 authorization-code flow against runscope.com/signin/oauth, tracking read and write scopes, and refreshing tokens yourself. Through Jentic you install once, import Runscope from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Runscope puts the bucket key in the URL path (`/buckets/{bucketKey}`), so a rule can pin your agent to one bucket: it can read that bucket and its environments and nothing else. You choose the operations it may call, so bucket deletion is not included unless you add it.
- **Credential handling:** Your Runscope OAuth credential 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 'list my buckets' or 'create a shared environment', and Jentic returns the matching Runscope operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the Runscope API use?

The Runscope API uses OAuth 2.0 for authorization. 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 account resource with the Runscope API?

Yes. Use the GET /account endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Runscope 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 account resource through Jentic?

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

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

The Runscope API exposes 29 endpoints covering account, buckets, teams operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Runscope operations and credentials the agent may use. Since the bucket key sits in the URL path (`/buckets/{bucketKey}`), you can pin the agent to a single bucket so it only reads that bucket and its shared environments through GET `/buckets/{bucketKey}` and GET `/buckets/{bucketKey}/environments.` Destructive calls such as DELETE `/buckets/{bucketKey}` stay out of scope unless you explicitly allow them.