# Docs Birdy — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Docs Birdy provides 3 callable API endpoints through the Parse marketplace.

**Category:** Developer Tools | **Website:** [docs.birdy.chat/openapi.json](https://docs.birdy.chat/openapi.json) | **Docs:** [parse.bot/marketplace/b7376a6e-a2d6-400a-a01d-97e5c9b80756/docs-birdy-chat-api](https://parse.bot/marketplace/b7376a6e-a2d6-400a-a01d-97e5c9b80756/docs-birdy-chat-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/docs-birdy/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get api overview

Returns a high-level overview of all BirdyChat API operations grouped by tag, including authentication details, rate limits, webhook information, server URL, and the complete list of operations with their IDs, HTTP methods, paths, and summaries. One round trip to the public OpenAPI spec.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/docs-birdy/get-api-overview \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get operation detail

Returns full details for a specific API operation by its operation_id, including HTTP method, path, parameters with schemas, request body fields, and response schemas with field definitions. One round trip to the public OpenAPI spec.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `operation_id` | string | Yes | The operationId of the API operation to retrieve (e.g. createIntegration, listThreadMessages, addThreadUsers). Available operation IDs can be discovered via get_api_overview. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/docs-birdy/get-operation-detail \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"operation_id":"<string>"}'
```

### Get schema detail

Returns the full definition of a named component schema from the OpenAPI spec, including all fields with types, required status, descriptions, patterns, enums, and one level of nested schema resolution. One round trip to the public OpenAPI spec.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `schema_name` | string | Yes | Name of the component schema to retrieve (e.g. Thread, Message, Channel, User, Integration, Event, WebhookEvent). Available schema names are listed in the error message when an invalid name is provided. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/docs-birdy/get-schema-detail \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"schema_name":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.