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

# Pyrus API

Pyrus is a platform for real-time messaging, task management, and workflow automation. The API allows building highly customized integrations in any programming language. The API exposes 32 endpoints secured with bearer authentication.

## For AI agents

Programmatically authenticate and obtain access token, get a task by id. Covers 32 operations with bearer authentication.

## Scope

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

## Capabilities

- Authenticate and obtain access token
- Get a task by ID
- Delete a task
- Create a task
- Add a comment to a task
- List all forms

## Use cases

### Developer Tools Operations

Use the Pyrus API to perform developer tools operations programmatically. The API provides 32 endpoints covering core functionality including authenticate and obtain access token, get a task by id, delete a task.

Example prompt: Call POST /auth to authenticate and obtain access token

### Automated Auth Management

Automate auth operations by combining multiple Pyrus API endpoints. Agents can get a task by id and then delete a task in a single workflow.

Example prompt: Call GET `/tasks/{taskId}` to get a task by id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Pyrus 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 'authenticate and obtain access token', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/auth` | Authenticate and obtain access token |
| GET | `/tasks/{taskId}` | Get a task by ID |
| DELETE | `/tasks/{taskId}` | Delete a task |
| POST | `/tasks` | Create a task |
| POST | `/tasks/{taskId}/comments` | Add a comment to a task |
| GET | `/forms` | List all forms |
| GET | `/forms/{formId}` | Get a form by ID |
| GET | `/forms/{formId}/register` | Get form task register |

## Key resources

- **Auth** — Authentication
- **Tasks** — Task management
- **Forms** — Form management
- **Catalogs** — Catalog management
- **Files** — File upload and download

## 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:** 65 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 81 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 72 / 100
- **View full report:** https://jentic.com/apis/pyrus.com/pyrus/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 Pyrus API by hand means exchanging credentials for a bearer token and handling task, comment, and form calls yourself. Through Jentic you install once, import the Pyrus API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Pyrus puts the task and form ids in the URL path (`/tasks/{taskId}`, `/forms/{formId}`), so a rule can pin your agent to one task or form: it can read that task or add a comment and nothing else. You choose the operations it may call, so task deletion is not included unless you add it.
- **Credential handling:** Your Pyrus 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 'create a task' or 'add a comment to a task', and Jentic returns the matching Pyrus 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 Pyrus API use?

The Pyrus 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 authenticate and obtain access token with the Pyrus API?

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

### What are the rate limits for the Pyrus 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 authenticate and obtain access token through Jentic?

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

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

The Pyrus API exposes 32 endpoints covering auth, tasks, forms operations.

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

Yes. Because the Pyrus API puts the task and form identifiers in the URL path (`/tasks/{taskId}`, `/forms/{formId}`), a rule in your self-hosted Jentic One instance can pin your agent to a single task or form, so it can read that task or add a comment and nothing else. You decide which operations and credentials the agent may use, so an action like deleting a task via DELETE `/tasks/{taskId}` stays out of reach unless you explicitly allow it. Your Pyrus token is held by your own instance and injected at execution time, keeping the agent scoped to exactly the calls you permit.