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

# Xobin Interact API

Xobin assessment platform API for managing assessments, inviting candidates, and retrieving scores and reports. The API exposes 5 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list all assessments, send assessment invite. Covers 5 operations with apiKey authentication.

## Scope

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

## Capabilities

- List all assessments
- Send assessment invite
- Get candidate score
- Query and filter Xobin Interact API records by parameters
- Monitor Xobin Interact API operational status and events

## Use cases

### Analytics Operations

Use the Xobin Interact API to perform analytics operations programmatically. The API provides 5 endpoints covering core functionality including list all assessments, send assessment invite, get candidate score.

Example prompt: Call GET /{api_key}/assessment/get/assessments to list all assessments

### Automated Assessments Management

Automate assessments operations by combining multiple Xobin Interact API endpoints. Agents can send assessment invite and then get candidate score in a single workflow.

Example prompt: Call GET /{api_key}/assessment/send/invite/{candidate_email}/{candidate_name}/getlink/{assessment_id} to send assessment invite, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Xobin Interact 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 apiKey tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/{api_key}/assessment/get/assessments` | List all assessments |
| GET | `/{api_key}/assessment/send/invite/{candidate_email}/{candidate_name}/getlink/{assessment_id}` | Send assessment invite |
| GET | `/{api_key}/assessment/get/report/{candidate_id}` | Get candidate score |
| GET | `/{api_key}/assessment/get/candidates/{assessment_id}` | List invited candidates |
| GET | `/{api_key}/assessment/get/live` | Get live test-taker count |

## Key resources

- **Assessments** — Operations related to Assessments
- **Candidates** — Operations related to Candidates
- **Reports** — Operations related to Reports

## 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:** 47 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 45 / 100
  - Agent Usability: 94 / 100
  - Security: 15 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/xobin.com/xobin/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 Xobin Interact by hand means threading your API key into each path template against app.xobin.com, encoding candidate details into the URL, and handling retries yourself. Through Jentic you install once, import Xobin Interact from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Xobin Interact carries the assessment and candidate identifiers in the request rather than as a scoping handle, so limit the agent to the operations it needs, such as listing assessments or fetching a candidate report. You choose that set, so anything beyond reading results is left out unless you add it.
- **Credential handling:** Your Xobin Interact 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 all assessments' or 'get a candidate report', and Jentic returns the matching Xobin Interact operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mixpanel** — Alternative analytics API
- **Amplitude** — Alternative analytics API
- **Segment** — Complementary analytics API
- **Pendo** — Complementary analytics API

## FAQ

### What authentication does the Xobin Interact API use?

The Xobin Interact API 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 list all assessments with the Xobin Interact API?

Yes. Use the GET /{api_key}/assessment/get/assessments endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Xobin Interact 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 all assessments through Jentic?

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

### How many endpoints does the Xobin Interact API have?

The Xobin Interact API exposes 5 endpoints covering assessments, candidates, reports operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Xobin Interact operations and credentials the agent may use. The Xobin Interact API carries the assessment and candidate identifiers in the request rather than as a scoping handle, so you scope access by choosing the exact operations you import, such as listing assessments (GET /{api_key}/assessment/get/assessments) or fetching a candidate report (GET /{api_key}/assessment/get/report/{candidate_id}). Anything beyond the read operations you select, including sending an assessment invite, is left out unless you add it.