# Docs Livecode — 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.

> Access comprehensive LiveCode Script documentation to look up commands, functions, control structures, and language reference entries. Quickly find detailed information about any LiveCode language feature you need while coding.

**Category:** Developer Tools | **Website:** [docs.livecode.com/docs/](https://docs.livecode.com/docs/) | **Docs:** [parse.bot/marketplace/7f9ed7ad-d186-46da-8c9a-3045a13ed5a4/docs-livecode-com-api](https://parse.bot/marketplace/7f9ed7ad-d186-46da-8c9a-3045a13ed5a4/docs-livecode-com-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-livecode/`
**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 entry

Retrieves the full documentation for a specific LiveCode Script entry, including its type, summary, syntax, description, parameters, examples, and related references. Entry names are obtained from list_entries results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | Yes | The LiveCode Script documentation category the entry belongs to. |
| `name` | string | Yes | The name of the entry to retrieve (e.g. 'add', 'if', 'abs'). Obtained from list_entries results. |

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

### List entries

Lists all entries in a given LiveCode Script documentation category. Returns entry names and their documentation paths. Categories include Commands (631 items), Functions (606 items), Control Structures (18 items), Constants, Glossary, Keywords, Libraries, Messages, Objects, Operators, Properties, Widgets, and com.livecode.language.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | Yes | The LiveCode Script documentation category to list entries for. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/docs-livecode/list-entries \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<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.