canonical: https://jentic.com/apis/scorly.io/scorly

# Scorly API

Scorly lead scoring API for evaluating lead quality synchronously or asynchronously. The API exposes 3 endpoints secured with apiKey authentication.

## For AI agents

Programmatically score a lead synchronously, score a lead asynchronously. Covers 3 operations with apiKey authentication.

## Scope

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

## Capabilities

- Score a lead synchronously
- Get scoring run details
- Integrate Scorly API into automated workflows
- Query and filter Scorly API records by parameters
- Monitor Scorly API operational status and events

## Use cases

### CRM Operations

Use the Scorly API to perform crm operations programmatically. The API provides 3 endpoints covering core functionality including score a lead synchronously, score a lead asynchronously, get scoring run details.

Example prompt: Call POST `/v1/score/sync` to score a lead synchronously

### Automated Scoring Management

Automate scoring operations by combining multiple Scorly API endpoints. Agents can score a lead asynchronously and then get scoring run details in a single workflow.

Example prompt: Call POST `/v1/score/async` to score a lead asynchronously, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Scorly 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 'score a lead synchronously', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/score/sync` | Score a lead synchronously |
| POST | `/v1/score/async` | Score a lead asynchronously |
| GET | `/v1/score/runs/{id}` | Get scoring run details |

## Key resources

- **Scoring** — Operations related to Scoring

## 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:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 65 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/scorly.io/scorly/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 Scorly API by hand means sending your key in the X-API-Key header, choosing between the sync and async scoring calls, and building your own retry handling against api.scorly.io. Through Jentic you install once, import Scorly from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Scorly scores leads from a request body and returns run results by id, so you limit the agent to the operations it needs, such as synchronous scoring or fetching a run by id. You choose the operations it may call, and any you leave out stay unavailable to the agent.
- **Credential handling:** Your Scorly 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.
- **Discovery method:** Agents search Jentic by intent such as 'score a lead synchronously' or 'get the result of a scoring run', and Jentic returns the matching Scorly operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Scorly API use?

The Scorly API uses an API key passed in the `X-API-Key` 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 score a lead synchronously with the Scorly API?

Yes. Use the POST `/v1/score/sync` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Scorly 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 score a lead synchronously through Jentic?

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

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

The Scorly API exposes 3 endpoints covering scoring operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Scorly operations the agent may call and which credentials it may use. The Scorly API exposes just three operations - synchronous scoring at POST `/v1/score/sync`, asynchronous scoring at POST `/v1/score/async`, and fetching a run by id at GET `/v1/score/runs/{id}` - so you can, for example, allow only synchronous scoring and leave the async and run-lookup calls unavailable. Any operation you do not grant stays out of the agent's reach, and your API key is injected at execution time rather than exposed to the agent.