canonical: https://jentic.com/apis/envelope.so/envelope

# Envelope So Envelope API

The Envelope API manages events and their guests programmatically. An agent lists, creates, retrieves, updates, and removes guests, registers a guest, and checks a guest in or reverses a check-in at the door. It also lists events and retrieves an event by ID, so an assistant can run the guest side of an event from a single API keyed by an x-api-key header.

## For AI agents

Manage event guests and check-ins: list, create, update, and remove guests, register a guest, check guests in or out, and look up events over an x-api-key keyed API.

## Scope

Does not sell tickets, process payments, or send invitations. Use for event guest and check-in management only.

## Capabilities

- List, create, and update guests for an event
- Check a guest in and reverse a check-in at the door
- Register a guest through the registration operation
- Retrieve a single guest by ID
- List events and retrieve an event by ID

## Use cases

### Agent-managed guest check-in

At the door, an agent looks up a guest by ID and checks them in, or reverses a check-in if someone was marked in error. The check-in and lookup operations are discovered through Jentic by intent, so a kiosk or assistant can process arrivals without wiring the API by hand.

Example prompt: Look up a guest by ID, check them in, and confirm the check-in state updated

### Guest list building

Build and maintain an event's guest list by creating guests, updating their details, and registering new arrivals. An agent can add guests from an external source and keep each record current ahead of the event.

Example prompt: Create a new guest, update a field on an existing guest, and register a walk-in guest

### Event lookup

Retrieve the events available in the account by listing them and fetching a single event by ID. An agent uses the event lookup to pick the right event before reading or updating its guests.

Example prompt: List the events in the account and retrieve one event's details by its ID

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/guests` | List all guests |
| POST | `/v1/guests` | Create a new guest |
| GET | `/v1/guests/{_id}` | Get a guest by ID |
| PATCH | `/v1/guests/{_id}` | Update a guest |
| POST | `/v1/guests/{_id}/check-in` | Check in a guest |
| POST | `/v1/guests/register` | Register a guest |
| GET | `/v1/events` | List all events |
| GET | `/v1/events/{_id}` | Get an event by ID |

## Key resources

- **Guests** — List, create, retrieve, update, remove, register, and check in or out guests
- **Events** — List events and retrieve a single event by ID

## 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:** 55 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 66 / 100
  - AI-Readiness & Agent Experience: 30 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 80 / 100
- **View full report:** https://jentic.com/apis/envelope.so/envelope/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 Envelope API by hand means sending your key in the x-api-key header, targeting the envelope.so/api host, and sequencing guest, check-in, and event calls yourself. Through Jentic you install once, import the Envelope API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Envelope puts the guest id in the URL path (`/v1/guests/{_id}`), so a rule can pin your agent to one guest and the operations you pick. You choose the operations it may call, so destructive ones like deleting a guest are not included unless you add them.
- **Credential handling:** Your Envelope 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 'check in a guest' or 'list event guests', and Jentic returns the matching Envelope operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Eventbrite** — Event creation, ticketing, and attendee management
- **Luma** — Event hosting with guest registration and check-in
- **Cvent** — Enterprise event management and registration

## FAQ

### What authentication does the Envelope API use?

The Envelope API authenticates with an API key sent in the x-api-key header, per its OpenAPI spec. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at execution time, so it never enters the agent's context.

### Can I check guests in with the Envelope API?

Yes. The check-in operation marks a guest as checked in, and a companion operation reverses a check-in, so an agent can process arrivals and correct mistakes at the door for a guest looked up by ID.

### What are the rate limits for the Envelope API?

The OpenAPI spec does not state request rate limits. Check the Envelope documentation at https://docs.envelope.so for current limits and any per-key quotas.

### Is there an Envelope MCP server?

You don't need an MCP server to give your agent the Envelope API. Jentic connects it directly from the API Directory: import it, store your key once, and your agent calls the guest, check-in, and event operations it needs.

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

Yes. Because Envelope carries the guest id in the URL path, you can pin a rule to one guest and allow only the check-in and read operations, so a door assistant can check guests in but cannot delete guest records. Destructive operations stay off unless you add them, and every call the agent makes is logged.

### How do I check in a guest through Jentic?

Search Jentic for 'check in a guest', and it returns the Envelope check-in operation with its input schema; your agent supplies the guest ID and calls it. To run it on your own infrastructure, install Jentic One from its GitHub repo.