Copia APIDocs.copia.io ↗
Access the full Copia Automation documentation via API. List all 154 pages, full-text search, and retrieve page content with headings and breadcrumbs.
What is the Copia API?
The Docs.copia.io API exposes 3 endpoints that cover the entire Copia Automation documentation site — roughly 154 pages spanning Git-Based Source Control, DeviceLink, Copilot, Actions, and Support. Use list_pages to retrieve the full table of contents, search_docs for ranked full-text search with excerpt snippets, and get_page to pull the structured text and headings of any specific documentation page.
No input parameters required.
curl -X GET 'https://api.parse.bot/scraper/fd298060-4c04-4c54-9ed5-170e668bb09c/list_pages' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace docs-copia-io-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
from parse_apis.copia_documentation_api import CopiaDoc, PageSummary, SearchResult
client = CopiaDoc()
# List all documentation pages
for summary in client.pages.list():
print(summary.title, summary.path, summary.breadcrumbs)
# Search for documentation about DeviceLink
for result in client.pages.search(query="DeviceLink backup"):
print(result.title, result.score, result.breadcrumbs)
if result.best_section:
print(result.best_section.title, result.best_section.body)
# Get the full content of a specific page
page = client.pages.get(path="overview/glossary")
print(page.title, page.url, page.content)
for heading in page.headings:
print(heading.level, heading.text)
# Navigate from a search result to its full page content
for result in client.pages.search(query="branching"):
full_page = result.details()
print(full_page.title, full_page.url)
break
Returns the full table of contents for the Copia documentation site, including all page titles, paths, descriptions, and breadcrumb navigation hierarchy. Contains approximately 155 pages covering Git-Based Source Control, DeviceLink, Copilot, Actions, and Support sections. Single-page response with no pagination parameter.
No input parameters required.
{
"type": "object",
"fields": {
"pages": "array of page objects with id, title, path, description, and breadcrumbs",
"total": "integer - number of pages in the documentation"
},
"sample": {
"data": {
"pages": [
{
"id": "zB1wc2VrN5sWpnJRKM7A",
"path": "/docs",
"title": "Introduction",
"breadcrumbs": [
"Overview"
],
"description": ""
},
{
"id": "gGjOG7wb4UFqpcHoUPX6",
"path": "/docs/overview/readme/overview",
"title": "Git-Based Source Control",
"breadcrumbs": [
"Overview",
"Introduction"
],
"description": "Git-based source control by Copia Automation"
}
],
"total": 155
},
"status": "success"
}
}About the Copia API
Navigating the Documentation Structure
list_pages returns the complete table of contents for docs.copia.io as an array of page objects, each containing an id, title, path, description, and a breadcrumbs array that reflects the navigation hierarchy. The total field confirms the current page count, which is approximately 154 at the time of release. This is useful for building search indexes, content audits, or surfacing documentation coverage to end users.
Searching Across All Pages
search_docs accepts a query string and returns results ranked by relevance score. Each result includes the page title, path, breadcrumbs, and a best_section field — a short excerpt from the most relevant passage on that page. This makes it practical to present contextual previews without fetching the full page. Example queries include terms like 'DeviceLink backup', 'branching', or 'Rockwell' to target specific product areas or tasks.
Retrieving Full Page Content
get_page takes a path parameter such as 'overview/glossary' or 'git-based-source-control/getting-started' and returns the full content string alongside a headings array. Each heading object includes a level (integer 1–4) and text, letting you reconstruct the document outline. The response also includes the canonical url and normalized path for the page, which is useful for linking back to the source.
The Copia API is a managed, monitored endpoint for Docs.copia.io — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when Docs.copia.io changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official Docs.copia.io API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Build an in-product help search for Copia Automation users using
search_docsrelevance scores andbest_sectionexcerpts. - Generate a site map or documentation index by calling
list_pagesand reading thebreadcrumbshierarchy. - Check documentation coverage for a specific feature area (e.g., DeviceLink or Copilot) by filtering
list_pagesresults by path prefix. - Feed structured heading outlines from
get_pageinto a knowledge base or LLM context window. - Monitor documentation changes over time by periodically calling
list_pagesand comparingtotaland pageidvalues. - Surface contextual help tooltips in an IDE or automation tool by querying
search_docswith user-entered terms and displayingbest_section. - Extract and index the full text of all documentation pages for offline search or compliance archiving using
get_pagein batch.
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 200 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
| Team | $300/mo | 20,000 | 300 req/min |
| Company | $1,000/mo | 100,000 | 500 req/min |
Each endpoint has a fixed posted price per successful call — most fall between 1 and 10 credits — shown on this API's page before you run it. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does Copia Automation provide an official developer API for their documentation site?+
What does the `best_section` field in `search_docs` results contain?+
best_section field contains a short text excerpt from the highest-relevance passage on the matched page. It is meant to serve as a preview snippet — similar to a search engine snippet — so callers can show meaningful context without loading the full page via get_page.Does the API return the raw HTML or markdown source of documentation pages?+
get_page returns plain text via the content field and a structured headings array with level and text per heading. Raw HTML or original markdown source is not exposed. If you need to reconstruct document structure, the headings array (levels 1–4) is the primary tool available.Does the API cover documentation pages that require a login on docs.copia.io?+
list_pages reflect the publicly available documentation. You can fork this API on Parse and revise it to target additional paths if Copia makes more content publicly accessible in the future.Can I retrieve version-specific documentation or filter pages by product section?+
list_pages returns all pages, and get_page requires an exact path. You can filter by section client-side using the path or breadcrumbs fields returned by list_pages. You can fork this API on Parse and revise it to add a section or version filter endpoint if your use case requires it.