Quickstart

List one project to verify your API key before creating resources or starting a run.

Before you start

You need a Veryfront account and a terminal with curl. You can complete the authentication check even if you do not have a project yet.

1. Create an API key

Open API key settings in Studio, sign in, and create a key with permission to read projects. Choose a project-scoped key if your client only needs one project. Set the key in your terminal:

credentials.sh

export VERYFRONT_API_KEY="<API_KEY>"

Keep the key out of source control and public browser bundles. See API key setup for more about scope and storage.

2. Send a request

Call GET /projects?limit=1. The limit keeps the first response small, and --include displays the HTTP status and headers.

request.sh

curl --include "https://api.veryfront.com/projects?limit=1" \
  -H "Authorization: Bearer $VERYFRONT_API_KEY"

3. Read the response

Expect HTTP 200. Project records appear in data; page_info contains pagination cursors. This example omits other project fields:

response.json

{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "name": "Support Assistant",
      "slug": "support-assistant"
    }
  ],
  "page_info": {
    "self": null,
    "first": null,
    "next": null,
    "prev": null
  }
}

Use a returned project ID or slug for project_reference in later requests. See List projects for response fields and pagination.

Result	What to do
200 OK, empty results	Authentication succeeded, but no projects were returned. Check the key’s project scope or create a project.
401 Unauthorized	Check the key and the Authorization header and its Bearer scheme. Replace an expired or revoked key.
403 Forbidden	Check the key’s scopes and its owner’s access to the resource.

Interface	Use it for
REST API reference	Call resource endpoints from a backend or script.
GraphQL guide	Query the fields your client needs.
MCP setup	Connect an assistant or MCP client to tools.

Ready to build? Configure a project, create an agent, then run an agent. Explore the API overview for other capabilities.

Get started

APIs

REST API

GraphQL API

MCP API

Before you start

1. Create an API key

2. Send a request

3. Read the response

Next

​Before you start

​1. Create an API key

​2. Send a request

​3. Read the response

​Next

Before you start

1. Create an API key

2. Send a request

3. Read the response

Next