API reference
This reference is generated from the current code’s OpenAPI 3.1 documents on every documentation build. It uses the same router and operation registry that publish the API contract on a running Vibase instance.
| Reference | Covers | Download |
|---|---|---|
| Records API | CRM records, conversations, and action requests/executions | OpenAPI JSON |
| Workspace API | Connections, agents, access administration, pipelines, and schema discovery | OpenAPI JSON |
Each operation page describes its method, path, parameters, request body, and responses. Use your own instance’s origin when making requests.
Authentication
Section titled “Authentication”Pass an appropriate access token or agent API key as a Bearer credential:
curl https://api.example.com/api/v1/contacts \ -H "Authorization: Bearer $VIBASE_ACCESS_TOKEN"Follow the Clerk quickstart to configure OAuth and device login. Authentication identifies the caller; permissions determine which operations it can perform.
Match your deployment’s version
Section titled “Match your deployment’s version”An instance can run an older version than this site. Its own documents describe what it accepts:
https://api.example.com/api/v1/openapi.jsonhttps://api.example.com/meta/v1/openapi.jsonUse https://api.example.com/.well-known/vibase to discover those URLs. The published JSON downloads are unmodified exports of the router’s documents. Use real record IDs and your own credentials when making requests.