datavessel API

openapi: 3.1.0
info:
  title: datavessel API
  version: '2026-11-05'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-05: 5 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; datavessel has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 3
    pages-with-code: 3
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-05'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://datavessel.io/docs
  - https://datavessel.io/cli
  - https://datavessel.io/de/cli
servers:
- url: https://api.datavessel.io
paths:
  /djr4/datavessel-cli/main/skills/datavessel/SKILL.md:
    get:
      operationId: get_djr4_datavessel_cli_main_skills_datavessel_SKILL_md
      tags:
      - Djr4
      summary: GET /djr4/datavessel-cli/main/skills/datavessel/SKILL.md
      x-source: https://datavessel.io/cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl -sL https://raw.githubusercontent.com/djr4/datavessel-cli/main/skills/datavessel/SKILL.md  -o .cursor/rules/datavessel.mdc
          Building on the Claude Agent SDK or the API instead? Give the model a shell tool, add SKILL.md to its context, and authenticate headless
          with DATAVESSEL_TOKEN . The CLI's stable --json output and exit codes are built for it. One command away. terminal $ npm i -g datavesse
  /v1/auth/me:
    get:
      operationId: get_v1_auth_me
      tags:
      - Auth
      summary: Who the key belongs to.
      x-source: https://datavessel.io/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/providers/execute:
    post:
      operationId: post_v1_providers_execute
      tags:
      - Providers
      summary: POST /v1/providers/execute
      x-source: https://datavessel.io/docs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ProvidersExecuteRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://api.datavessel.io/v1/providers/execute  -H "X-API-Key: $DATAVESSEL_API_KEY"  -H "Content-Type: application/json"  -d
          ''{"tool_name": "get_top_queries", "params": {"site_url": "https://shop.example.com", "limit": 10}}'' Copy The catalogue Every tool,
          in plain English. What follows is the surface area your agent sees. Connect a source and link it to your store, and these tools become
          avai'
  /v1/tools:
    get:
      operationId: get_v1_tools
      tags:
      - Tools
      summary: The full tool catalogue with every parameter schema.
      x-source: https://datavessel.io/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/users/me/usage:
    get:
      operationId: get_v1_users_me_usage
      tags:
      - Users
      summary: Plan, tool calls used this period and what is left.
      x-source: https://datavessel.io/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostV1ProvidersExecuteRequest:
      type: object
      properties:
        tool_name:
          type: string
        params:
          type: object
          properties:
            site_url:
              type: string
            limit:
              type: integer
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
security:
- apiKey: []
tags:
- name: Auth
- name: Djr4
- name: Providers
- name: Tools
- name: Users