Developers/Your first API request
Get started
Your first API request
Create a workspace and service key, then retrieve a public page with curl. You do not need to install an SDK.
1. Create your workspace and key
- Open the developer console and create a workspace.
- Save the personal sign-in key and offline recovery code privately. These are account credentials, not API keys.
- Add prepaid credits. $20 buys 20,000 shared credits; Parse uses 1 and Retrieve uses 5 per successful page.
- Create a service key with the
retrievescope for this example. Save the secret when it is shown.
ShellCopy
# Set this only in your private server or local development environment.
# Replace the value with your service key; never commit it.
export OPTIVIEW_API_KEY='YOUR_SERVICE_KEY'
There is no separate API sandbox endpoint in this guide. Successful calls use the selected workspace’s prepaid credits. Use the free public demo to inspect supported output before integrating.
2. Retrieve a public page
curlCopy
curl --request POST 'https://api.optiview.ai/v1/retrieve' \
--header "Authorization: Bearer $OPTIVIEW_API_KEY" \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: retrieve-example-001' \
--data '{"url":"https://optiview.ai/products/parse/"}'
The example processes Optiview’s public Parse product page. For HTML you already have, use the Parse endpoint. Your source still needs to meet the product’s access and content requirements.
Save your idempotency key before submitting. Reuse it with identical input if the network times out. Use a new key for a different work item.
3. Check the job status
The API returns a job record, not Markdown alone. A direct request returns HTTP 200 for a completed job and HTTP 202 for queued or running work. A failed job can also return HTTP 200, so always check status before reading result.
Only status: succeeded with a result is usable output. HTTP success alone does not mean processing succeeded.
For complete state and result schemas, see Jobs and results. Use the original service application to read its job.
Pending response exampleCopy
{
"id": "b7cde704-3564-4e3f-886d-a45c481c931f",
"product": "retrieve",
"status": "queued",
"credits_reserved": 5,
"result_url": "/v1/jobs/b7cde704-3564-4e3f-886d-a45c481c931f"
}
If the status is queued or running, wait at least two seconds and read its ID with the same service key:
curlCopy
curl 'https://api.optiview.ai/v1/jobs/JOB_ID' \
--header "Authorization: Bearer $OPTIVIEW_API_KEY"
Once it succeeds, read result.markdown. Save the result in your own system; API availability ends seven days after job creation. Polling an existing job adds no credit charge, but does count toward request limits.
4. Add it to your application
Choose the JavaScript client or Python integration example, then implement error handling and safe retries. The OpenAPI contract describes every public endpoint.
Additional source context
Your website was built for people. Optiview makes it ready for AI, too.
Get started
API reference
Parse HTML · Retrieve a webpage · Jobs and results · Usage and credits · Errors and retries · Limits and retention
Integrations
JavaScript · Python · MCP for agents · OpenAPI specification · Changelog
Try Optiview
See my site with Optiview · Run your free AI Audit
Explore
Publish · Parse · Retrieve · Pricing
Learn
Guides · Developer docs · Research & thinking · Experiments & methods · AI Audit · AI agent directory · FAQ
Company
About Optiview · Agencies · Contact · Privacy · Billing terms
Additional page links
- Developer docs API v1 — Documentation sidebar
- Developer terms — Documentation sidebar
- Contact support — Documentation sidebar
Published brand narrative
Site-wide brand information
Who we are
Optiview — Parse, Retrieve and Publish for AI
Optiview helps businesses and developers make website information easier for AI to use. Parse converts supplied HTML into clean Markdown and source metadata. Retrieve fetches an eligible public HTTPS webpage and prepares its content. Publish helps a verified business prepare its own website content and make approved Narrative Graph context available through a supported connection.
Parse and Retrieve use application keys and a prepaid developer wallet. Publish has separate website setup, ownership checks and a subscription. Optiview does not control whether an outside AI service discovers, uses or cites the resulting content.
Applies to: Optiview
Why we matter
A clearer source, from website content to business context
Webpages mix useful information with navigation, layout and application code. Businesses may also have important qualifications, answers and context that are not clearly published.
Optiview gives developers a way to prepare source content for their applications, and gives businesses a way to publish the context their teams approve. Your application chooses how to use Parse and Retrieve results. Your business controls what it publishes through Publish.
Clearer publishing makes information available; it does not determine an AI system’s answer. Each outside service chooses its own retrieval, recommendations and citations.
What we offer
Three products, with separate jobs and clear pricing
- Optiview Parse: Supply complete HTML and a source URL. Receive clean Markdown, source and output hashes, parser details and processing warnings. Parse does not fetch the URL or execute JavaScript. A successful page uses 1 credit.
- Optiview Retrieve: Supply one eligible public HTTPS URL. Optiview checks supported access and publisher policies, fetches anonymous static HTML and parses it. It does not search the web, execute JavaScript, bypass a login or access private networks. A successful page uses 5 credits total, including parsing.
- Developer credits: USD $20 buys 20,000 credits shared by Parse and Retrieve. There is no developer subscription, automatic recharge or scheduled credit expiration. Failed jobs consume no credits. Applicable taxes and the total appear at checkout. Source size, quotas and retention limits apply.
- Optiview Publish: USD $99 per website per month plus applicable tax. Connect a verified website, review the prepared source and optionally maintain approved Narrative Graph context in Identity, Story, Offerings, Trust, Knowledge and Actions. Choose site-wide or exact-page scope. Saving drafts does not publish them. Eligible AI tools can receive prepared Markdown or HTML through supported delivery, while ordinary visitors keep the normal website.
Developer credits do not purchase Publish subscriptions. Parse and Retrieve do not add a customer’s private Narrative Graph to arbitrary third-party pages. See https://optiview.ai/pricing/ and https://optiview.ai/developers/ for the current offer and limits.
Why trust us
Inspect the output and understand what the evidence establishes
Developers can inspect the prepared Markdown, job status, source metadata, processing warnings and credit ledger. Retrieve records the public source response it observed; Parse identifies supplied HTML rather than claiming to verify the current origin.
Publish administrators can review parser output, the combined published-output preview, source checks and publication history. A preview is separate from a recorded live delivery. Saved edits remain separate from the active publication until explicitly published.
Our experiment pages contain selected first-party AI conversations and source comparisons. Delivery records establish what was served, not downstream ingestion, recommendations, citations or revenue. Observed language matches do not establish causation or a consistent visibility improvement. Explore the evidence and limitations at https://optiview.ai/proof/.
Helpful knowledge
Common questions about the three products
Which product should I use? Use Parse when you already have HTML. Use Retrieve when you need Optiview to fetch one eligible public page first. Use Publish when your business wants to prepare its verified website and publish approved context.
Do Parse and Retrieve require website ownership or DNS changes? No website connection is needed for these developer products. You remain responsible for source rights and permitted downstream use. Public availability does not grant a reuse license.
How do developer accounts and keys work? Create a developer workspace and save the personal sign-in key and offline recovery code. Create scoped service keys for server-side applications. Email is an unverified contact identifier, not account-ownership proof or an email-only recovery method. Keep all credentials private.
Can my agent use Optiview? The authenticated developer API returns prepared content for your application or model. A downloadable JavaScript client and local MCP adapter are available. Your host must authorize sources and any credit expenditure. Compatibility does not establish adoption or a partnership with an AI provider.
Does the API include my private Narrative Graph? Parse and Retrieve are source-only. Verified website publishing and approved publisher context belong to the separate Publish workflow.
Does Publish replace our website or CMS? No. Your website stays in its existing system. Your web team establishes and tests a supported connection. Your team reviews and explicitly publishes any Narrative Graph additions. Ordinary visitors retain the normal website experience.
Does every AI tool get the prepared version? No. Delivery depends on the website connection, source eligibility and the request. Some tools explicitly request Markdown; supported AI requests may also receive prepared Markdown or HTML through eligible delivery paths. Traditional search crawlers retain the original website response. A claimed tool name does not prove the requester’s identity.
Does the demo publish or save to our workspace? No. The public demo is a separate preview. Its AI-generated examples require review and do not transfer automatically into an approved publication.
Will Optiview guarantee citations or recommendations? No. Optiview prepares and publishes sources. Outside AI services choose what to retrieve, use and cite.
What to do next
Choose your starting point
- Compare Parse, Retrieve and Publish to choose the right workflow.
- Create a developer workspace for self-service Parse and Retrieve, then add credits and create an application key.
- Read the API quickstart and agent-tool setup for request examples, supported sources, errors, quotas and downloads.
- Review pricing and terms for prepaid credits and the separate Publish plan.
- Preview your website to inspect prepared content and explore unapproved narrative examples without connecting or publishing.
- Plan Publish setup with your web team. Publishing requires ownership checks, review and a supported connection; contact hello@optiview.ai for assisted setup.
Already using Publish? Review your Narrative Graph, publish approved changes explicitly, inspect the combined source in Markdown and check recorded delivery in Activity. Keep your existing visibility tools to study downstream AI answers.