Skip to main content
GET
Get project

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project UUID or slug.

Example:

"my-project"

Response

Project found.

id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

slug
string
required
Example:

"my-project"

name
string
required
Example:

"My Project"

budget
object | null
required

The subject’s monthly AI budget, or null if no budget is configured. Read-only; use /budgets to manage budgets.

budget_status
object | null
required

Usage against the budget for the current month, or null if the subject has no budget.

account_id
string<uuid> | null
account_name
string | null
description
string
Example:

"A sample project description"

is_claimed
boolean
features
string[]
environments
object[]
releases
object[]
created_at
string
Example:

"2024-01-15T10:30:00Z"

updated_at
string
Example:

"2024-01-15T10:30:00Z"

published_at
string
prompt_count
number
config
object

Project configuration. Field names use snake_case. Legacy camelCase aliases contain the same values.

provider
string | null
layout
string | null
type
enum<string>
Available options:
regular,
default,
template
system_managed
boolean
users
object[]
capabilities
enum<string>[]
Available options:
project.read,
project.settings.manage,
project.delete,
project.members.read,
project.members.manage,
project.invites.read,
project.invites.manage,
project.files.read,
project.files.write,
project.realtime.connect,
project.realtime.write,
project.files.admin,
project.uploads.read,
project.uploads.write,
project.uploads.admin,
project.knowledge.read,
project.knowledge.write,
project.releases.read,
project.releases.write,
project.deployments.read,
project.deployments.write,
project.deploy.execute,
project.runtime.manage,
project.channels.read,
project.channels.write,
project.sandboxes.manage,
project.domains.write,
project.environments.manage,
project.env_vars.write,
project.runs.read,
project.runs.write,
project.runs.admin,
project.agents.read,
project.agents.write,
project.evals.read,
project.evals.write,
project.evals.run,
project.conversations.read,
project.conversations.write,
project.conversations.create,
project.integrations.read,
project.integrations.connect,
project.integrations.configure,
project.api_keys.read,
project.api_keys.manage,
project.cache.read,
project.cache.write,
project.logs.read,
project.metrics.read,
project.resources.read
capabilities_version
integer
labels
object[]