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

Speakeasy Artifacts API

REST APIs for working with Registry artifacts

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

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

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

Requests are made against a single base URL, https://api.prod.speakeasy.com.

11 operations 9 paths 16 schemas 6 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.4.0
Base URL
https://api.prod.speakeasy.com
Authentication
API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Speakeasy Artifacts API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (APIKey). An API key is passed in the header as x-workspace-identifier (WorkspaceIdentifier). It accepts HTTP bearer tokens (Bearer). By default, every request must be authenticated.

  • APIKey — The API Key for the workspace
  • WorkspaceIdentifier — The API Key for the workspace
  • Bearer — The Bearer token for the workspace

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 6 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Artifacts 11

REST APIs for working with Registry artifacts

POST
/v1/artifacts/preflight
Get access token for communicating with OCI distribution endpoints
preflight body → 2XX4XX
GET
/v1/artifacts/namespaces
Each namespace contains many revisions.
getNamespaces → 2XX4XX
POST
/v1/artifacts/namespaces/{namespace_name}/archive
Set whether a namespace is archived
archiveNamespace 1 param body → 2XX4XX
GET
/v1/artifacts/namespaces/{namespace_name}/revisions
getRevisions 2 params → 2XX4XX
GET
/v1/artifacts/namespaces/{namespace_name}/tags
getTags 1 param → 2XX4XX
POST
/v1/artifacts/namespaces/{namespace_name}/tags
Add tags to an existing revision
postTags 1 param body → 2XX4XX
POST
/v1/artifacts/namespaces/{namespace_name}/visibility
Set visibility of a namespace with an existing metadata entry
setVisibility 1 param body → 2XX4XX
GET
/v1/artifacts/remote_sources
Get remote sources attached to a particular namespace
listRemoteSources 1 param → 2XX4XX
POST
/v1/artifacts/remote_sources
Configure a new remote source
createRemoteSource body → 2XX4XX
GET
/v1/oci/v2/{organization_slug}/{workspace_slug}/{namespace_name}/manifests/{revision_reference}
Get manifest for a particular reference
getManifest 5 params → 2XX4XX
GET
/v1/oci/v2/{organization_slug}/{workspace_slug}/{namespace_name}/blobs/{digest}
Get blob for a particular digest
getBlob 4 params → 2XX4XX

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are RevisionContentsMetadata (13 properties), Annotations (12 properties), Namespace (8 properties), Revision (7 properties). Each schema is shown below with its type and property counts.

RemoteDocument
object
A document hosted in the registry
1 property 1 required
Error
object
The Status type defines a logical error model
2 properties 2 required
AddTags
object
Request body of tags to add to a revision
2 properties 2 required
GetTagsResponse
object
1 property 1 required
Revision
object
7 properties 6 required
Namespace
object
A namespace contains many revisions.
8 properties 4 required
RemoteSourceSubscriptionSettings
object
4 properties 3 required
Annotations
object
Annotations
12 properties
Manifest
object
Returns the requested manifest file
5 properties
V2Descriptor
object
V2 descriptor
4 properties
RevisionContentsMetadata
object
13 properties 13 required
RemoteSource
object
Remote source configuration
3 properties 2 required
GetNamespacesResponse
object
1 property 1 required
PreflightToken
object
A PreflightToken is a token that allows access to the OCI distribution endpoints.
1 property 1 required
Tag
object
4 properties 4 required
GetRevisionsResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

speakeasy-api-artifacts-api-openapi.yml Raw ↑

Other APIs Speakeasy publishes across the network.

Speakeasy Auth API
Speakeasy CodeSamples API
Speakeasy Events API
Speakeasy Github API
Speakeasy Organizations API
Speakeasy PublishingTokens API
Speakeasy Reports API
Speakeasy SchemaStore API
Speakeasy ShortURLs API
Speakeasy Subscriptions API
Speakeasy Suggest API
Speakeasy Workspaces API
Where this information came from

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