Skip to Content

API reference / Get started

Make your first request

Create an API key and read your workspace.

You need an owner or admin role. For ChatGPT or Claude, use MCP setup.

1. Create a key

Open Settings → API keys. Enter a name under Create a key, keep Read only, and select Create key.

Select Copy key and store it securely. The full key is shown once.

2. Check your workspace

Set VENDITA_API_KEY securely in your environment, then run:

curl --fail-with-body \
  'https://app.vendita.io/api/v1/me' \
  -H "Authorization: Bearer $VENDITA_API_KEY"

The response’s data object contains your workspace, role, and scopes. Check that the workspace is correct.

3. List your agents

curl --fail-with-body \
  'https://app.vendita.io/api/v1/agents' \
  -H "Authorization: Bearer $VENDITA_API_KEY"

A data array confirms success, even if it is empty. This request requires agents:read.

If the request fails

  • 401: check that the environment variable contains an active API key.
  • 403: check the key’s scopes and its creator’s current role.

Review authentication · Check an error

Next steps

Choose an endpoint from the reference. For writes, create a key with only the Custom permissions your integration needs.

Download the OpenAPI specification for the public /api/v1 routes. Internal browser endpoints and the Supabase database API are not substitutes for this API.

On this page