canonical: https://jentic.com/apis/swiftlynx.ai/swiftlynx

# SwiftLynx API

Resume analysis and matching API with OAuth2 PKCE authentication. The API exposes 4 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically initiate oauth flow, exchange authorization code or refresh token. Covers 4 operations with oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- Initiate OAuth flow
- Exchange authorization code or refresh token
- Get account information
- Analyze resume
- Monitor SwiftLynx API operational status and events

## Use cases

### Identity and Authentication Operations

Use the SwiftLynx API to perform identity auth operations programmatically. The API provides 4 endpoints covering core functionality including initiate oauth flow, exchange authorization code or refresh token, get account information.

Example prompt: Call GET `/api/oauth/authorize` to initiate oauth flow

### Automated OAuth Management

Automate oauth operations by combining multiple SwiftLynx API endpoints. Agents can exchange authorization code or refresh token and then get account information in a single workflow.

Example prompt: Call POST `/api/oauth/token` to exchange authorization code or refresh token, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SwiftLynx 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 'initiate oauth flow', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/oauth/authorize` | Initiate OAuth flow |
| POST | `/api/oauth/token` | Exchange authorization code or refresh token |
| GET | `/api/me` | Get account information |
| POST | `/api/analyze` | Analyze resume |

## Key resources

- **OAuth** — OAuth2 authentication operations
- **Account** — Account management
- **Analysis** — Resume analysis operations

## 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:** 74 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 61 / 100
  - AI-Readiness & Agent Experience: 54 / 100
  - Agent Usability: 94 / 100
  - Security: 90 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/swiftlynx.ai/swiftlynx/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 SwiftLynx by hand means implementing its OAuth2 authorization-code flow against swiftlynx.ai, exchanging codes for tokens at `/api/oauth/token`, and refreshing them yourself. Through Jentic you install once, import SwiftLynx from the API Directory, store the OAuth2 credentials once, and your agent calls it.
- **Permission scoping:** SwiftLynx carries its targets in the request body rather than the URL path, so scope the agent to the operations it needs, such as reading the current user or running an analysis. You choose that allowed set, so anything you do not add stays out of reach.
- **Credential handling:** Your SwiftLynx OAuth2 credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'start the OAuth flow' or 'analyze text', and Jentic returns the matching SwiftLynx operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the SwiftLynx API use?

The SwiftLynx 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 initiate oauth flow with the SwiftLynx API?

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

### What are the rate limits for the SwiftLynx 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 initiate oauth flow through Jentic?

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

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

The SwiftLynx API exposes 4 endpoints covering oauth, account, analysis operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which SwiftLynx operations and OAuth2 credentials the agent may use, so you add only the calls it needs, such as reading the current user with GET `/api/me` or running an analysis with POST `/api/analyze.` SwiftLynx carries its targets in the request body rather than the URL path, so scoping happens at the operation level: anything you do not add, like initiating a new OAuth flow or exchanging tokens, stays out of the agent's reach. You choose that allowed set, and the encrypted credentials are injected only for the operations you permit.