Create project

Creates a new vly project from a prompt. Returns the new Project record.

POST /v1/projects

Create project

cURL

curl --request POST \
  --url https://api.vly.ai/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Tasks for teams",
  "prompt": "A real-time task tracker for small teams. Each user has tasks, due dates, and can assign tasks to teammates. Email notifications on assignment."
}
'

201

{
  "id": "prj_01JFA8N3Z1B6Y2K7Q3X4M5R8",
  "name": "Tasks for teams",
  "agent": "claude-code",
  "visibility": "private",
  "created_at": "2023-11-07T05:31:56Z",
  "prompt": "<string>",
  "url": "https://tasks-for-teams.vly.app",
  "updated_at": "2023-11-07T05:31:56Z"
}

Creates a project, queues the initial agent run, and returns immediately with the project ID. Poll the project for status, or subscribe to a webhook for completion.

Use an Idempotency-Key header to safely retry. Within 24 hours, repeated requests with the same key return the original response.

Authorizations

Authorization · string · header · required

Workspace-scoped API key. Generate from Workspace settings → API keys.

Body

application/json

name · string · required

Example:

"Tasks for teams"

prompt · string · required

Example:

"A real-time task tracker for small teams. Each user has tasks, due dates, and can assign tasks to teammates. Email notifications on assignment."

agent · enum<string> · default: claude-code

Available options: claude-code, openai-codex, gemini-cli

template · string | null

Example:

"blank"

Response

201

application/json

Created

id · string · required

Example:

"prj_01JFA8N3Z1B6Y2K7Q3X4M5R8"

name · string · required

Example:

"Tasks for teams"

agent · enum<string> · required

Available options: claude-code, openai-codex, gemini-cli

visibility · enum<string> · required

Available options: private, unlisted, public

created_at · string<date-time> · required

prompt · string

url · string<uri>

Example:

"https://tasks-for-teams.vly.app"

updated_at · string<date-time>