# Wellcomecollection — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://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 data from wellcomecollection.org.

**Category:** Education | **Website:** [wellcomecollection.org/](https://wellcomecollection.org/) | **Docs:** [parse.bot/marketplace/823abe33-e328-454b-b158-cc1b55cb45da/wellcomecollection-org-api](https://parse.bot/marketplace/823abe33-e328-454b-b158-cc1b55cb45da/wellcomecollection-org-api)

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

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/wellcomecollection/`
**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 work

Retrieve full details of a single work by its catalogue identifier. Supports including additional related data such as subjects, contributors, production details, and languages.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `include` | string | No | Comma-separated list of additional fields to include: identifiers, items, holdings, subjects, genres, contributors, production, languages, notes. |
| `work_id` | string | Yes | The unique work identifier from the Wellcome Collection catalogue (e.g. 'gbd4prdu'). |

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

### Search images

Search the Wellcome Collection image catalogue. Supports filtering by dominant color (hex code). Returns image metadata including IIIF URLs, license information, and source work references. Results are auto-iterated across pages.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `color` | string | No | Filter images by dominant color as a 6-character hex code without '#' prefix (e.g. 'ff0000' for red). |
| `include` | string | No | Comma-separated list of additional fields to include: source.contributors, source.languages. |
| `page` | integer | No | Page number for pagination (1-based). |
| `page_size` | integer | No | Number of results per page, between 1 and 100. |
| `query` | string | No | Search query to match against image metadata and source work titles. Omitting returns all images. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wellcomecollection/search-images \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"color":"<string>","include":"<string>","page":"<integer>","page_size":"<integer>","query":"<string>"}'
```

### Search works

Full-text search across the Wellcome Collection catalogue of works (books, manuscripts, pictures, videos, etc.). Supports filtering by work type, sorting by production date, and aggregations for faceted search. Results are auto-iterated across pages.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `aggregations` | string | No | Comma-separated list of fields to aggregate for faceted search: workType, availabilities, languages, subjects.label, genres.label, contributors.agent.label. |
| `include` | string | No | Comma-separated list of additional fields to include in results: identifiers, items, holdings, subjects, genres, contributors, production, languages, notes. |
| `page` | integer | No | Page number for pagination (1-based). |
| `page_size` | integer | No | Number of results per page, between 1 and 100. |
| `query` | string | No | Search query string to match against work titles and metadata. Omitting returns all works. |
| `sort` | string | No | Field to sort results by. |
| `sort_order` | string | No | Sort direction. |
| `work_type` | string | No | Filter by work format type code. Multiple types can be comma-separated. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wellcomecollection/search-works \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"aggregations":"<string>","include":"<string>","page":"<integer>","page_size":"<integer>","query":"<string>","sort":"<string>","sort_order":"<string>","work_type":"<string>"}'
```

## Next steps

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