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

Apiary API

The Apiary API provides programmatic access to manage API projects, documentation, and team collaboration. It allows creating and updating API Blueprint and Swagger/OpenAPI documents, managing team members, and integrating Apiary workflows into CI/CD pipelines.

Apiary API is one of 2 APIs that Apiary publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include API Blueprint, API Design, Collaboration, Documentation, and Mock Servers. The published artifact set on APIs.io includes API documentation, a getting-started guide, an API reference, an OpenAPI specification, and 6 JSON Schemas.

This API exposes 9 operations across 7 paths, organized into 4 resource areas, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 2020-03-02.

Requests are made against a single base URL, https://api.apiary.io.

9 operations 7 paths 10 schemas 1 DELETE5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2020-03-02
Base URL
https://api.apiary.io
Authentication
HTTP Basic, HTTP Bearer, API Key
Terms of Service
Resource Areas
4

Authentication & Security 3

Apiary API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as Authentication (legacyToken).

  • basicAuth — HTTP Basic authentication with the Apiary account email and password. Used only on /authorization to mint, list and revoke tokens. Not available to users in ID…
  • bearerAuth — RFC 6750 Bearer token. Generate at https://login.apiary.io/tokens or via POST /authorization. Sent as Authorization: Bearer .
  • legacyToken — Legacy Apiary token header, sent as Authentication: Token (note: the header is Authentication, not Authorization). Apiary labels the /blueprint/ group legacy.…

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 3 POST. They span 4 resource areas: Authentication, User Information, API List, Blueprint. Each is listed below with its method, path, parameters, and response codes.

Authentication 3

Apiary API uses Bearer Token Authorization (RFC 6750). Tokens are managed at https://login.apiary.io/tokens, or created, listed and deleted over this resource using Basic Authenti…

POST
/authorization
Create an Authorization Token
createAuthorizationToken body → 201400401403
GET
/authorization
Get Existing Authorization Tokens
listAuthorizationTokens → 200401403
DELETE
/authorization
Delete an Existing Authorization Token
deleteAuthorizationToken body → 204400401403
User Information 1

Apiary API exposes authorized user information. You may only get your own user information.

GET
/me
Get Me
getMe → 200401403
API List 2

Apiary API exposes lists of APIs. Your authorization token grants access to private and public, personal and team API Projects.

GET
/me/apis
Get User API List
listMyApis → 200401403
GET
/me/teams/{teamId}/apis
Get Team API List
listTeamApis 1 param → 200401403404
Blueprint 3

Legacy API Blueprint utilities. These operations take the legacy Authentication: Token header rather than Authorization: Bearer.

POST
/blueprint/create
Create API Project
createApiProject body → 201
GET
/blueprint/get/{apiSubdomain}
Fetch Blueprint
fetchBlueprint 1 param → 200500503
POST
/blueprint/publish/{apiSubdomain}
Publish Blueprint
publishBlueprint 1 param body → 201500503

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Api (7 properties), User (4 properties), ApiProjectCreated (3 properties), Team (3 properties). Each schema is shown below with its type and property counts.

Error
object
The Apiary API error envelope — a single error string drawn from a closed enum.
1 property
LegacyError
object
The error envelope used by the legacy /blueprint/ group — a boolean flag plus free-text message.
2 properties
Token
object
3 properties
TokenList
object
1 property
Team
object
3 properties
User
object
4 properties
Api
object
7 properties
ApiList
object
1 property
ApiProjectCreated
object
3 properties
BlueprintEnvelope
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiary-apiary-api-openapi.yml Raw ↑

Other APIs Apiary publishes across the network.

API Blueprint
Where this information came from

This is an independent, third-party profile of Apiary 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.