Projects

Create a project from a brief

Scope projects.write. Starts a build and answers an admission receipt; the build runs after the answer and spends the credits of your plan, as the same brief typed into the editor would. Follow it with GET /operations/{requestId}.

post/projects

Request

  • Base URL: https://app.vulk.dev/api/v1
  • URL: https://app.vulk.dev/api/v1/projects
  • Auth: HTTP bearer

Request body

promptstring required

The brief, or the next instruction, in any language. It is handed to VULK unchanged.

modelstring

A model id from GET /models, or auto. Omit it to let VULK choose. A model your plan does not include answers 402.

requestIdstring uuid

A UUID v4 you make. Send the same requestId to retry a submit whose answer was lost: the API returns the operation it already created instead of starting a second one. Omitted, VULK makes one.

Example request

{
  "model": "auto"
}

Response

Admission receipt. The build runs after this answer; follow it with GET /operations/{requestId}. accepted: false with operationStatus: "unconfirmed" means VULK had not recorded the operation within the wait: read the operation, then retry with exactly the same requestId and body.

requestIdstring uuid required
acceptedboolean required

True when VULK recorded the operation.

operationStatus'running' | 'waiting' | 'done' | 'failed' | 'orphan' | 'unconfirmed' | 'null' nullable required

unconfirmed when accepted is false.

projectIdstring
editorUrlstring uri
nextActionstring required

What to do next, in a sentence written for the caller.

Changes

No recorded changes to this operation across all 1 revision of this API.