Documentapi Brightplanet BrightPlanet's Harvest REST APIs
63
AI ReadinessAI-Aware (B)63/100
Community OpenAPI document · agent-readyData EnrichmentData Transformationoauth2, apiKey20 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Authenticate to BrightPlanet's Harvest service and call REST endpoints to create, retrieve, update, and delete pet, store order, and user records exposed by the spec.
Use for: I need to add a new pet record to the BrightPlanet store, Find all pets with status 'available', Retrieve a specific pet by its numeric ID, Place a store order for a pet and confirm placement
Not supported: Does not handle live web crawling, JavaScript rendering, or knowledge-graph extraction - use for the published pet, store, and user REST endpoints only.
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.
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.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fdocumentapi.brightplanet.com%2Fbrightplanet" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fdocumentapi.brightplanet.com%2Fbrightplanet" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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
Inspect store inventory counts grouped by status
Create individual users or batches of users via /user/createWithList
Authenticate user sessions through /user/login and /user/logout
Upload an image attached to a pet via /pet/{petId}/uploadImage
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 your Jentic One instance, 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
/user/login
Log a user in
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
B
BrightPlanet's Harvest REST APIs
- AI-Aware (B)63/100
99
Foundational Compliance59
Developer Experience & Jentic Compatibility53
AI-Readiness & Agent Experience94
Agent Usability43
Security61
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
99
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
59
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: C+Signals: 4
1%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
34%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
53
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
53%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
59%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
43
Security
Trust, risk posture, and security compliance.
Grade: D-Signals: 1
42%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
61
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B-Signals: 1
61%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring BrightPlanet's Harvest REST APIs by hand means handling both an OAuth2 flow and an api_key header, then pointing calls at the harvestapi host before you can create a pet or place an order. Through Jentic you install once, import BrightPlanet's Harvest REST APIs from the API Directory, store the api_key once, and your agent calls it.
Permission scoping
The Harvest API puts the resource id in the URL path (/pet/{petId}, /store/order/{orderId}, /user/{username}), so a rule can pin your agent to one pet, order, or user record. You choose the operations it may call, so a delete on a pet or order is not included unless you add it.
Credential isolation
Your BrightPlanet OAuth token and api_key are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'add a pet record' or 'place a store order', and Jentic returns the matching BrightPlanet operation with its parameter schema so the agent calls the right endpoint without parsing the OpenAPI document directly.
Related APIs
Alternatives and complements available in the Jentic catalogue.
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.
Can I limit what my agent is allowed to do with the BrightPlanet Harvest API?
Yes. Because you run Jentic One yourself, your own rules decide which Harvest operations the agent may call, so you can grant read and create access on /pet, /store/order, and /user while withholding deletes like DELETE /pet/{petId} or DELETE /store/order/{orderId}. Since the resource id lives in the URL path, a rule can pin the agent to a single pet, order, or user record rather than the whole collection. You also control which OAuth token and api_key it may use, so it only ever receives a scoped credential for the operations you allow.
GET STARTED