{"openapi":"3.1.0","info":{"title":"Vife API","version":"2026-11-11","description":"Programmatic access to your Vife account. Authenticate with `Authorization: Bearer vife_sk_...`. Docs: https://vife.ai/developers/docs. Tasks run every composer mode, Chat included."},"servers":[{"url":"https://api.vife.ai"}],"paths":{"/v1/me":{"get":{"operationId":"getMe","summary":"Who am I","description":"Returns the API key the request authenticated with and the account it belongs to. Use it to check a key.","tags":["Account"],"security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"The calling key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyIdentity"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/tasks":{"post":{"operationId":"createTask","summary":"Create a task","description":"Starts a task exactly as the web composer does: same modes, options, queue, concurrency limit and credit charging. Returns at once (202); poll GET /v1/tasks/{task_id} or subscribe to task.completed, task.failed and task.needs_input webhooks. Retry with the same Idempotency-Key to never start a task twice. mode chat is the web's plain chat with one text model. A key that can create tasks can queue work on your Mac when options.agent.computerTarget names it; every step there asks first.","tags":["Tasks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskCreateRequest"}}}},"responses":{"202":{"description":"The task, usually queued.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Your credit balance is used up (insufficient_credits).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"project_id names no project of yours.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"operationId":"listTasks","summary":"List tasks","description":"Your tasks, newest first, from every source (API, web and automations). Items carry no result, pending input or credits: get the task for those.","tags":["Tasks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"description":"Title contains this text.","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"One status.","schema":{"type":"string","enum":["queued","running","needs_input","completed","failed","stopped"]}},{"name":"source","in":"query","required":false,"description":"api, web or automation.","schema":{"type":"string","enum":["api","web","automation"]}},{"name":"mode","in":"query","required":false,"description":"One task mode.","schema":{"type":"string","enum":["agent","chat","document","slide","spreadsheet","image","video","audio"]}},{"name":"project_id","in":"query","required":false,"description":"Tasks of one project.","schema":{"type":"string"}},{"name":"archived","in":"query","required":false,"description":"true lists archived tasks instead.","schema":{"type":"boolean"}},{"name":"created_after","in":"query","required":false,"description":"ISO 8601 date-time.","schema":{"type":"string","format":"date-time"}},{"name":"created_before","in":"query","required":false,"description":"ISO 8601 date-time.","schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","required":false,"description":"1-100, default 20.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"next_cursor of the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of tasks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskList"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/tasks/{task_id}":{"get":{"operationId":"getTask","summary":"Get a task","description":"The task's status, final answer and files (result), what it waits for (pending_input), its error and the credits charged so far.","tags":["Tasks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"description":"The task id.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No task of yours with this id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/tasks/{task_id}/messages":{"post":{"operationId":"sendTaskMessage","summary":"Send a follow-up message","description":"Continues the task, or answers its question. While the task runs, the message is queued and runs next (delivery: queued), as in the web app; a chat task has no queue and refuses a message while it is still answering (409 chat_generation_active). Without options, the task's current options are reused.","tags":["Tasks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"description":"The task id.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskMessageRequest"}}}},"responses":{"202":{"description":"The message was accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskMessageReceipt"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Your credit balance is used up.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No task of yours with this id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"A chat task is still answering your previous message (chat_generation_active). Or: The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"operationId":"listTaskMessages","summary":"List a task's messages","description":"The task's transcript: your messages, the answers, questions and tool steps (name, status and a short label; never tool payloads).","tags":["Tasks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"description":"The task id.","schema":{"type":"string","format":"uuid"}},{"name":"order","in":"query","required":false,"description":"asc (oldest first, default) or desc.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"1-100, default 20.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"next_cursor of the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of messages.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskMessageList"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No task of yours with this id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/tasks/{task_id}/stop":{"post":{"operationId":"stopTask","summary":"Stop a task","description":"Stops the running turn and returns once it settled (up to about 40 seconds). Queued follow-ups are dropped, as in the web app. No webhook fires for a stop.","tags":["Tasks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"description":"The task id.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The stopped task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No task of yours with this id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/tasks/{task_id}/share":{"get":{"operationId":"getTaskShare","summary":"Get a task's share link","description":"Whether the task is shared (public) and its share link, as the web app's Share dialog shows it.","tags":["Tasks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"description":"The task id.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The share state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskShare"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No task of yours with this id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createTaskShare","summary":"Share a task","description":"Makes the task public, as the web app's Share dialog does: anyone with the returned url can read the conversation and its files. Sharing again returns the same link. A task that holds data from Google Workspace cannot be shared through the API (403 google_user_data); as in the web app, a task shared before it reads Google data stays shared.","tags":["Tasks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"description":"The task id.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The public share.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskShare"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The task holds Google Workspace data (google_user_data); share it from the web app. Or: The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No task of yours with this id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteTaskShare","summary":"Stop sharing a task","description":"Makes the task private again: its share link stops working at once. Safe to repeat.","tags":["Tasks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"description":"The task id.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The private task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskShare"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No task of yours with this id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/files/uploads":{"post":{"operationId":"createFileUpload","summary":"Start a file upload","description":"Three steps, as in the web app: (1) this call answers a plan; (2) PUT the bytes to url with the returned headers (or, when parts is set, PUT each byte range of size_bytes to its part url and keep each response's ETag header); (3) call complete with upload_token (and the parts' ETags) before expires_at. The bytes never pass through the API. An upload that is never completed stops counting against your in-progress limit after 2 hours. Files up to 128 MiB are one PUT; larger files (up to 1 GiB) are uploaded in 64 MiB parts. A replay of an expired plan answers 409 upload_expired.","tags":["Files"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}}},"responses":{"201":{"description":"Where to PUT the bytes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUpload"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The replayed upload plan expired (upload_expired). Or: The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/files/uploads/{upload_id}/complete":{"post":{"operationId":"completeFileUpload","summary":"Complete a file upload","description":"Stores the uploaded bytes as one of your files, exactly as a web upload (type detection, previews). Call it after the PUT returned. Retrying returns the same file. Attach the file to a task with its id in file_ids.","tags":["Files"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"upload_id","in":"path","required":true,"description":"The id of the upload (the id the file gets).","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadCompleteRequest"}}}},"responses":{"200":{"description":"The stored file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The bytes were not received (upload_not_received) or another request is completing this upload (upload_conflict). Or: The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/files/{file_id}":{"get":{"operationId":"getFile","summary":"Get a file","description":"One of your files: an upload, a generated file or a file a task made. url downloads it, as in the web app; treat it like a password.","tags":["Files"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"description":"The file id.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No file of yours with this id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/files/{file_id}/content":{"get":{"operationId":"downloadFile","summary":"Download a file","description":"Redirects (302) to the file on Vife's file storage; follow the Location header (curl -L). The API never serves the bytes itself. 404 file_not_found when the file is not one of yours.","tags":["Files"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"description":"The file id.","schema":{"type":"string","format":"uuid"}}],"responses":{"302":{"description":"Location is the file's download URL. A file id that is not one of yours answers 404 file_not_found."},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/tasks/{task_id}/files":{"get":{"operationId":"listTaskFiles","summary":"List a task's files","description":"The files of a task, newest first, as its file panel in the web app lists them: what you attached (role input) and what it made (role artifact).","tags":["Files"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"description":"The task id.","schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","required":false,"description":"1-100, default 20.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"next_cursor of the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of the task's files.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskFileList"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No task of yours with this id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/media/models":{"get":{"operationId":"listMediaModels","summary":"List media models","description":"The image, video and audio models a task can use, as the web composer offers them. Pick one in options.image|video|audio of POST /v1/tasks (mode image, video or audio) with its parameters; credits are charged per unit at price.","tags":["Media"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"kind","in":"query","required":false,"description":"Only image, video or audio models.","schema":{"type":"string","enum":["image","video","audio"]}}],"responses":{"200":{"description":"The models.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaModelList"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"media_catalog_unavailable. Or: Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/media_jobs":{"get":{"operationId":"listActiveMediaJobs","summary":"List running media jobs","description":"Your unfinished media jobs across every task, newest first. A finished job is read by id or under its task.","tags":["Media"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"1-100, default 20.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"next_cursor of the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of jobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaJobList"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/media_jobs/{job_id}":{"get":{"operationId":"getMediaJob","summary":"Get a media job","description":"One of your media jobs; once it succeeded, files holds the generated files (each url downloads one).","tags":["Media"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"description":"The media job id.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaJob"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"media_job_not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/tasks/{task_id}/media_jobs":{"get":{"operationId":"listTaskMediaJobs","summary":"List a task's media jobs","description":"A task's unfinished media jobs and those that finished in the last 24 hours, newest first, as the web app shows them.","tags":["Media"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"description":"The task id.","schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","required":false,"description":"1-100, default 20.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"next_cursor of the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of the task's jobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaJobList"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"task_not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/automations":{"get":{"operationId":"listAutomations","summary":"List automations","description":"Your automations, newest first, as the web's Automations page lists them (saved in the web app or through the API).","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"1-100, default 20.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"next_cursor of the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of your automations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationList"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createAutomation","summary":"Create an automation","description":"Saves an automation exactly as the web's Automations page does: same triggers, options, validation and ownership checks (project, group, files and Mac are yours). Top-level keys are snake_case; triggers and options are the web's own JSON. A webhook trigger with hookId \"\" gets a new hookId; rotate its secret to require a token. A Mac target is saved with its approval capped at ask_for_approval. Saving costs nothing; each run is charged like a task.","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationCreateRequest"}}}},"responses":{"201":{"description":"The saved automation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"400":{"description":"A field is not valid (invalid_request, param names it), or file_ids names a file that is not an attachable file of yours (file_not_found). Or: The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"project_id or group_id names none of yours (project_not_found, group_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/automations/{automation_id}":{"get":{"operationId":"getAutomation","summary":"Get an automation","description":"One of your automations.","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"description":"The automation id.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The automation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No automation of yours with this id (automation_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"updateAutomation","summary":"Update an automation","description":"Changes only the fields present, with the same rules as create. Sending the same body again saves the same automation.","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"description":"The automation id.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationUpdateRequest"}}}},"responses":{"200":{"description":"The saved automation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The automation would run on your Mac above Ask permissions without approvals (desktop_approval_not_allowed). Or: The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No automation of yours with this id (automation_not_found), or project_id / group_id names none of yours (project_not_found, group_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteAutomation","summary":"Delete an automation","description":"Deletes the automation, its triggers and webhooks. The tasks its runs started stay. A second delete answers 404.","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"description":"The automation id.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"It was deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationDeleted"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No automation of yours with this id (automation_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/automations/{automation_id}/pause":{"post":{"operationId":"pauseAutomation","summary":"Pause an automation","description":"Stops its timers and triggers until it is resumed (status paused).","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"description":"The automation id.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The paused automation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No automation of yours with this id (automation_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/automations/{automation_id}/resume":{"post":{"operationId":"resumeAutomation","summary":"Resume an automation","description":"Turns it back on: its schedule restarts from now and its triggers poll again.","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"description":"The automation id.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The resumed automation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The automation would run on your Mac above Ask permissions without approvals (desktop_approval_not_allowed). Or: The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No automation of yours with this id (automation_not_found), or project_id / group_id names none of yours (project_not_found, group_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/automations/{automation_id}/runs":{"post":{"operationId":"runAutomation","summary":"Run an automation now","description":"The web's Test run: starts one run now (source test), ignoring its conditions and replaying its latest event when it has one. The run is charged like a task. Send an Idempotency-Key to never start two runs for one request; without one, every call starts a run. Follow it with GET .../runs/{run_id}, its task, or the automation.run.finished webhook.","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"description":"The automation id.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"201":{"description":"The started run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationRun"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Your credit balance is used up (insufficient_credits).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The automation would run on your Mac above Ask permissions without approvals (desktop_approval_not_allowed). Or: The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No automation of yours with this id (automation_not_found), or project_id / group_id names none of yours (project_not_found, group_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"operationId":"listAutomationRuns","summary":"List an automation's runs","description":"Its runs, newest first, 30 per page, as its page in the web app lists them.","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"description":"The automation id.","schema":{"type":"string","format":"uuid"}},{"name":"filter","in":"query","required":false,"description":"all (default), triggered (runs that started) or failed.","schema":{"type":"string","enum":["all","triggered","failed"]}},{"name":"cursor","in":"query","required":false,"description":"next_cursor of the previous page.","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"A page of runs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationRunList"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No automation of yours with this id (automation_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/automations/{automation_id}/runs/{run_id}":{"get":{"operationId":"getAutomationRun","summary":"Get an automation run","description":"One run of one of your automations.","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"description":"The automation id.","schema":{"type":"string","format":"uuid"}},{"name":"run_id","in":"path","required":true,"description":"The run id.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationRun"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No run of this automation of yours with this id (automation_run_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/automations/{automation_id}/webhooks/{hook_id}/secret":{"post":{"operationId":"rotateAutomationWebhookSecret","summary":"Rotate a webhook trigger's secret","description":"Generates a new bearer token for one webhook trigger and returns it once; the previous token stops working and the trigger requires the token from now on. Every call rotates again (no Idempotency-Key).","tags":["Automations"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"automation_id","in":"path","required":true,"description":"The automation id.","schema":{"type":"string","format":"uuid"}},{"name":"hook_id","in":"path","required":true,"description":"The hookId of one of the automation's webhook triggers.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The new token, shown once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWebhookSecret"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No automation of yours with this id, or no webhook trigger of it with this hook_id (automation_webhook_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/skills":{"get":{"operationId":"listSkills","summary":"List your skills","description":"The skills of your library (official ones you added, your own, and those added from the Skill Hub) and the official skills you can add, newest first, with whether each is on for new tasks and whether this API may switch it on (can_enable). As in the web app's Settings > Skills.","tags":["Skills"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"1-100, default 20.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"next_cursor of the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of skills.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillList"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/skills/{skill_id}/enable":{"post":{"operationId":"enableSkill","summary":"Turn a skill on","description":"Turns the skill on for new tasks. An official skill not yet in your library is added first, as the web app's Add does (a Pro skill needs a paid plan, 403 skill_pro_required). A Skill Hub skill that is not in your library is refused (403 skill_not_in_library): add it in Vife > Skills first. A skill that is already on, or required by Vife, is returned unchanged.","tags":["Skills"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"skill_id","in":"path","required":true,"description":"The skill id, as GET /v1/skills lists it.","schema":{"type":"string","maxLength":200}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The skill.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Skill"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A Pro skill on a free plan (skill_pro_required), or a Skill Hub skill not in your library (skill_not_in_library). Or: The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No skill you can see with this id (skill_not_found, skill_hub_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The skill was removed from your library meanwhile (skill_not_added). Or: The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/skills/{skill_id}/disable":{"post":{"operationId":"disableSkill","summary":"Turn a skill off","description":"Turns the skill off for new tasks; it stays in your library. A skill that is already off, or not in your library, is returned unchanged. A skill required by Vife cannot be turned off (403 skill_enforced).","tags":["Skills"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"skill_id","in":"path","required":true,"description":"The skill id, as GET /v1/skills lists it.","schema":{"type":"string","maxLength":200}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The skill.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Skill"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Required by Vife (skill_enforced). Or: The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No skill you can see with this id (skill_not_found, skill_hub_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The skill was removed from your library meanwhile (skill_not_added). Or: The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/connectors":{"get":{"operationId":"listConnectors","summary":"List connectors","description":"The connectors you can use (Vife's catalog and your custom ones), newest first, with whether each is connected and on for new tasks. A connector that needs a sign-in or setup has status not_connected or needs_sign_in; open its connect_url in the web app, as the API never signs in.","tags":["Connectors"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"installed","in":"query","required":false,"description":"true: only your connected ones; false: the rest.","schema":{"type":"boolean"}},{"name":"limit","in":"query","required":false,"description":"1-100, default 20.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"next_cursor of the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of connectors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorList"}}}},"400":{"description":"A query parameter is not valid (invalid_request). Or: The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/connectors/{connector_id}/enable":{"post":{"operationId":"enableConnector","summary":"Turn a connector on","description":"Turns a connected connector (or an add-on) on by default for new tasks, as the switch in the web app's Settings > Connectors does. A connector that is not connected yet (409 connector_not_installed) or whose sign-in is gone (409 connector_needs_sign_in) is refused: connect it at its connect_url first.","tags":["Connectors"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"connector_id","in":"path","required":true,"description":"The connector id, as GET /v1/connectors lists it.","schema":{"type":"string","maxLength":200}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The connector.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}}},"400":{"description":"My Browser is switched on each device (connector_device_local), or the add-on cannot be switched by you (connector_addon_not_togglable), or the connector is a Vife API connector, selected per task, project or automation and never on by default (connector_select_per_task_only). Or: The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No connector you can see with this id (connector_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Not connected yet (connector_not_installed), or signed out (connector_needs_sign_in). Or: The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/connectors/{connector_id}/disable":{"post":{"operationId":"disableConnector","summary":"Turn a connector off","description":"Turns the connector (or add-on) off by default for new tasks. It stays connected; a task can still turn it on. Turning off one that is already off is harmless and returns it; one never connected answers 409 connector_not_installed, and My Browser 400 connector_device_local, as in the web app.","tags":["Connectors"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"connector_id","in":"path","required":true,"description":"The connector id, as GET /v1/connectors lists it.","schema":{"type":"string","maxLength":200}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Retry-safe key (1-255 visible ASCII characters), kept 24 hours per API key.","schema":{"type":"string","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The connector.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}}},"400":{"description":"My Browser is switched on each device (connector_device_local), or the add-on cannot be switched by you (connector_addon_not_togglable). Or: The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No connector you can see with this id (connector_not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Never connected (connector_not_installed). Or: The same Idempotency-Key is in flight.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Idempotency-Key reused for a different request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/account":{"get":{"operationId":"getAccount","summary":"Get your account","description":"Your credit balance, the plan in effect (with its membership period and any prepaid pass) and the per-minute rate limits of this key, as the web app's credit badge and Usage page show them. Read-only: buying credits or changing the plan happens in the web app.","tags":["Account"],"security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"Your account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/account/transactions":{"get":{"operationId":"listAccountTransactions","summary":"List credit transactions","description":"Your credit ledger, newest first, as the web app's credit history lists it: every charge, refund, grant and purchase with the balance after it.","tags":["Account"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"type","in":"query","required":false,"description":"Only entries of this type.","schema":{"type":"string","enum":["earn","spend","refill","bonus","refund","check_in","registration","subscription","referral_reward","referral_bonus"]}},{"name":"limit","in":"query","required":false,"description":"1-100, default 20.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"next_cursor of the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of ledger entries.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountTransactionList"}}}},"400":{"description":"type, limit or cursor is not valid (invalid_request, open_platform_invalid_cursor). Or: The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked or expired API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key may not call this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; see Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Briefly unavailable; retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"webhooks":{"taskCompleted":{"post":{"summary":"task.completed","description":"A task finished its turn. data.task.result holds the answer (up to 4,000 characters) and up to 20 files.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskEvent"}}}},"responses":{"200":{"description":"Any 2xx answer acknowledges the delivery; anything else is retried."}}}},"taskFailed":{"post":{"summary":"task.failed","description":"A task's turn failed; data.task.error.code says why (insufficient_credits when credits ran out).","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskEvent"}}}},"responses":{"200":{"description":"Any 2xx answer acknowledges the delivery; anything else is retried."}}}},"taskNeedsInput":{"post":{"summary":"task.needs_input","description":"A task waits for you; data.task.pending_input says for what. Answer with POST /v1/tasks/{task_id}/messages, or in the web app for an action.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskEvent"}}}},"responses":{"200":{"description":"Any 2xx answer acknowledges the delivery; anything else is retried."}}}},"mediaCompleted":{"post":{"summary":"media.completed","description":"A media job of one of your tasks succeeded; data.media_job.files holds up to 20 generated files.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaEvent"}}}},"responses":{"200":{"description":"Any 2xx answer acknowledges the delivery; anything else is retried."}}}},"mediaFailed":{"post":{"summary":"media.failed","description":"A media job failed; data.media_job.error says why. A cancelled job sends no event.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaEvent"}}}},"responses":{"200":{"description":"Any 2xx answer acknowledges the delivery; anything else is retried."}}}},"automationRunFinished":{"post":{"summary":"automation.run.finished","description":"A run of one of your automations ended: success, failed, or not_triggered when its task found nothing to do (summary up to 4,000 characters). A run that never started (a condition miss, a skipped busy run) sends nothing.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationRunEvent"}}}},"responses":{"200":{"description":"Any 2xx answer acknowledges the delivery; anything else is retried."}}}},"creditsLow":{"post":{"summary":"credits.low","description":"Your balance fell below 50 credits (the web app's low-credit notice) with data.transaction. Sent once per fall, shortly after the debit, refund or chargeback that caused it (at the latest with the next debit within 10 minutes); it fires again only after the balance has gone back to 50 or more.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditsLowEvent"}}}},"responses":{"200":{"description":"Any 2xx answer acknowledges the delivery; anything else is retried."}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","conflict_error","idempotency_error","rate_limit_error","billing_error","api_error"]},"code":{"type":"string","description":"Stable machine-readable code."},"message":{"type":"string","description":"English, for people."},"request_id":{"type":"string"},"param":{"type":["string","null"]}},"required":["type","code","message","request_id","param"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},"ApiKeyIdentity":{"type":"object","properties":{"object":{"type":"string","enum":["api_key_identity"]},"owner":{"description":"A user's key, or an admin key.","oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["user"]},"user_id":{"type":"string"},"email":{"type":"string","format":"email"}},"required":["kind","user_id","email"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["admin"]}},"required":["kind"],"additionalProperties":false}]},"key":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string","description":"The key's visible start."},"last4":{"type":"string"},"access":{"type":"string","enum":["full","read_only"]},"expires_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"}},"required":["id","name","prefix","last4","access","expires_at","created_at"],"additionalProperties":false}},"required":["object","owner","key"],"additionalProperties":false},"TaskOptions":{"type":"object","description":"The web composer's options for this turn, exactly as the composer sends them (camelCase inside). Omitted on a follow-up message, the task's current options are reused.","properties":{"chat":{"description":"Chat options for chat tasks: selectedModel (a text model id), webSearchEnabled and selectedSkills, as the composer sends them."},"document":{"description":"Document and Slide options as the composer sends them."},"spreadsheet":{"description":"Spreadsheet options as the composer sends them."},"image":{"description":"Image options: selectedModel, size, quality, background, output_format and the like."},"agent":{"type":"object","description":"Agent options.","properties":{"selectedSkills":{"description":"Deprecated skill ids (skill.<stem>); use capabilities.enabledSkills."},"planMode":{"description":"Plan before acting. Omitted means on; false runs directly."},"agentsMode":{"description":"With planMode, hands independent parts to background subagents."},"thinkingEffort":{"description":"Thinking strength for this run: \"low\", \"medium\" or \"high\"; omitted uses the tier's own setting. A strength the tier's model does not take falls back to that setting."},"browserRuntime":{"description":"Browser for the run: \"saas\" (cloud browser), \"my_browser\" or \"in_app\"."},"browserRuntimeChoice":{"description":"The browser choice behind browserRuntime (\"auto\" or a runtime)."},"inAppBrowserId":{"description":"The desktop app's in-app browser (inapp-<id>); only with browserRuntime in_app."},"localApproval":{"description":"Approval mode for commands in your own browser; omitted uses your default."},"computerTarget":{"description":"Where the task runs: {\"kind\":\"cloud\"} (default) or {\"kind\":\"desktop\",\"deviceId\":\"<your Mac>\"}. A key that can create tasks can queue work on your Mac."},"desktopApproval":{"description":"Approval level on a Mac. Tasks from the API run at most at ask_for_approval: every step on the Mac asks first, whatever your local setting."},"localFolders":{"description":"Folders on the Mac the task may use ({grantId, path}); the Mac authorizes each."},"localBranch":{"description":"The git branch of the first local folder, for the agent's context only (one line, up to 255 characters). Kept only with a desktop computerTarget; one that does not fit is dropped, never refused. It grants nothing on the Mac."}},"required":[],"additionalProperties":false},"audio":{"description":"Audio options as the composer sends them."},"video":{"description":"Video options: selectedModel, duration, aspect ratio and the like."}},"required":[],"additionalProperties":false},"TaskCreateRequest":{"type":"object","properties":{"input":{"type":"string","description":"What the task should do, or your answer to its question.","minLength":1,"maxLength":200000},"options":{"$ref":"#/components/schemas/TaskOptions"},"agent_tier":{"type":"string","description":"lite, pro or max (max needs a paid membership).","enum":["max","pro","lite"]},"capabilities":{"description":"Connectors, connector accounts and skills for this message, as the composer sends them (enabledSkills, enabledConnectors, ...)."},"file_ids":{"type":"array","description":"Ids of files in your account to attach.","items":{"type":"string","format":"uuid"},"maxItems":10},"timezone":{"type":"string","description":"Your IANA time zone (Europe/Berlin), as the web app reports its device's; the agent reads dates and times in it. Omitted, your account's time zone is used. Not for chat tasks.","maxLength":100},"mode":{"type":"string","description":"The composer mode; agent by default. chat is a plain conversation with one text model (options.chat): no tools, no queue, and no agent_tier, capabilities or timezone.","enum":["agent","chat","document","slide","spreadsheet","image","video","audio"]},"project_id":{"type":["string","null"]},"metadata":{"type":"object","description":"Up to 20 keys of [A-Za-z0-9_.-]{1,40}, string values up to 500 characters, 4 KB in all. Returned on every read and event.","additionalProperties":{"type":"string","maxLength":500},"maxProperties":20}},"required":["input"],"additionalProperties":false},"TaskMessageRequest":{"type":"object","properties":{"input":{"type":"string","description":"What the task should do, or your answer to its question.","minLength":1,"maxLength":200000},"options":{"$ref":"#/components/schemas/TaskOptions"},"agent_tier":{"type":"string","description":"lite, pro or max (max needs a paid membership).","enum":["max","pro","lite"]},"capabilities":{"description":"Connectors, connector accounts and skills for this message, as the composer sends them (enabledSkills, enabledConnectors, ...)."},"file_ids":{"type":"array","description":"Ids of files in your account to attach.","items":{"type":"string","format":"uuid"},"maxItems":10},"timezone":{"type":"string","description":"Your IANA time zone (Europe/Berlin), as the web app reports its device's; the agent reads dates and times in it. Omitted, your account's time zone is used. Not for chat tasks.","maxLength":100}},"required":["input"],"additionalProperties":false},"TaskArtifact":{"type":"object","properties":{"object":{"type":"string","enum":["file"]},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["image","document","video","audio","other"]},"mime_type":{"type":"string"},"size_bytes":{"type":"integer","minimum":0},"url":{"type":"string","description":"Download link on Vife's file storage, as in the web app; treat it like a password."},"thumbnail_url":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"}},"required":["object","id","name","type","mime_type","size_bytes","url","thumbnail_url","created_at"],"additionalProperties":false},"TaskPendingInput":{"description":"What the task waits for. Answer a question with POST /v1/tasks/{task_id}/messages (one of choices, an option's response, or free text); an action is answered in the web app at web_url.","oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["question"]},"interaction":{"type":"string","enum":["ask","next_step","confirm","review","save_skill","credit_confirm"]},"message":{"type":"string"},"questions":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"response":{"type":"string","description":"Send this as input to choose it."}},"required":["label","response"],"additionalProperties":false}}},"required":["question","options"],"additionalProperties":false}},"choices":{"type":"array","description":"Send one of these as input to choose it.","items":{"type":"string"}}},"required":["kind","interaction","message","questions","choices"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["action"]},"message":{"type":"string"},"actions":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","description":"The kind of action, e.g. connectorOauthExpired."},"message":{"type":"string"}},"required":["action","message"],"additionalProperties":false}}},"required":["kind","message","actions"],"additionalProperties":false}]},"Task":{"type":"object","properties":{"object":{"type":"string","enum":["task"]},"id":{"type":"string"},"title":{"type":"string"},"mode":{"type":"string","enum":["agent","chat","document","slide","spreadsheet","image","video","audio"]},"status":{"type":"string","description":"queued: accepted, not running yet (or a follow-up waits). running. needs_input: see pending_input. completed. failed: see error. stopped: stopped by you or the web app.","enum":["queued","running","needs_input","completed","failed","stopped"]},"source":{"type":"string","description":"api: created with a key; web; automation.","enum":["api","web","automation"]},"project_id":{"type":["string","null"]},"computer":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["cloud"]}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["desktop"]},"device_id":{"type":"string"},"approval":{"type":"string","description":"The approval level every step on the Mac uses."}},"required":["kind","device_id","approval"],"additionalProperties":false}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"metadata":{"type":"object","description":"Your metadata; {} for tasks not created with the API.","additionalProperties":{"type":"string","maxLength":500},"maxProperties":20},"queued_messages":{"type":"integer","description":"Follow-ups accepted while the task ran, not started yet.","minimum":0},"result":{"type":["object","null"],"description":"Set once the task is not queued or running; null in lists.","properties":{"text":{"type":["string","null"],"description":"The final answer after your latest message."},"text_truncated":{"type":"boolean","description":"True when an event cut text to 4,000 characters."},"artifacts":{"type":"array","description":"Files the task produced, newest first (50 per read, 20 per event); each url downloads one. All of them: GET /v1/tasks/{task_id}/files.","items":{"$ref":"#/components/schemas/TaskArtifact"}},"artifacts_truncated":{"type":"boolean"}},"required":["text","text_truncated","artifacts","artifacts_truncated"],"additionalProperties":false},"error":{"type":["object","null"],"properties":{"code":{"type":"string","description":"Why it failed, e.g. insufficient_credits, execution_error, tool_failed."},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},"pending_input":{"oneOf":[{"$ref":"#/components/schemas/TaskPendingInput"},{"type":"null"}]},"credits_used":{"type":["integer","null"],"description":"Credits charged so far; null in lists."},"web_url":{"type":"string","format":"uri"}},"required":["object","id","title","mode","status","source","project_id","computer","created_at","updated_at","metadata","queued_messages","result","error","pending_input","credits_used","web_url"],"additionalProperties":false},"TaskMessageReceipt":{"type":"object","properties":{"object":{"type":"string","enum":["task_message_receipt"]},"delivery":{"type":"string","description":"started: a new turn began. queued: the task was running; the message runs next.","enum":["started","queued"]},"task":{"$ref":"#/components/schemas/Task"}},"required":["object","delivery","task"],"additionalProperties":false},"TaskMessage":{"type":"object","properties":{"object":{"type":"string","enum":["task.message"]},"id":{"type":"string"},"role":{"type":"string","enum":["user","assistant"]},"type":{"type":"string","enum":["text","deliverable","question","tool_call"]},"text":{"type":["string","null"]},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mime_type":{"type":"string"}},"required":["id","name","mime_type"],"additionalProperties":false}},"tool":{"type":["object","null"],"description":"A tool step: its name, status and a short label only.","properties":{"name":{"type":"string"},"status":{"type":"string","enum":["running","succeeded","failed"]},"summary":{"type":["string","null"],"maxLength":200}},"required":["name","status","summary"],"additionalProperties":false},"created_at":{"type":"string","format":"date-time"}},"required":["object","id","role","type","text","files","tool","created_at"],"additionalProperties":false},"TaskList":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]}},"required":["object","data","has_more","next_cursor"],"additionalProperties":false},"TaskMessageList":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskMessage"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]}},"required":["object","data","has_more","next_cursor"],"additionalProperties":false},"TaskEvent":{"type":"object","description":"A webhook body, signed in Vife-Signature (t=<unix seconds>,v1=<hex HMAC-SHA256 of `${t}.${body}`>). Deduplicate by id (also in Vife-Event-Id).","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["task.completed","task.failed","task.needs_input"]},"created_at":{"type":"string","format":"date-time"},"api_version":{"type":"string"},"data":{"type":"object","properties":{"task":{"$ref":"#/components/schemas/Task"}},"required":["task"],"additionalProperties":false}},"required":["id","type","created_at","api_version","data"],"additionalProperties":false},"TaskShare":{"type":"object","properties":{"object":{"type":"string","enum":["task_share"]},"task_id":{"type":"string"},"visibility":{"type":"string","description":"public: anyone with url can read the task.","enum":["public","private"]},"url":{"type":["string","null"],"description":"The share page while public; null while private."}},"required":["object","task_id","visibility","url"],"additionalProperties":false},"File":{"type":"object","properties":{"object":{"type":"string","enum":["file"]},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["image","document","video","audio","other"]},"mime_type":{"type":"string"},"size_bytes":{"type":"integer","minimum":0},"source":{"type":"string","description":"upload (you uploaded it), generated (image, video or audio generation), workspace (a file a task wrote) or computer (a file from your Mac).","enum":["upload","generated","workspace","computer"]},"task_id":{"type":["string","null"],"description":"The task the file belongs to; null for a library file."},"url":{"type":"string","description":"Download link on Vife's file storage, as in the web app; treat it like a password."},"thumbnail_url":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"}},"required":["object","id","name","type","mime_type","size_bytes","source","task_id","url","thumbnail_url","created_at"],"additionalProperties":false},"TaskFile":{"type":"object","properties":{"object":{"type":"string","enum":["file"]},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["image","document","video","audio","other"]},"mime_type":{"type":"string"},"size_bytes":{"type":"integer","minimum":0},"source":{"type":"string","description":"upload (you uploaded it), generated (image, video or audio generation), workspace (a file a task wrote) or computer (a file from your Mac).","enum":["upload","generated","workspace","computer"]},"task_id":{"type":["string","null"],"description":"The task the file belongs to; null for a library file."},"url":{"type":"string","description":"Download link on Vife's file storage, as in the web app; treat it like a password."},"thumbnail_url":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"role":{"type":"string","description":"input: a file you attached; artifact: a file the task made.","enum":["input","artifact"]}},"required":["object","id","name","type","mime_type","size_bytes","source","task_id","url","thumbnail_url","created_at","role"],"additionalProperties":false},"TaskFileList":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskFile"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]}},"required":["object","data","has_more","next_cursor"],"additionalProperties":false},"FileUpload":{"type":"object","description":"Where to send an upload's bytes: exactly one of url (one PUT) and parts (one PUT per part) is set.","properties":{"object":{"type":"string","enum":["file_upload"]},"id":{"type":"string","description":"The id the file will have."},"method":{"type":"string","enum":["PUT"]},"headers":{"type":"object","description":"Send these headers with every PUT.","additionalProperties":{"type":"string"}},"url":{"type":["string","null"],"description":"PUT the whole file here (files up to 128 MiB)."},"parts":{"type":["array","null"],"description":"Larger files: PUT each byte range to its url, in any order, and keep the ETag response header of each.","items":{"type":"object","properties":{"part_number":{"type":"integer","minimum":1},"url":{"type":"string"},"size_bytes":{"type":"integer","minimum":1}},"required":["part_number","url","size_bytes"],"additionalProperties":false}},"upload_token":{"type":"string","description":"Pass it to complete. It works for this upload only."},"expires_at":{"type":"string","description":"PUT and complete before this time.","format":"date-time"}},"required":["object","id","method","headers","url","parts","upload_token","expires_at"],"additionalProperties":false},"FileUploadRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"mime_type":{"type":"string","description":"The file's MIME type. A generic (application/octet-stream) or image type is re-read from the bytes; any other type is stored as sent.","minLength":1,"maxLength":200},"size_bytes":{"type":"integer","description":"The exact size of the bytes you will PUT.","minimum":1}},"required":["name","mime_type","size_bytes"],"additionalProperties":false},"FileUploadCompleteRequest":{"type":"object","properties":{"upload_token":{"type":"string","description":"upload_token of the upload."},"parts":{"type":"array","description":"Only for an upload with parts: every part in order with the ETag its PUT answered.","items":{"type":"object","properties":{"part_number":{"type":"integer","minimum":1},"etag":{"type":"string","minLength":1,"maxLength":200}},"required":["part_number","etag"],"additionalProperties":false},"maxItems":100}},"required":["upload_token"],"additionalProperties":false},"MediaModel":{"type":"object","properties":{"object":{"type":"string","enum":["media_model"]},"id":{"type":"string"},"kind":{"type":"string","enum":["image","video","audio"]},"name":{"type":"string"},"input":{"description":"What the model takes: prompt and reference media, as the composer reads them."},"parameters":{"description":"The parameters options.image|video|audio accepts for this model."},"price":{"description":"Credits per unit (image, request, character or second); null when not priced."},"default":{"type":"boolean"}},"required":["object","id","kind","name","input","parameters","price","default"],"additionalProperties":false},"MediaModelList":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/MediaModel"}}},"required":["object","data"],"additionalProperties":false},"MediaJob":{"type":"object","description":"One background generation a task started (an image, video or audio tool call).","properties":{"object":{"type":"string","enum":["media_job"]},"id":{"type":"string"},"task_id":{"type":"string"},"kind":{"type":"string","enum":["image","video","audio"]},"model":{"type":"string"},"status":{"type":"string","enum":["queued","submitted","running","finalizing","succeeded","failed","cancelled"]},"origin":{"type":"string","description":"agent (the task), subagent (a child of the task) or editor (the video editor).","enum":["agent","subagent","editor"]},"requested_count":{"type":"integer","minimum":1},"created_at":{"type":"string","format":"date-time"},"finished_at":{"type":["string","null"],"format":"date-time"},"files":{"type":"array","description":"The generated files once the job succeeded.","items":{"$ref":"#/components/schemas/File"}},"error":{"type":["object","null"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["object","id","task_id","kind","model","status","origin","requested_count","created_at","finished_at","files","error"],"additionalProperties":false},"MediaEvent":{"type":"object","description":"A webhook body, signed in Vife-Signature like every event. Deduplicate by id (also in Vife-Event-Id).","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media.completed","media.failed"]},"created_at":{"type":"string","format":"date-time"},"api_version":{"type":"string"},"data":{"type":"object","properties":{"media_job":{"$ref":"#/components/schemas/MediaJob"}},"required":["media_job"],"additionalProperties":false}},"required":["id","type","created_at","api_version","data"],"additionalProperties":false},"MediaJobList":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/MediaJob"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]}},"required":["object","data","has_more","next_cursor"],"additionalProperties":false},"Automation":{"type":"object","properties":{"object":{"type":"string","enum":["automation"]},"id":{"type":"string"},"title":{"type":"string"},"kind":{"type":"string","enum":["schedule","trigger","advanced"]},"status":{"type":"string","description":"Derived: expired, paused (enabled false), needs_attention (see attention) or active.","enum":["active","paused","expired","needs_attention"]},"enabled":{"type":"boolean"},"instructions":{"type":"string"},"triggers":{"description":"The web's triggers; a webhook trigger carries its hookId (deliveries go to /api/public/automation-webhooks/{hookId} on this API's origin)."},"options":{"description":"The composer options; null for the defaults."},"approvals":{"type":"string","enum":["required","skip"]},"run_in":{"type":"string","enum":["separate","same"]},"agent_tier":{"type":"string","enum":["max","pro","lite"]},"project_type":{"type":"string","enum":["agent","document","spreadsheet","image","slide","audio","video","other"]},"project_id":{"type":["string","null"]},"group_id":{"type":["string","null"]},"connector_selection":{"type":"string","enum":["default","custom"]},"connector_ids":{"type":"array","items":{"type":"string"}},"file_ids":{"type":"array","items":{"type":"string"}},"expires_at":{"type":["string","null"],"format":"date-time"},"next_run_at":{"type":["string","null"],"description":"The next timer run; null for none.","format":"date-time"},"last_run_at":{"type":["string","null"],"format":"date-time"},"last_run_status":{"type":["string","null"],"enum":["queued","running","success","failed","not_triggered",null]},"attention":{"type":["string","null"],"description":"Why it needs attention; null when it does not."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"web_url":{"type":"string","description":"Its page in the Vife web app."}},"required":["object","id","title","kind","status","enabled","instructions","triggers","options","approvals","run_in","agent_tier","project_type","project_id","group_id","connector_selection","connector_ids","file_ids","expires_at","next_run_at","last_run_at","last_run_status","attention","created_at","updated_at","web_url"],"additionalProperties":false},"AutomationList":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Automation"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]}},"required":["object","data","has_more","next_cursor"],"additionalProperties":false},"AutomationRun":{"type":"object","properties":{"object":{"type":"string","enum":["automation_run"]},"id":{"type":"string"},"automation_id":{"type":"string"},"status":{"type":"string","description":"queued, running, success, failed or not_triggered (its conditions did not hold, or the agent found nothing to do).","enum":["queued","running","success","failed","not_triggered"]},"source":{"type":"string","description":"What started it; test for a run you started (POST .../runs).","enum":["timer","webhook","rss","connector","monitor","manual","test"]},"task_id":{"type":["string","null"],"description":"The task the run started (GET /v1/tasks/{task_id}); null when it never started one."},"event_title":{"type":["string","null"]},"summary":{"type":["string","null"]},"error":{"type":["string","null"]},"started_at":{"type":"string","format":"date-time"},"finished_at":{"type":["string","null"],"format":"date-time"}},"required":["object","id","automation_id","status","source","task_id","event_title","summary","error","started_at","finished_at"],"additionalProperties":false},"AutomationRunList":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AutomationRun"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]}},"required":["object","data","has_more","next_cursor"],"additionalProperties":false},"AutomationCreateRequest":{"type":"object","description":"Top-level keys are snake_case; triggers and options are the web's own JSON.","properties":{"kind":{"type":"string","description":"schedule (one timer), trigger (events) or advanced (any mix, monitors included).","enum":["schedule","trigger","advanced"]},"title":{"type":"string","minLength":1,"maxLength":200},"instructions":{"type":"string","description":"What the agent does on each run, at most 8 KB."},"triggers":{"description":"The web's triggers, camelCase inside, at most 10: timer {kind, frequency (once|daily|weekly|monthly), timezone, hour, minute, dayOfWeek, dayOfMonth, runAt}; webhook {kind, hookId (\"\" for a new one), mode (catch|raw), authHeaderRequired, fields, conditions}; rss {kind, feedUrls, conditions}; connector {kind, connectorId, params, conditions}; monitor {kind, intervalMinutes (≥ 60), condition}. A schedule has exactly one timer."},"enabled":{"type":"boolean"},"approvals":{"type":"string","description":"required: a run asks before sensitive actions; skip: it does not.","enum":["required","skip"]},"run_in":{"type":"string","description":"separate: each run is a new task; same: runs continue the last task.","enum":["separate","same"]},"agent_tier":{"type":"string","enum":["max","pro","lite"]},"project_type":{"type":"string","description":"The task mode of each run.","enum":["agent","document","spreadsheet","image","slide","audio","video","other"]},"options":{"description":"The composer options every run starts with, as a task's options (see TaskOptions); null for the defaults. A Mac target (agent.computerTarget) is saved with its approval capped at ask_for_approval."},"project_id":{"type":["string","null"],"description":"One of your projects each run's task joins; null for none."},"group_id":{"type":["string","null"],"description":"One of your automation groups it is listed under; null for none."},"file_ids":{"type":"array","description":"Your files every run starts with (upload ids, as for tasks); each run copies them into its task.","items":{"type":"string","format":"uuid"},"maxItems":10},"connector_selection":{"type":"string","description":"default: your connectors that are on at run time; custom: connector_ids.","enum":["default","custom"]},"connector_ids":{"type":"array","items":{"type":"string"}},"expires_at":{"type":["string","null"],"description":"When it stops running; null for never.","format":"date-time"}},"required":["kind","title","instructions","triggers"],"additionalProperties":false},"AutomationUpdateRequest":{"type":"object","description":"Only the fields present change; null clears project_id, group_id, options and expires_at, and file_ids [] removes every file.","properties":{"kind":{"type":"string","description":"schedule (one timer), trigger (events) or advanced (any mix, monitors included).","enum":["schedule","trigger","advanced"]},"title":{"type":"string","minLength":1,"maxLength":200},"instructions":{"type":"string","description":"What the agent does on each run, at most 8 KB."},"triggers":{"description":"The web's triggers, camelCase inside, at most 10: timer {kind, frequency (once|daily|weekly|monthly), timezone, hour, minute, dayOfWeek, dayOfMonth, runAt}; webhook {kind, hookId (\"\" for a new one), mode (catch|raw), authHeaderRequired, fields, conditions}; rss {kind, feedUrls, conditions}; connector {kind, connectorId, params, conditions}; monitor {kind, intervalMinutes (≥ 60), condition}. A schedule has exactly one timer."},"enabled":{"type":"boolean"},"approvals":{"type":"string","description":"required: a run asks before sensitive actions; skip: it does not.","enum":["required","skip"]},"run_in":{"type":"string","description":"separate: each run is a new task; same: runs continue the last task.","enum":["separate","same"]},"agent_tier":{"type":"string","enum":["max","pro","lite"]},"project_type":{"type":"string","description":"The task mode of each run.","enum":["agent","document","spreadsheet","image","slide","audio","video","other"]},"options":{"description":"The composer options every run starts with, as a task's options (see TaskOptions); null for the defaults. A Mac target (agent.computerTarget) is saved with its approval capped at ask_for_approval."},"project_id":{"type":["string","null"],"description":"One of your projects each run's task joins; null for none."},"group_id":{"type":["string","null"],"description":"One of your automation groups it is listed under; null for none."},"file_ids":{"type":"array","description":"Your files every run starts with (upload ids, as for tasks); each run copies them into its task.","items":{"type":"string","format":"uuid"},"maxItems":10},"connector_selection":{"type":"string","description":"default: your connectors that are on at run time; custom: connector_ids.","enum":["default","custom"]},"connector_ids":{"type":"array","items":{"type":"string"}},"expires_at":{"type":["string","null"],"description":"When it stops running; null for never.","format":"date-time"}},"required":[],"additionalProperties":false},"AutomationDeleted":{"type":"object","properties":{"object":{"type":"string","enum":["automation"]},"id":{"type":"string"},"deleted":{"type":"boolean"}},"required":["object","id","deleted"],"additionalProperties":false},"AutomationWebhookSecret":{"type":"object","description":"Shown once. Deliveries to the webhook must send Authorization: Bearer {token} from now on.","properties":{"object":{"type":"string","enum":["automation_webhook_secret"]},"hook_id":{"type":"string"},"token":{"type":"string","description":"The webhook's bearer token; it is not stored readable."}},"required":["object","hook_id","token"],"additionalProperties":false},"AutomationRunEvent":{"type":"object","description":"A webhook body, signed in Vife-Signature like every event. Deduplicate by id (also in Vife-Event-Id).","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["automation.run.finished"]},"created_at":{"type":"string","format":"date-time"},"api_version":{"type":"string"},"data":{"type":"object","properties":{"automation_run":{"$ref":"#/components/schemas/AutomationRun"},"automation":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}},"required":["id","title"],"additionalProperties":false}},"required":["automation_run","automation"],"additionalProperties":false}},"required":["id","type","created_at","api_version","data"],"additionalProperties":false},"Skill":{"type":"object","properties":{"object":{"type":"string","enum":["skill"]},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"source":{"type":"string","description":"official: built into Vife; own: one you made or uploaded; hub: added from the Skill Hub.","enum":["official","own","hub"]},"added":{"type":"boolean","description":"In your library."},"enabled":{"type":"boolean","description":"Offered to new tasks."},"locked":{"type":"boolean","description":"Required by Vife: always on, cannot be turned off."},"pro":{"type":"boolean","description":"Adding it needs a paid plan."},"can_enable":{"type":"boolean","description":"POST …/enable may switch it on: a skill already in your library, or an official one. A Skill Hub skill must be added in the web app first."},"version":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"required":["object","id","name","description","source","added","enabled","locked","pro","can_enable","version","created_at"],"additionalProperties":false},"SkillList":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Skill"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]}},"required":["object","data","has_more","next_cursor"],"additionalProperties":false},"Connector":{"type":"object","properties":{"object":{"type":"string","enum":["connector"]},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"kind":{"type":"string","enum":["addon","extension","app","mcp","api"]},"source":{"type":"string","enum":["official","custom"]},"installed":{"type":"boolean","description":"Added to your connectors (connected at least once)."},"enabled":{"type":"boolean","description":"On by default in new tasks."},"status":{"type":"string","description":"not_connected: never added; needs_sign_in: the sign-in expired or its tokens are gone; error: the connection is broken. Fix both at connect_url.","enum":["not_connected","connected","needs_sign_in","error"]},"connect_url":{"type":"string","description":"The connector in the web app, where you connect, sign in or configure it. The API never signs in for you.","format":"uri"},"created_at":{"type":"string","format":"date-time"}},"required":["object","id","name","description","kind","source","installed","enabled","status","connect_url","created_at"],"additionalProperties":false},"ConnectorList":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Connector"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]}},"required":["object","data","has_more","next_cursor"],"additionalProperties":false},"Account":{"type":"object","properties":{"object":{"type":"string","enum":["account"]},"user_id":{"type":"string"},"credits":{"type":"object","properties":{"balance":{"type":"integer"},"total_earned":{"type":"integer"},"total_spent":{"type":"integer"},"low_threshold":{"type":"integer","description":"Below this balance the web app warns and credits.low fires."}},"required":["balance","total_earned","total_spent","low_threshold"],"additionalProperties":false},"plan":{"type":"object","description":"The plan in effect (code basic for a free account) and its membership.","properties":{"code":{"type":"string"},"name":{"type":"string"},"status":{"type":["string","null"],"enum":["active","cancelled","expired","paused",null]},"billing_cycle":{"type":["string","null"],"enum":["monthly","yearly",null]},"current_period_end":{"type":["string","null"],"format":"date-time"},"auto_renew":{"type":"boolean"},"concurrent_tasks":{"type":"integer"},"monthly_credits":{"type":"integer"},"pass":{"type":["object","null"],"description":"The prepaid pass the plan runs on; null for a card subscription or none.","properties":{"term":{"type":"string"},"period_end":{"type":"string","format":"date-time"}},"required":["term","period_end"],"additionalProperties":false}},"required":["code","name","status","billing_cycle","current_period_end","auto_renew","concurrent_tasks","monthly_credits","pass"],"additionalProperties":false},"rate_limits":{"type":"object","properties":{"tier":{"type":"string","enum":["free","member"]},"key_per_minute":{"type":"integer"},"account_per_minute":{"type":"integer"}},"required":["tier","key_per_minute","account_per_minute"],"additionalProperties":false}},"required":["object","user_id","credits","plan","rate_limits"],"additionalProperties":false},"AccountTransaction":{"type":"object","properties":{"object":{"type":"string","enum":["account_transaction"]},"id":{"type":"string"},"type":{"type":"string","enum":["earn","spend","refill","bonus","refund","check_in","registration","subscription","referral_reward","referral_bonus"]},"amount":{"type":"integer","description":"Credits added (positive) or spent (negative)."},"balance_after":{"type":"integer"},"description":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"required":["object","id","type","amount","balance_after","description","created_at"],"additionalProperties":false},"AccountTransactionList":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AccountTransaction"}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]}},"required":["object","data","has_more","next_cursor"],"additionalProperties":false},"CreditsLowEvent":{"type":"object","description":"A webhook body, signed in Vife-Signature like every event. Deduplicate by id (also in Vife-Event-Id).","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits.low"]},"created_at":{"type":"string","format":"date-time"},"api_version":{"type":"string"},"data":{"type":"object","properties":{"balance":{"type":"integer","description":"The balance right after the entry."},"threshold":{"type":"integer"},"transaction":{"$ref":"#/components/schemas/AccountTransaction"}},"required":["balance","threshold","transaction"],"additionalProperties":false}},"required":["id","type","created_at","api_version","data"],"additionalProperties":false}}}}