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

# Sprig API

Sprig product research API for managing surveys, events, user attributes, and responses. The API exposes 6 endpoints secured with bearer authentication.

## For AI agents

Programmatically list surveys, get survey. Covers 6 operations with bearer authentication.

## Scope

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

## Capabilities

- List surveys
- Get survey
- Track event
- Identify user
- Monitor Sprig API operational status and events

## Use cases

### Education Operations

Use the Sprig API to perform education operations programmatically. The API provides 6 endpoints covering core functionality including list surveys, get survey, get survey responses.

Example prompt: Call GET /surveys to list surveys

### Automated Events Management

Automate events operations by combining multiple Sprig API endpoints. Agents can get survey and then get survey responses in a single workflow.

Example prompt: Call GET `/surveys/{surveyId}` to get survey, then verify the result

### AI Agent Integration via Jentic

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

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/surveys` | List surveys |
| GET | `/surveys/{surveyId}` | Get survey |
| GET | `/surveys/{surveyId}/responses` | Get survey responses |
| POST | `/events` | Track event |
| POST | `/users` | Identify user |
| GET | `/users/{userId}` | Get user |

## Key resources

- **Events** — Operations related to Events
- **Surveys** — Operations related to Surveys
- **Users** — Operations related to Users

## 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:** 67 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 90 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/sprig.com/sprig/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 Sprig API by hand means implementing its bearer auth and pointing every call at the api.sprig.com/v2 host yourself. Through Jentic you install once, import the Sprig API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Sprig puts the survey id in the URL path (`/surveys/{surveyId}/responses`), so a rule can pin your agent to reading one survey and its responses. You choose the operations it may call, so writes like posting events or upserting users are not included unless you add them.
- **Credential handling:** Your Sprig bearer token 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 surveys' or 'get a survey's responses', and Jentic returns the matching Sprig API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Schoology** — Alternative education API
- **Stripe** — Complementary API for broader integration workflows
- **Twilio** — Complementary API for broader integration workflows

## FAQ

### What authentication does the Sprig API use?

The Sprig API uses a Bearer token in the Authorization header. 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 list surveys with the Sprig API?

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

### What are the rate limits for the Sprig 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 list surveys through Jentic?

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

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

The Sprig API exposes 6 endpoints covering events, surveys, users operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which Sprig operations and credentials the agent may use. Because Sprig puts the survey id in the URL path, such as GET `/surveys/{surveyId}/responses`, you can pin the agent to reading a single survey and its responses. You pick the operations it may call, so write actions like POST /events or POST /users stay off limits unless you explicitly grant them.