canonical: https://jentic.com/apis/swaggerhub.myself446/brigadiers-api

# Myself446 Brigadiers API

swaggerhub.myself446/brigadiers-api version v1. The API exposes 24 endpoints secured with apiKey authentication.

## For AI agents

Programmatically brigadiers_list, brigadiers_read. Covers 24 operations with apiKey authentication.

## Scope

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

## Capabilities

- brigadiers_list
- brigadiers_read
- brigadiers_update
- brigadiers_partial_update
- payment_requests_create
- payment_requests_list
- payment_requests_read

## Use cases

### Developer Tools Operations

Use the Brigadiers API to perform developer tools operations programmatically. The API provides 24 endpoints covering core functionality including brigadiers_list, brigadiers_read, brigadiers_update.

Example prompt: Call GET /brigadiers/ to brigadiers_list

### Automated Brigadiers Management

Automate brigadiers operations by combining multiple Brigadiers API endpoints. Agents can brigadiers_read and then brigadiers_update in a single workflow.

Example prompt: Call GET `/brigadiers/{id}`/ to brigadiers_read, then verify the result

### AI Agent Integration via Jentic

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/brigadiers/` | brigadiers_list |
| GET | `/brigadiers/{id}/` | brigadiers_read |
| PUT | `/brigadiers/{id}/` | brigadiers_update |
| PATCH | `/brigadiers/{id}/` | brigadiers_partial_update |
| POST | `/payment_requests/` | payment_requests_create |
| GET | `/payment_requests/` | payment_requests_list |
| GET | `/payment_requests/{id}/` | payment_requests_read |
| PUT | `/payment_requests/{id}/` | payment_requests_update |

## Key resources

- **Brigadiers** — Operations for brigadiers
- **Change_Password** — Operations for change_password
- **Payment_Requests** — Operations for payment_requests
- **Promo_Codes** — Operations for promo_codes
- **Send_Sms** — Operations for send_sms

## Why Jentic

- **Setup:** Wiring the Brigadiers API by hand means learning its JWT header auth on the Authorization header, targeting its dev host, coding the brigadier and payment-request routes, and handling retries yourself. Through Jentic you install once, import the Brigadiers API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** This API puts the record id in the URL path (`/brigadiers/{id}`/, `/payment_requests/{id}`/), so a rule can pin your agent to reading one brigadier or payment request and nothing else. You choose the operations it may call, so write ones like updating a brigadier are not included unless you add them.
- **Credential handling:** Your Brigadiers API 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 'list brigadiers' or 'read a payment request', and Jentic returns the matching Brigadiers API 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 Brigadiers API use?

The Brigadiers API uses an API key passed 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 brigadiers_list with the Brigadiers API?

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

### What are the rate limits for the Brigadiers 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 brigadiers_list through Jentic?

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

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

The Brigadiers API exposes 24 endpoints covering brigadiers, change_password, payment_requests operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Brigadiers API operations and credentials the agent may use. Since this API carries the record id in the URL path (`/brigadiers/{id}`/ and `/payment_requests/{id}`/), you can pin the agent to reading a single brigadier or payment request and nothing else. You choose the operations it may call, so write actions like updating a brigadier (PUT `/brigadiers/{id}`/) are excluded unless you explicitly grant them.