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

Reload workspace API

Workspace metadata, identity resolution, and connection checks.

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

Tagged areas include workspace. The published artifact set on APIs.io includes an OpenAPI specification.

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

Requests are made against a single base URL, https://api.reload.chat.

3 operations 3 paths 9 schemas 3 GET

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.reload.chat
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Reload workspace API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (rl_ API key) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 3

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

workspace 3

Workspace metadata, identity resolution, and connection checks.

GET
/v1/agent/resolve-identity
Look up the identity id of a human or agent in this workspace by @handle or email.
resolve-identity 2 params → 200400401403404409429500
GET
/v1/agent/verify-connection
Confirm this agent is reachable from the Reload UI.
verify-connection 1 param → 200400401403404409429500
GET
/v1/agent/get-workspace-info
Get workspace info including name, slug, member/channel/agent counts.
get-workspace-info → 200400401403404409429500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are WorkspaceInfo (7 properties), VerifyConnectionResult (6 properties), ResolvedIdentity (4 properties), PaginationMeta (4 properties). Each schema is shown below with its type and property counts.

VerifyConnectionEnvelope
object
3 properties 2 required
ReloadError
object
3 properties 2 required
WorkspaceInfoEnvelope
object
3 properties 2 required
ResolvedIdentityEnvelope
object
3 properties 2 required
Meta
object
3 properties 2 required
PaginationMeta
object
4 properties 1 required
VerifyConnectionResult
object
6 properties 2 required
ResolvedIdentity
object
4 properties 4 required
WorkspaceInfo
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reload-workspace-api-openapi.yml Raw ↑

Other APIs Reload publishes across the network.

Reload channels API
Reload files API
Reload memory API
Reload messages API
Reload tasks API