Capy

Capy Projects API

The projects API from Capy — 2 operation(s) for projects.

GitHub OpenAPI

Operations 5

GET /api/v1/projects List projects #
GET /api/v1/projects/{projectId} Get project #
GET /api/v1/projects/{projectId}/environment-variables List environment variables #
PUT /api/v1/projects/{projectId}/environment-variables Set environment variables #
DELETE /api/v1/projects/{projectId}/environment-variables Delete environment variables #

Documentation

📖
Documentation
https://docs.capy.ai
📖
APIReference
https://docs.capy.ai/api-reference/overview
📖
Authentication
https://artifacts.apis.io/capy/authentication/capy-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/capy/openapi/capy-projects-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/capy/errors/capy-problem-types.yml
🔗
Conventions
https://artifacts.apis.io/capy/conventions/capy-conventions.yml
🔗
DataModel
https://artifacts.apis.io/capy/data-model/capy-data-model.yml
🔗
Conformance
https://artifacts.apis.io/capy/conformance/capy-conformance.yml
🔗
Lifecycle
https://artifacts.apis.io/capy/lifecycle/capy-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/capy:capy-projects-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

capy-projects-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Capy Projects API
  version: 1.0.0
  description: Programmatic access to Capy's agent platform.
servers:
- url: https://api.capy.ai
security:
- bearerAuth: []
tags:
- name: Projects
paths:
  /api/v1/projects:
    get:
      tags:
      - Projects
      operationId: projects.list
      parameters: []
      security:
      - bearerAuth: []
      responses:
        '200':
          description: ProjectList
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListEncoded'
        '401':
          description: capy/Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_UnauthorizedEncoded'
        '403':
          description: capy/Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_ForbiddenEncoded'
        '429':
          description: capy/RateLimited
          headers:
            retry-after:
              schema:
                type: integer
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_RateLimitedEncoded'
      summary: List projects
  /api/v1/projects/{projectId}:
    get:
      tags:
      - Projects
      operationId: projects.get
      parameters:
      - name: projectId
        in: path
        schema:
          type: string
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectEncoded'
        '401':
          description: capy/Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_UnauthorizedEncoded'
        '403':
          description: capy/Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_ForbiddenEncoded'
        '404':
          description: capy/ProjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_ProjectNotFoundEncoded'
        '429':
          description: capy/RateLimited
          headers:
            retry-after:
              schema:
                type: integer
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_RateLimitedEncoded'
      summary: Get project
  /api/v1/projects/{projectId}/environment-variables:
    get:
      tags:
      - Projects
      operationId: projects.listEnvironmentVariables
      parameters:
      - name: projectId
        in: path
        schema:
          type: string
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: EnvironmentVariableList
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariableListEncoded'
        '401':
          description: capy/Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_UnauthorizedEncoded'
        '403':
          description: capy/Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_ForbiddenEncoded'
        '404':
          description: capy/ProjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_ProjectNotFoundEncoded'
        '429':
          description: capy/RateLimited
          headers:
            retry-after:
              schema:
                type: integer
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_RateLimitedEncoded'
      summary: List environment variables
    put:
      tags:
      - Projects
      operationId: projects.setEnvironmentVariables
      parameters:
      - name: projectId
        in: path
        schema:
          type: string
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: EnvironmentVariableList
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariableListEncoded'
        '400':
          description: capy/InvalidRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_InvalidRequestEncoded'
        '401':
          description: capy/Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_UnauthorizedEncoded'
        '403':
          description: capy/Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/capy_ForbiddenEncoded'
                - $ref: '#/components/schemas/capy_ForbiddenEncoded'
        '404':
          description: capy/ProjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_ProjectNotFoundEncoded'
        '429':
          description: capy/RateLimited
          headers:
            retry-after:
              schema:
                type: integer
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_RateLimitedEncoded'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetEnvironmentVariablesRequest'
        required: true
      summary: Set environment variables
    delete:
      tags:
      - Projects
      operationId: projects.deleteEnvironmentVariables
      parameters:
      - name: projectId
        in: path
        schema:
          type: string
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: EnvironmentVariableList
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariableListEncoded'
        '401':
          description: capy/Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_UnauthorizedEncoded'
        '403':
          description: capy/Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/capy_ForbiddenEncoded'
                - $ref: '#/components/schemas/capy_ForbiddenEncoded'
        '404':
          description: capy/ProjectNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_ProjectNotFoundEncoded'
        '429':
          description: capy/RateLimited
          headers:
            retry-after:
              schema:
                type: integer
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capy_RateLimitedEncoded'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEnvironmentVariablesRequest'
        required: true
      summary: Delete environment variables
components:
  schemas:
    capy_ProjectNotFoundEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
          - capy/ProjectNotFound
        projectId:
          type: string
      required:
      - _tag
      - projectId
      additionalProperties: false
    ProjectListEncoded:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ProjectEncoded'
      required:
      - items
      additionalProperties: false
    EnvironmentVariableEncoded:
      type: object
      properties:
        name:
          type: string
        description:
          anyOf:
          - type: string
          - type: 'null'
        updatedAt:
          type: string
      required:
      - name
      - description
      - updatedAt
      additionalProperties: false
    capy_RateLimitedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
          - capy/RateLimited
        retryAfterSeconds:
          type: integer
      required:
      - _tag
      - retryAfterSeconds
      additionalProperties: false
    EnvironmentVariableListEncoded:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentVariableEncoded'
      required:
      - items
      additionalProperties: false
    ProjectRepoEncoded:
      type: object
      properties:
        repoFullName:
          type: string
        baseBranch:
          type: string
        mode:
          type: string
          enum:
          - primary
          - lazy
      required:
      - repoFullName
      - baseBranch
      - mode
      additionalProperties: false
    DeleteEnvironmentVariablesRequest:
      type: object
      properties:
        names:
          type: array
          items:
            type: string
            pattern: ^[A-Za-z_][A-Za-z0-9_]*$
          minItems: 1
          maxItems: 500
      required:
      - names
      additionalProperties: false
    capy_UnauthorizedEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
          - capy/Unauthorized
      required:
      - _tag
      additionalProperties: false
    capy_InvalidRequestEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
          - capy/InvalidRequest
        message:
          type: string
      required:
      - _tag
      - message
      additionalProperties: false
    ProjectEncoded:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          anyOf:
          - type: string
          - type: 'null'
        code:
          type: string
          allOf:
          - minLength: 1
          - maxLength: 255
        visibility:
          type: string
          enum:
          - org
          - private
        repos:
          type: array
          items:
            $ref: '#/components/schemas/ProjectRepoEncoded'
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
      - id
      - name
      - description
      - code
      - visibility
      - repos
      - createdAt
      - updatedAt
      additionalProperties: false
    capy_ForbiddenEncoded:
      type: object
      properties:
        _tag:
          type: string
          enum:
          - capy/Forbidden
      required:
      - _tag
      additionalProperties: false
    SetEnvironmentVariablesRequest:
      type: object
      properties:
        entries:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                pattern: ^[A-Za-z_][A-Za-z0-9_]*$
              value:
                type: string
              description:
                type: string
            required:
            - name
            - value
            additionalProperties: false
          minItems: 1
          maxItems: 500
      required:
      - entries
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Capy API key
      description: An API key created in Capy under Settings → API.
x-provenance:
  method: harvested
  publisher: Capy
  source: https://docs.capy.ai/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)