CollectiveAccess API

Name: CollectiveAccess API
Brand: CollectiveAccess API
Availability: InStock

✓ Official Vendor SpecStorageDocument Managementbasic8 EndpointsREST

For Agents

Search, browse, create, update, and delete catalog items in a CollectiveAccess Providence collection through 8 table-aware endpoints, including media-representation lookups.

Install Jentic One Beta

Connect the CollectiveAccess API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the CollectiveAccess API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with CollectiveAccess API.

Search any catalog table with structured criteria via GET /find/{table}

Browse a table by facet or hierarchy via GET /browse/{table}

Retrieve a single item with all attributes via GET /item/{table}/id/{item_id}

GET STARTED

Start building with CollectiveAccess API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use CollectiveAccess API for, with concrete tasks.

★ Programmatic Collection Cataloging

Bulk-import catalog records into a CollectiveAccess Providence instance by calling PUT /item/{table} for each new accession. Tables are vendor-defined (objects, entities, occurrences, places) and the same endpoint handles any of them; the table name is a path parameter. This pattern fits museum digitisation projects that need to seed a fresh collection from a spreadsheet or external CMS.

For each row in a spreadsheet, call PUT /item/objects with the parsed metadata payload to create the accession record

Public Search Front-End

Expose a public collection search by proxying GET /find/{table} from a custom front-end. CollectiveAccess returns structured results with attributes ready to render in a card list. A library or archive can build a custom Vue or React UI on top of Providence without exposing the back-office UI.

Call GET /find/objects with a query parameter for the user's keyword, then render the returned items in a search results page

Asset Reconciliation

Reconcile a digital asset library with the catalog by listing media representations on each object via /item/{table}/id/{item_id}/media/{representation_id}/representations. An audit script can flag objects with missing or duplicate representations so curators can correct them. This supports preservation workflows that require complete media coverage.

For each catalog object, call GET /item/objects/id/{item_id}/media/{representation_id}/representations and report any object with zero attached media

AI Agent Cataloging via Jentic

Drive cataloging from an LLM by searching Jentic for the operation needed (find items, create record, update description) and executing it. CollectiveAccess Basic credentials live in the Jentic vault and are injected at execution so the agent never sees the username and password. Useful for AI-assisted metadata enrichment and triage.

Use Jentic to search 'create a catalog item', load the PUT /item/{table} schema, and execute it with the generated metadata for the objects table

Key Endpoints

8 endpoints — collectiveaccess (providence) is open-source collections management software used by museums, archives, and libraries.

METHOD

PATH

DESCRIPTION

PUT

/item/{table}

Create a new catalog item

PUT

/item/{table}/id/{item_id}

Update a catalog item

DELETE

/item/{table}/id/{item_id}

Delete a catalog item

GET

/item/{table}/id/{item_id}

Get a catalog item by ID

GET

/find/{table}

Search items in a table

GET

/browse/{table}

Browse items in a table

GET

/model/{table}

Get a table's data model

PUT

/item/{table}

Create a new catalog item

PUT

/item/{table}/id/{item_id}

Update a catalog item

DELETE

/item/{table}/id/{item_id}

Delete a catalog item

GET

/item/{table}/id/{item_id}

Get a catalog item by ID

GET

/find/{table}

Search items in a table

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

CollectiveAccess Basic auth credentials are stored encrypted in the Jentic vault and injected as the Authorization header at execution. Raw credentials never enter the agent context.

Intent-based discovery

Agents search by intent (e.g., 'create a catalog item') and Jentic returns the matching CollectiveAccess operation with its parameter schema so the agent can call the right endpoint without browsing docs.

Time to first call

Direct integration: 1-2 days to model table-by-table differences and Basic auth handling. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using CollectiveAccess API through Jentic.

What authentication does the CollectiveAccess API use?

The API uses HTTP Basic authentication with the credentials of a CollectiveAccess Providence user. Through Jentic the username and password are stored encrypted in the vault and injected at execution so they never enter the agent's prompt.

Which tables can I query with the CollectiveAccess API?

All cataloging tables defined in your Providence installation are addressable through the {table} path parameter — objects, entities, occurrences, places, collections, and any custom tables. Use GET /model/{table} to introspect a table's fields before constructing queries.

Can I attach media files via the CollectiveAccess API?

Media representations attached to an item are listed via GET /item/{table}/id/{item_id}/media/{representation_id}/representations. The OpenAPI surface focuses on metadata CRUD and read access to existing media; uploading new media files is typically done through the Providence back-office.

Is CollectiveAccess hosted or self-hosted?

CollectiveAccess Providence is self-hosted. The base URL is {server_url}/service.php where {server_url} is your own Providence installation. There is no public multi-tenant endpoint — every deployment is independent.

What are the rate limits for the CollectiveAccess API?

Because each Providence install is self-hosted there are no central rate limits; throughput is bounded only by your server resources. Add caching in front of GET /find/{table} for high-traffic public search front-ends.

How do I create a catalog item with the CollectiveAccess API through Jentic?

Search Jentic for 'create a catalog item', load the PUT /item/{table} schema, and execute it with the table name (e.g. objects) and the metadata payload. Jentic injects the Basic auth header from the vault.

CollectiveAccess API

Connect the CollectiveAccess API to your agent

Capabilities

Start building with CollectiveAccess API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs