Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Theneo Publishing API

Publish and preview documentation.

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

This API exposes 4 JSON Schema definitions.

Tagged areas include Publishing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, rate-limit docs, and 4 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

2 operations 2 paths 3 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.theneo.io
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Theneo Publishing API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — API key for authentication. Generate from the Theneo dashboard. Can also be set via the THENEOAPIKEY environment variable when using the CLI or SDK.

Paths & Operations 2

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

Publishing 2

Publish and preview documentation.

POST
/projects/{projectId}/publish
Publish Project
publishProject 1 param → 200401404
GET
/projects/{projectId}/preview
Get Preview Project Link
getPreviewProjectLink 1 param → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are PublishResponse (2 properties), Error (2 properties), PreviewLinkResponse (1 property). Each schema is shown below with its type and property counts.

Error
object
2 properties
PublishResponse
object
2 properties
PreviewLinkResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

theneo-publishing-api-openapi.yml Raw ↑

Other APIs Theneo publishes across the network.

Theneo Import API
Theneo Projects API
Theneo Users API
Theneo Workspaces API