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 automations API

The automations API from Capy — 3 operation(s) for automations.

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

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

This API exposes 6 operations across 3 paths, and defines 7 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.

6 operations 3 paths 7 schemas 1 DELETE2 GET1 PATCH2 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://capy.ai/api/v1/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Capy automations 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 6

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

automations 6
GET
/v1/projects/{projectId}/automations
List automations
listAutomations 6 params → 200401403404422500
POST
/v1/projects/{projectId}/automations
Create automation
createAutomation 2 params body → 200401403404422500
GET
/v1/projects/{projectId}/automations/{automationId}
Get automation
getAutomation 3 params → 200401403404422500
PATCH
/v1/projects/{projectId}/automations/{automationId}
Update automation
updateAutomation 3 params body → 200401403404422500
DELETE
/v1/projects/{projectId}/automations/{automationId}
Delete automation
deleteAutomation 3 params → 200401403404422500
POST
/v1/projects/{projectId}/automations/{automationId}/trigger
Trigger automation
triggerAutomation 3 params → 200401403404422500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Automation (26 properties), CreateAutomationBody (17 properties), UpdateAutomationBody (17 properties), TriggerAutomationResponse (3 properties). Each schema is shown below with its type and property counts.

ListAutomationsResponse
object
3 properties 3 required
DeleteAutomationResponse
object
2 properties 2 required
UpdateAutomationBody
object
17 properties
CreateAutomationBody
object
17 properties 2 required
TriggerAutomationResponse
object
3 properties 3 required
ErrorResponse
object
1 property 1 required
Automation
object
26 properties 26 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capy-automations-api-openapi.yml Raw ↑

Other APIs Capy publishes across the network.

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