How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

yappy-biz Documentation API

Documentation pages, FAQ, and search.

yappy-biz Documentation API is one of 7 APIs that yappy-biz publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Documentation. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://yappy.biz/api/v1, https://yappy.biz/api/v1/sandbox.

4 operations 4 paths 9 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://yappy.biz/api/v1
Authentication
HTTP Bearer, OAuth 2.0
License
Proprietary — LicenseRef-Proprietary
Terms of Service
Resource Areas
1

Authentication & Security 2

yappy-biz Documentation API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (opaque) (bearerAuth). It supports OAuth 2.0 (oauth2) using the clientCredentials and authorizationCode flows, exposing 5 scopes. By default, every request must be authenticated, though some operations may also be called without credentials.

  • bearerAuth — An access token from /oauth/token. Optional — every read endpoint also answers anonymously.
  • oauth2 — OAuth 2.1 with PKCE S256. Dynamic client registration (RFC 7591) at /oauth/register; no human approval step.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Documentation 4

Documentation pages, FAQ, and search.

GET
/docs
List documentation pages
listDocs 2 params → 200400401403429500503
GET
/docs/{slug}
Get one documentation page
getDoc 1 param → 200404400401403429500503
GET
/faq
List frequently asked questions
listFaq 2 params → 200400401403429500503
GET
/search
Search documentation and FAQ
search 4 params → 200400401403429500503

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Doc (10 properties), DocSummary (9 properties), Problem (9 properties), SearchResult (8 properties). Each schema is shown below with its type and property counts.

DocList
object
A cursor-paginated page of documentation entries.
4 properties 3 required
Doc
object
A documentation page, content included.
10 properties 7 required
SearchResult
object
One hit, with enough context to quote and cite.
8 properties 6 required
Faq
object
One question and its answer.
6 properties 4 required
SearchResults
object
Ranked search results with the query echoed back.
5 properties 4 required
Problem
object
RFC 9457 problem details. Branch on code, which is stable; title and detail are prose for a human or for an agent explaining itself.
9 properties 4 required
DocSummary
object
A documentation page without its body.
9 properties 6 required
Pagination
object
Cursor pagination. When hasmore is false, nextcursor is null.
4 properties 3 required
FaqList
object
A cursor-paginated page of FAQ entries.
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yappy-biz-documentation-api-openapi.yml Raw ↑

Other APIs yappy-biz publishes across the network.

yappy-biz Batch API
yappy-biz Commerce API
yappy-biz Discovery API
yappy-biz Exports API
yappy-biz Product API
yappy-biz Releases API
Where this information came from

This is an independent, third-party profile of yappy-biz Documentation API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.