canonical: https://jentic.com/apis/tsapi.net/tsapi

# TSAPI

tsapi.net/main version v1. The API exposes 3 endpoints secured with apiKey authentication.

## For AI agents

Programmatically returns a list of available surveys, fetches some interview records for a specific survey. Covers 3 operations with apiKey authentication.

## Scope

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

## Capabilities

- Returns a list of available Surveys
- Fetches some interview records for a specific survey
- Integrate TSAPI into automated workflows
- Query and filter TSAPI records by parameters
- Monitor TSAPI operational status and events

## Use cases

### Developer Tools Operations

Use the TSAPI to perform developer tools operations programmatically. The API provides 3 endpoints covering core functionality including returns a list of available surveys, fetches some interview records for a specific survey, fetches the metadata for a specific survey.

Example prompt: Call GET /Surveys to returns a list of available surveys

### Automated Surveys Management

Automate surveys operations by combining multiple TSAPI endpoints. Agents can fetches some interview records for a specific survey and then fetches the metadata for a specific survey in a single workflow.

Example prompt: Call GET `/Surveys/{surveyId}/Interviews` to fetches some interview records for a specific survey, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call TSAPI 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 'returns a list of available surveys', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/Surveys` | Returns a list of available Surveys |
| GET | `/Surveys/{surveyId}/Interviews` | Fetches some interview records for a specific survey |
| GET | `/Surveys/{surveyId}/Metadata` | Fetches the metadata for a specific survey |

## Key resources

- **Surveys** — Operations for Surveys

## 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: 100 / 100
  - Developer Experience & Jentic Compatibility: 56 / 100
  - AI-Readiness & Agent Experience: 13 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/tsapi.net/tsapi/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 TSAPI by hand means setting its Authorization key header, tracking survey ids across calls, and handling errors and retries yourself. Through Jentic you install once, import TSAPI from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** TSAPI puts the survey id in the URL path (`/Surveys/{surveyId}/...`), so a rule can pin your agent to one survey: it can read that survey's interviews and metadata and nothing else. You choose the operations it may call, so it stays read-only unless you add more.
- **Credential handling:** Your TSAPI 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 'list available surveys' or 'get a survey's interviews', and Jentic returns the matching TSAPI 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 TSAPI use?

The TSAPI uses an API key passed 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 returns a list of available surveys with the TSAPI?

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 TSAPI?

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 returns a list of available surveys through Jentic?

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

### How many endpoints does the TSAPI have?

The TSAPI exposes 3 endpoints covering surveys operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which TSAPI operations and credentials the agent may use, so you can allow only the read calls GET /Surveys, GET `/Surveys/{surveyId}/Interviews`, and GET `/Surveys/{surveyId}/Metadata` and nothing else. Since the survey id sits in the URL path, a rule can pin the agent to a single survey, letting it read that survey's interviews and metadata while every other survey stays out of reach. The agent stays read-only unless you explicitly grant more.