Introduction

The Docs API API is a RESTful interface for creating and managing resources, running background jobs, and receiving webhook events. It speaks JSON over HTTPS and works with any HTTP client.

All systems operational · API v1.4

Overview #

Everything you build on Docs API is organized around a small set of objects. A resource is the primary unit of data; jobs run asynchronous work against resources; and webhooks push events to your backend as things change. The API is designed to be predictable, resource-oriented, and easy to integrate.

• Predictable, resource-oriented URLs and standard HTTP verbs.
• JSON for every request body and response payload.
• Standard HTTP response codes to signal success and failure.
• Cursor-based pagination on every list endpoint.
• Idempotency keys so retries never create duplicates.

Quickstart #

Install one of the official clients, or call the API directly with cURL. Each library reads your secret key from the Docs API_API_KEY environment variable.

# No installation required — call the API directly
curl https://api.docs.vexart.net/v1/resources \
  -H "Authorization: Bearer $Docs API_API_KEY"

npm install @Docs API/sdk

pip install Docs API

Base URL #

All API requests are made to the following base URL over HTTPS. Requests made over plain HTTP are rejected.

The current major version is v1. We never make breaking changes within a major version; see the changelog for the additive changes shipped over time.

Your first request #

The example below lists the resources in your account. Replace the key with your own secret key, then run it.

curl https://api.docs.vexart.net/v1/resources?limit=3 \
  -H "Authorization: Bearer sk_live_4eC39Hq..."

import Client from "@Docs API/sdk";

const client = new Client(process.env.Docs API_API_KEY);

const resources = await client.resources.list({ limit: 3 });
console.log(resources.data);

import Docs API

client = Docs API.Client(api_key="sk_live_4eC39Hq...")

resources = client.resources.list(limit=3)
print(resources.data)

A successful call returns a 200 OK with a JSON body. The data array holds the resource objects, and has_more tells you whether to paginate.

{
  "object": "list",
  "url": "/v1/resources",
  "has_more": false,
  "data": [
    {
      "id": "res_8Xk2mPq19Z",
      "object": "resource",
      "name": "Production cluster",
      "status": "active",
      "created": 1718668800
    }
  ]
}