OpenAPI

The whole API, machine-readable.

Every Vector Pro endpoint, parameter, request body, and response shape, described in OpenAPI 3.1. Generate a client, import it into your tools, or hand it to an assistant.

Download openapi.yamlBrowse the reference

What the spec is

OpenAPI is a standard way to describe a REST API: one file that documents every endpoint, parameter, request body, and response shape in a form a machine can read.

It is generated from the same annotations in the API itself that produce this reference, so it never drifts from the behaviour it describes. When an endpoint changes, the spec changes with it.

Vector Pro's spec follows OpenAPI 3.1.

Spec details

Version
OpenAPI 3.1
Format
YAML
Base URL
api.builtfast.com/api/v1/vector
Auth
Bearer token
Content-Type
application/json

What you can do with it

Generate typed clients

Feed the spec to OpenAPI Generator and get an SDK in TypeScript, Python, Go, PHP, or fifty other languages.

openapi-generator-cli generate -g typescript-fetch

Import into API tools

Postman, Insomnia, HTTPie, and the VS Code REST clients all read OpenAPI directly, so the whole surface arrives configured.

Import → OpenAPI → URL or file

Give an assistant context

Attach the spec to Claude, ChatGPT, or Cursor. A structured description of every endpoint beats pasting screenshots of docs.

“Using this spec, write a service that…”

Generate a client

The generator reads the spec straight off this site, so there is nothing to check in and nothing to keep in sync by hand.

bash
# Install the generator
npm install @openapitools/openapi-generator-cli -g

# Generate a TypeScript client
openapi-generator-cli generate \
  -i https://builtfast.com/docs/api/openapi.yaml \
  -g typescript-fetch \
  -o ./vector-client

# Or Python
openapi-generator-cli generate \
  -i https://builtfast.com/docs/api/openapi.yaml \
  -g python \
  -o ./vector-client

See every available generator.

Keep it current

The spec is republished whenever the API changes. Point your pipeline at the URL rather than a committed copy and the client regenerates itself.

bash
# Fetch the latest spec
curl -O https://builtfast.com/docs/api/openapi.yaml

# Or regenerate the client as part of CI
openapi-generator-cli generate \
  -i https://builtfast.com/docs/api/openapi.yaml \
  -g typescript-fetch \
  -o ./src/api-client

Prefer to read it instead?

The reference covers every endpoint with parameters, responses, and copy-pasteable examples.

API referencePostman collection