Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Authorization

To authorize, you need to create a token.

Create API key

In the Design Editor, go to user profile and create a API key, with the relevant scope. useEditorState

The API key will be valid forever until it is revoked.

A key made in the Design Editor works only against the production API, https://api.vev.design/v2/. Sent to any other server, it fails with Failed to validate token.

Authorized request

Test your newly created token:

curl --header "x-vev-key: [your-key]" https://api.vev.design/v2/api-key/introspection

To make authorized requests, you need to add the x-vev-key header to every request. Authorization: Bearer [your-key] works too.

Revoke a key

Revoke a key from your user profile, or with the key itself:

curl --header "x-vev-key: [your-key]" https://api.vev.design/v2/api-key/revoke

Keys for your app's users

If your product acts for other Vev users, don't ask them to paste a key. Let them connect their Vev account instead: see Connect Your App with OAuth. The token your app receives is an API key like the ones above.