Documentapi Brightplanet BrightPlanet's Harvest REST APIs

Name: BrightPlanet's Harvest REST APIs
Brand: BrightPlanet's Harvest REST APIs
Availability: InStock

★ Only Publicly Available OpenAPI DocumentData EnrichmentData Transformationoauth2, apiKey20 EndpointsREST

For Agents

Install Jentic One Beta

Connect the BrightPlanet's Harvest REST APIs to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the BrightPlanet's Harvest REST APIs, 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 BrightPlanet's Harvest REST APIs.

Add, update, and delete pet records via /pet endpoints

Find pets by status or by tag using GET /pet/findByStatus and /pet/findByTags

Place a store order with POST /store/order and look it up by orderId

GET STARTED

Start building with BrightPlanet's Harvest REST APIs

Explore with Jentic

View OpenAPI Document

BrightPlanet's Harvest REST APIs expose document harvesting and data extraction services that index, store, and retrieve content gathered by BrightPlanet's web crawling infrastructure. The published OpenAPI specification follows the Petstore sample template, exposing 20 endpoints across pet, store, and user resource groups for programmatic interaction. Authentication is supported through OAuth 2.0 and the api_key header, allowing agents to authenticate calls before fetching, listing, or modifying records. The service is intended for teams integrating BrightPlanet harvesting output into downstream analytics, search, or compliance workflows.

Use Cases

Patterns agents use BrightPlanet's Harvest REST APIs for, with concrete tasks.

★ Pet Catalogue Management

Maintain the pet resource collection by adding new pets, updating existing records, and deleting retired entries through the /pet endpoints. The API supports lookup by ID, by status, and by tag, so an integration can keep a downstream catalogue synchronized without scraping HTML. A typical sync job runs in minutes once authentication is wired up.

Call POST /pet to add a pet named 'doggie' with status 'available', then GET /pet/{petId} to confirm the record was created.

Store Order Processing

Create and track purchase orders against the store resource using POST /store/order and GET /store/order/{orderId}. The /store/inventory endpoint exposes counts of pets by status, useful for dashboards or fulfilment automation. Orders can be removed with DELETE /store/order/{orderId} when they are cancelled.

POST /store/order with petId and quantity, then poll GET /store/order/{orderId} until the order status changes from 'placed' to 'approved'.

User Account Provisioning

Provision and manage user accounts through the /user collection, including bulk creation via /user/createWithList and session handling through /user/login and /user/logout. Username-keyed endpoints support read, update, and delete operations on individual records.

POST /user/createWithList with an array of three users, then GET /user/{username} for each to verify creation.

AI Agent Catalogue Sync via Jentic

An AI agent uses Jentic to discover the BrightPlanet Harvest endpoints, load their schemas, and execute create/list/update operations on pet, store, and user records without parsing the OpenAPI spec by hand. Credentials stay in the Jentic vault, so the agent only handles scoped tokens.

Search Jentic for 'add a pet record' and execute POST /pet with the returned schema, then list pets by status to verify.

Key Endpoints

20 endpoints — brightplanet's harvest rest apis expose document harvesting and data extraction services that index, store, and retrieve content gathered by brightplanet's web crawling infrastructure.

METHOD

PATH

DESCRIPTION

POST

/pet

Add a new pet to the store

GET

/pet/findByStatus

Find pets by status

POST

/store/order

Place an order for a pet

GET

/store/inventory

Returns pet inventories by status

POST

/user/createWithList

Create a list of users

GET

/user/login

Log a user in

POST

/pet

Add a new pet to the store

GET

/pet/findByStatus

Find pets by status

POST

/store/order

Place an order for a pet

GET

/store/inventory

Returns pet inventories by status

POST

/user/createWithList

Create a list of users

GET

Why Jentic?

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

Credential isolation

BrightPlanet OAuth tokens and api_key headers are stored encrypted in the Jentic vault. Agents receive a scoped reference rather than the secret, so /pet and /user calls never expose raw credentials to the agent runtime.

Intent-based discovery

Agents search Jentic with intents like 'add a pet record' or 'place a store order' and receive the matching BrightPlanet operation with its parameter schema, ready to execute without parsing the OpenAPI document directly.

Time to first call

Direct integration: 1-2 days to wire OAuth, retries, and pagination across 20 endpoints. Through Jentic: under an hour from search to first successful call.

FAQs

Specific to using BrightPlanet's Harvest REST APIs through Jentic.

What authentication does the BrightPlanet Harvest API use?

The spec defines two security schemes: OAuth 2.0 (petstore_auth) and an api_key header. Through Jentic, both credential types are stored encrypted in the vault and injected at execution time, so the agent only ever sees a scoped token rather than your raw key.

Can I find pets by status with the BrightPlanet Harvest API?

Yes. GET /pet/findByStatus accepts a status query parameter and returns matching pet records. GET /pet/findByTags is also available when you want to filter by tag instead of status.

What are the rate limits for the BrightPlanet Harvest API?

The OpenAPI spec does not declare rate limits. Treat the service as bounded and apply client-side throttling and retries with exponential backoff when running batch jobs against /pet or /user endpoints.

How do I create a user through the BrightPlanet Harvest API via Jentic?

Run pip install jentic, then search Jentic for 'create a user' to get the schema for POST /user. Load and execute the operation with the user payload; Jentic injects the api_key or OAuth token from the vault so your agent code never holds the secret.

Does the BrightPlanet Harvest API support image uploads?

Yes. POST /pet/{petId}/uploadImage accepts an image and attaches it to the specified pet record. Jentic exposes this as a discrete operation you can call after creating or updating the pet.

Can I delete an order through the BrightPlanet Harvest API?

Yes. DELETE /store/order/{orderId} removes a previously placed order. Pair it with GET /store/order/{orderId} to verify the order existed before deletion and confirm a 404 afterwards.

Documentapi Brightplanet BrightPlanet's Harvest REST APIs

Connect the BrightPlanet's Harvest REST APIs to your agent

Capabilities

Start building with BrightPlanet's Harvest REST APIs

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs