Cavuno Operator API

openapi: 3.2.0
info:
  title: Cavuno v1 REST Operator API
  version: 1.0.0
  description: 'The Cavuno API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. ## Base URL


    Production: `https://api.cavuno.com/v1`


    All API requests must be made over HTTPS. Calls made over plain HTTP will fail. ## Authentication


    The Cavuno API uses API keys to authenticate requests. You can view and manage your API keys in the Cavuno dashboard, under Settings → Developer → API keys. Cavuno API keys have the prefix `cavuno_live_`. Your API keys carry many privileges, so be sure to keep them secure. Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via Bearer auth. Provide your API key as the bearer token in the `Authorization` header:


    ```bash

    curl https://api.cavuno.com/v1/jobs \

    -H "Authorization: Bearer YOUR_SECRET_API_KEY"

    ```


    API requests without authentication will fail. ## Rate limits


    The Cavuno API has rate limits in place to ensure stability and reliability. By default, API keys are limited to 100 requests per minute. If you exceed your limit, requests return an HTTP 429 response with a `Retry-After` header indicating when you can try again. If you have a use case that needs a higher limit, contact support. ## Idempotency


    The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a job fails due to a network connection error, you can safely retry the request with the same idempotency key, and we''ll guarantee that only one job is created. To perform an idempotent request, provide an additional `Idempotency-Key` header on any `POST`, `PATCH`, or `DELETE` request:


    ```bash

    curl https://api.cavuno.com/v1/jobs \

    -X POST \

    -H "Authorization: Bearer cavuno_live_..." \

    -H "Idempotency-Key: $(uuidgen)" \

    -H "Content-Type: application/json" \

    -d ''{ "title": "Senior Engineer" }''

    ```


    ## Errors


    Cavuno uses conventional HTTP response codes to indicate the success or failure of an API request. In general: codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that failed given the information provided (e.g., a required parameter was omitted), and codes in the `5xx` range indicate an error with Cavuno''s servers (these are rare). Error responses include a JSON body with details:


    ```json

    {

    "error": {

    "code": "validation_bad_request",

    "message": "Field ''title'' is required.",

    "requestId": "req_..."

    }

    }

    ```


    Some errors carry an additional `details` field with structured context, such as per-field validation issues. ### Plan upgrade hints


    When an Operator API request is refused because of the board''s Cavuno plan, the error also carries an `upgrade` object. It names the capability that blocked the request, the cheapest self-serve plan that unlocks it (when that can be told), and the hosted billing endpoints that start the upgrade:


    ```json

    {

    "error": {

    "code": "settings_plan_required_for_branding_removal",

    "message": "Removing Cavuno branding requires a plan that includes branding removal.",

    "requestId": "req_...",

    "upgrade": {

    "capability": "canRemoveBranding",

    "requiredPlan": "basic",

    "checkout": { "method": "POST", "path": "/v1/billing/checkout" },

    "changePlan": { "method": "POST", "path": "/v1/billing/upgrade" }

    }

    }

    }

    ```


    Call `GET /v1/billing/subscription` first. With no active subscription, use `checkout`; with one, use `changePlan`. Send `{ "planKey": "" }` and give the returned `url` to a person: both endpoints return a hosted page where a person confirms the purchase. Nothing is charged until they do. Each `path` is relative to the API origin (`https://api.cavuno.com`), like `Location` headers and list `url` fields, so do not join it to a base URL that already ends in `/v1`.'
  contact:
    name: Cavuno
    url: https://cavuno.com
servers:
- url: https://api.cavuno.com/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Operator
  description: 'Current operator identity: Board binding, actor type, live role, and effective permissions/scopes.'
paths:
  /dashboard-links:
    get:
      summary: Get dashboard links
      description: Return direct links to the Board’s dashboard pages (billing, domains, jobs, Backfill, website, indexing, team, email, Companion and more) so an agent can send a person straight to the right page, plus link templates for a single job, company or blog post. The `website` link opens the editor the Board currently uses.
      responses:
        '200':
          description: The Board’s dashboard links.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardLinks'
        default:
          description: An error. Every non-2xx response uses the same envelope; see the Errors section of the introduction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Operator
      operationId: getDashboardLinks
  /me:
    get:
      summary: Retrieve the current operator identity
      description: Returns the Board bound to the credential, the actor type, the current live role and effective product permissions, and (for API keys and OAuth tokens) the credential scopes. Use this instead of global role or permission catalogs.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operator'
        default:
          description: An error. Every non-2xx response uses the same envelope; see the Errors section of the introduction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Operator
      operationId: getMe
components:
  schemas:
    PlanUpgradeHint:
      type: object
      properties:
        capability:
          type: string
          enum:
          - activeJobsLimit
          - teamSeatLimit
          - canBePublic
          - canRemoveBranding
          - apiAccess
          description: The plan capability that blocked the request, named as in `GET /v1/billing/subscription` `capabilities`.
        requiredPlan:
          type: string
          enum:
          - starter
          - basic
          - grow
          - advanced
          - scale
          description: The cheapest self-serve plan that unlocks the action. Pass it as `planKey`. Omitted when it cannot be told without more information; read `GET /v1/billing/subscription` and pick a higher plan.
        checkout:
          type: object
          properties:
            method:
              type: string
              enum:
              - POST
            path:
              type: string
              enum:
              - /v1/billing/checkout
          required:
          - method
          - path
          description: Starts a hosted checkout when the board has no active subscription (for example during a trial).
        changePlan:
          type: object
          properties:
            method:
              type: string
              enum:
              - POST
            path:
              type: string
              enum:
              - /v1/billing/upgrade
          required:
          - method
          - path
          description: Starts a hosted plan change when the board already has an active subscription.
      required:
      - capability
      - checkout
      - changePlan
      description: 'Present only on Operator API errors caused by the board''s Cavuno plan. Read `GET /v1/billing/subscription` to choose between `checkout` and `changePlan`, call it with `{ "planKey": requiredPlan }`, and give the returned `url` to a person to confirm. Each `path` is relative to the API origin, not to a `/v1` base URL. Both endpoints need `billing.manage`. Board API errors never include it.'
    Operator:
      type: object
      properties:
        object:
          type: string
          enum:
          - operator
          description: String representing the object's type. Objects of the same type share the same value.
        board:
          type: object
          properties:
            id:
              type: string
              description: Unique identifier for the Board (account).
            slug:
              type: string
              description: URL slug of the Board.
            name:
              type: string
              description: Display name of the Board.
          required:
          - id
          - slug
          - name
          description: The Board the credential is bound to.
        actor:
          type: object
          properties:
            type:
              type: string
              enum:
              - api_key
              - oauth_token
              - user_session
              description: How this request authenticated.
            role:
              type:
              - string
              - 'null'
              description: Current live membership role. Always `null` for API keys (Board-owned service credentials). Null for OAuth/session only when no live membership remains.
            permissions:
              type: array
              items:
                type: string
              description: Current effective product permissions. API keys use the key's explicit scopes plus the lower levels they include (`publish` includes `manage`, `manage` includes `read`); OAuth is the intersection of token scopes and the consenting member's live permissions; sessions use the member's live permissions.
            scopes:
              type:
              - array
              - 'null'
              items:
                type: string
              description: Credential scopes for API keys and OAuth tokens. Always `null` for user sessions.
          required:
          - type
          - role
          - permissions
          - scopes
          description: The authenticated principal.
      required:
      - object
      - board
      - actor
    DashboardLinks:
      type: object
      properties:
        object:
          type: string
          enum:
          - dashboard_links
        baseUrl:
          type:
          - string
          - 'null'
          description: The Board’s dashboard home. Null when the account has no dashboard, in which case `links` is empty.
        links:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                description: Stable snake_case key, for example `billing`, `backfill`, `indexing` or `website`. New keys may be added.
              label:
                type: string
                description: What the page is for, in a few words.
              url:
                type: string
                description: Direct link to the dashboard page.
            required:
            - key
            - label
            - url
          description: Direct links to the Board’s main dashboard pages.
        recordLinks:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                description: Stable snake_case record kind, for example `job`, `company` or `blog_post`. New keys may be added.
              label:
                type: string
                description: Which page this is, in a few words.
              urlTemplate:
                type: string
                description: 'Link to one record’s dashboard page, with `{id}` in place of the record’s id: the same id its `/v1` operations take.'
            required:
            - key
            - label
            - urlTemplate
          description: Link templates for a single record’s dashboard page. Replace `{id}` with an id from a `/v1` response; never with a guessed one.
        apiReferenceUrl:
          type: string
          description: The Cavuno API reference documentation.
      required:
      - object
      - baseUrl
      - links
      - recordLinks
      - apiReferenceUrl
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code, such as `validation_bad_request` or `jobs_not_found`.
            message:
              type: string
              description: Human-readable explanation.
            requestId:
              type: string
              description: Unique id for this request. Include it when contacting support.
            details:
              description: Structured context for some errors, such as per-field validation issues.
            upgrade:
              $ref: '#/components/schemas/PlanUpgradeHint'
          required:
          - code
          - message
          - requestId
      required:
      - error
      description: The error envelope returned by every non-2xx response.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cavuno_live_<keyId>_<secret>
      description: Use your secret API key to authenticate. Pass it as a Bearer token in the `Authorization` header. You can view and manage your API keys in the Cavuno dashboard.
externalDocs:
  description: Cavuno API reference
  url: https://cavuno.com/docs/api