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

Capy snapshots API

The snapshots API from Capy — 1 operation(s) for snapshots.

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

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

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

Requests are made against a single base URL, https://capy.ai/api.

2 operations 1 paths 4 schemas 1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://capy.ai/api/v1/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — API token (capyxxxx). Generate at capy.ai/settings/tokens

Paths & Operations 2

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

snapshots 2
GET
/v1/projects/{projectId}/snapshots
Get snapshots setting
getSnapshots 1 param → 200401403404422500
PATCH
/v1/projects/{projectId}/snapshots
Update snapshots setting
updateSnapshots 1 param body → 200401403404422500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are UpdateSnapshotsResponse (4 properties), Snapshots (1 property), ErrorResponse (1 property), UpdateSnapshotsBody (1 property). Each schema is shown below with its type and property counts.

UpdateSnapshotsBody
object
1 property 1 required
UpdateSnapshotsResponse
object
4 properties 1 required
ErrorResponse
object
1 property 1 required
Snapshots
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capy-snapshots-api-openapi.yml Raw ↑

Other APIs Capy publishes across the network.

Capy automations API
Capy browser-snapshots API
Capy environment-variables API
Capy models API
Capy projects API
Capy sessions API
Capy setup API
Capy tags API
Capy tasks API
Capy threads API
Capy usage API