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

Teambridge Documents API

Endpoints for uploading and managing documents.

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

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://open-api.teambridge.com.

1 operations 1 paths 4 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://open-api.teambridge.com
Authentication
OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 2

Teambridge Documents API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 1 scope. An API key is passed in the header as X-Webhook-Signature (WebhookSignature). By default, every request must be authenticated.

  • WebhookSignature — HMAC-SHA256 signature for webhook authentication. The signature is computed from the concatenation of the timestamp and request body: {timestamp}.{body}. The s…

Paths & Operations 1

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

Documents 1

Endpoints for uploading and managing documents.

POST
/v1/documents
Upload a document
body → 200400401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CreateDocumentRequest (6 properties), CreateDocumentResponse (5 properties), StandardErrorResponse (2 properties), ErrorDetail (2 properties). Each schema is shown below with its type and property counts.

ErrorDetail
object
2 properties 2 required
CreateDocumentRequest
object
6 properties
CreateDocumentResponse
object
5 properties 3 required
StandardErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teambridge-documents-api-openapi.yml Raw ↑

Other APIs Teambridge publishes across the network.

Teambridge Collections (Unified API) API
Teambridge Mappings API
Teambridge Utilities API