{ "openapi": "3.1.0", "info": { "title": "Getuser API", "version": "1.0.0", "description": "Make UGC-style videos and slideshows for your app with the same credits and limits as getuser.app. Plan first (free), then render (25 credits each), then poll for the download link." }, "servers": [ { "url": "https://getuser.app/api" } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "tags": [ { "name": "Account" }, { "name": "Library" }, { "name": "Uploads" }, { "name": "Videos" }, { "name": "Slideshows" }, { "name": "AI" }, { "name": "Posting plan" } ], "paths": { "/v1/me": { "get": { "operationId": "getMe", "summary": "Your workspace, plan, credits, storage and setup", "tags": [ "Account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/health/auth": { "get": { "operationId": "getHealthAuth", "summary": "Check that a key works", "tags": [ "Account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true } }, "required": [ "ok" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/personas": { "get": { "operationId": "getPersonas", "summary": "Personas you can use, with their reactions", "description": "Every persona is an AI-made person, and every video labels it as AI. Reactions you switched off are left out.", "tags": [ "Library" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Persona" } }, "next_cursor": { "type": "null" } }, "required": [ "data", "next_cursor" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/lines": { "get": { "operationId": "getLines", "summary": "Hook lines: the library and your own", "tags": [ "Library" ], "parameters": [ { "name": "source", "in": "query", "required": false, "schema": { "default": "all", "type": "string", "enum": [ "all", "own" ] } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 8 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Line" } }, "next_cursor": { "type": "null" } }, "required": [ "data", "next_cursor" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/assets": { "get": { "operationId": "getAssets", "summary": "Your uploads", "tags": [ "Library" ], "parameters": [ { "name": "kind", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hook", "demo", "ending", "image", "music" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } }, "next_cursor": { "type": "null" } }, "required": [ "data", "next_cursor" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/assets/{id}": { "get": { "operationId": "getAssetsById", "summary": "One upload", "tags": [ "Library" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/recipes": { "get": { "operationId": "getRecipes", "summary": "Your saved Batch settings", "tags": [ "Library" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Recipe" } }, "next_cursor": { "type": "null" } }, "required": [ "data", "next_cursor" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/slide-formats": { "get": { "operationId": "getSlideFormats", "summary": "Your slideshow formats", "tags": [ "Library" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SlideFormat" } }, "next_cursor": { "type": "null" } }, "required": [ "data", "next_cursor" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/music": { "get": { "operationId": "getMusic", "summary": "Stock music cleared for your videos", "tags": [ "Library" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Track" } }, "next_cursor": { "type": "null" } }, "required": [ "data", "next_cursor" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/uploads": { "post": { "operationId": "postUploads", "summary": "Start an upload", "description": "Then PUT the bytes to upload_url and call /v1/uploads/{id}/complete. The same file again answers the upload already there.", "tags": [ "Uploads" ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "hook", "demo", "ending", "image", "music" ] }, "role": { "description": "Images only: which slide a photo is for", "type": "string", "enum": [ "hook", "app", "background", "icon" ] }, "filename": { "type": "string", "minLength": 1, "maxLength": 200 }, "mime_type": { "type": "string", "maxLength": 100 }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Bytes" }, "fingerprint": { "description": "SHA-256 of the file: the same file again answers the upload already there", "type": "string", "pattern": "^[0-9a-f]{64}$" }, "cuts": { "description": "Demos only: parts of a long recording, each its own demo", "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "number", "minimum": 0 }, "end": { "type": "number" }, "speed": { "anyOf": [ { "type": "number", "const": 1 }, { "type": "number", "const": 1.5 }, { "type": "number", "const": 2 } ] } }, "required": [ "start", "end", "speed" ] } } }, "required": [ "kind", "filename", "mime_type", "size" ] } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadStarted" } } } }, "400": { "description": "invalid_input: The request is not valid. See issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "too_large: The file is larger than your plan allows.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "uploads_used: That's all the uploads your plan allows for now. · storage_full", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/uploads/{id}/complete": { "post": { "operationId": "postUploadsByIdComplete", "summary": "Say the bytes are in; processing starts", "description": "Poll GET /v1/assets/{id} until status is ready. A file larger than the size its upload declared is deleted and refused.", "tags": [ "Uploads" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true } }, "required": [ "ok" ], "additionalProperties": false } } } }, "400": { "description": "invalid_input: The request is not valid. See issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "too_large: The file is larger than your plan allows.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/videos/plan": { "post": { "operationId": "postVideosPlan", "summary": "Plan videos (free, renders nothing)", "description": "The app's own planner. Show the drafts and their cost, then send them to POST /v1/videos.", "tags": [ "Videos" ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "format": { "default": "hook-demo", "type": "string", "enum": [ "hook-demo", "one-caption" ] }, "count": { "default": 5, "description": "At most 20, and no more than the credits pay for", "type": "integer", "minimum": 1, "maximum": 100 }, "persona_ids": { "maxItems": 10, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "demo_ids": { "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "lines": { "default": "all", "type": "string", "enum": [ "all", "own" ] }, "music": { "default": true, "type": "boolean" }, "theme": { "default": "white", "type": "string", "enum": [ "white", "black", "box", "light-box" ] }, "recipe_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "variant": { "default": 0, "description": "Another plan for the same settings, as Re-plan in the app", "type": "integer", "minimum": 0, "maximum": 50 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoPlan" } } } }, "400": { "description": "invalid_input: The request is not valid. See issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "not_enough_credits: Not enough credits for this. A video or slideshow costs 25.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "setup_incomplete: Finish setting up at getuser.app first. Videos need your app, 5 demos and your own reaction. · no_demo · no_personas · no_lines", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/videos": { "post": { "operationId": "postVideos", "summary": "Render drafts: 25 credits each", "description": "Credits are held now and charged when each video is ready; a failed or cancelled video gives them back. Send an Idempotency-Key.", "tags": [ "Videos" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "A uuid. Sending the same request again with the same key makes nothing twice; without one, a retry may.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "drafts": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "$ref": "#/components/schemas/Draft" } } }, "required": [ "drafts" ] } } } }, "responses": { "202": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queued" } } } }, "400": { "description": "invalid_input: The request is not valid. See issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "not_enough_credits: Not enough credits for this. A video or slideshow costs 25.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "idempotency_conflict: This Idempotency-Key was used with a different request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "not_ready: An upload it uses is still processing or was deleted. · text_too_long · setup_incomplete · storage_full · queue_full", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "operationId": "getVideos", "summary": "Your videos, newest first", "tags": [ "Videos" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "queued", "rendering", "ready", "failed" ] } }, { "name": "batch_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Video" } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/videos/{id}": { "get": { "operationId": "getVideosById", "summary": "A video, with its download link once ready", "tags": [ "Videos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Video" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/videos/{id}/retry": { "post": { "operationId": "postVideosByIdRetry", "summary": "Render a failed video again", "tags": [ "Videos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "A uuid. Sending the same request again with the same key makes nothing twice; without one, a retry may.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string", "const": "queued" } }, "required": [ "id", "status" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "not_enough_credits: Not enough credits for this. A video or slideshow costs 25.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "already_queued: This video is already queued or rendering. · already_rendered", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "not_ready: An upload it uses is still processing or was deleted. · storage_full · queue_full · rerenders_used", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/videos/{id}/cancel": { "post": { "operationId": "postVideosByIdCancel", "summary": "Stop a waiting video; its credits come back", "tags": [ "Videos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cancelled": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "cancelled" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/batches/{id}": { "get": { "operationId": "getBatchesById", "summary": "A batch, its videos and a zip download plan", "tags": [ "Videos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/batches/{id}/cancel": { "post": { "operationId": "postBatchesByIdCancel", "summary": "Stop what of a batch still waits", "tags": [ "Videos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cancelled": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "cancelled" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/slideshows": { "post": { "operationId": "postSlideshows", "summary": "Make a slideshow from a format: 25 credits", "tags": [ "Slideshows" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "A uuid. Sending the same request again with the same key makes nothing twice; without one, a retry may.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "format_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "slides": { "default": "auto", "description": "How many slides in all, or auto", "anyOf": [ { "type": "string", "const": "auto" }, { "type": "integer", "minimum": 2, "maximum": 12 } ] } }, "required": [ "format_id" ] } } } }, "responses": { "202": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string", "const": "queued" } }, "required": [ "id", "status" ], "additionalProperties": false } } } }, "400": { "description": "invalid_input: The request is not valid. See issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "not_enough_credits: Not enough credits for this. A video or slideshow costs 25.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "idempotency_conflict: This Idempotency-Key was used with a different request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "not_ready: An upload it uses is still processing or was deleted. · text_too_long · setup_incomplete · storage_full · queue_full · ai_paused", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/slideshows/batch": { "post": { "operationId": "postSlideshowsBatch", "summary": "Make several slideshows from one format: 25 credits each", "tags": [ "Slideshows" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "A uuid. Sending the same request again with the same key makes nothing twice; without one, a retry may.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "format_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "count": { "type": "integer", "minimum": 1, "maximum": 20 } }, "required": [ "format_id", "count" ] } } } }, "responses": { "202": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queued" } } } }, "400": { "description": "invalid_input: The request is not valid. See issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "not_enough_credits: Not enough credits for this. A video or slideshow costs 25.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "idempotency_conflict: This Idempotency-Key was used with a different request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "not_ready: An upload it uses is still processing or was deleted. · text_too_long · setup_incomplete · storage_full · queue_full · ai_paused", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/slideshows/{id}": { "get": { "operationId": "getSlideshowsById", "summary": "A slideshow and its slides", "tags": [ "Slideshows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Slideshow" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/ai/lines": { "post": { "operationId": "postAiLines", "summary": "Write new hook lines for your app (AI credits)", "description": "Written from your app profile and saved as your own lines.", "tags": [ "AI" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "A uuid. Sending the same request again with the same key makes nothing twice; without one, a retry may.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Null when it was not saved", "type": [ "string", "null" ] }, "text": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "id", "text", "kind" ], "additionalProperties": false } }, "saved": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Saved as your own lines; a workspace keeps at most 100" }, "credits": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "lines", "saved", "credits" ], "additionalProperties": false } } } }, "400": { "description": "invalid_input: The request is not valid. See issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "not_enough_credits: Not enough credits for this. A video or slideshow costs 25.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "request_in_progress: A request with this Idempotency-Key is still running.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "ai_paused: AI writing is paused for a moment. Try again later. · ai_unavailable · ai_hour_used · ai_day_used", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/ai/captions": { "post": { "operationId": "postAiCaptions", "summary": "Write a post caption for a video (AI credits)", "tags": [ "AI" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "A uuid. Sending the same request again with the same key makes nothing twice; without one, a retry may.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "video_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "platform": { "default": null, "anyOf": [ { "type": "string", "enum": [ "tiktok", "instagram" ] }, { "type": "null" } ] } }, "required": [ "video_id" ] } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "caption": { "type": "string" }, "credits": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "caption", "credits" ], "additionalProperties": false } } } }, "400": { "description": "invalid_input: The request is not valid. See issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "not_enough_credits: Not enough credits for this. A video or slideshow costs 25.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "request_in_progress: A request with this Idempotency-Key is still running.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "ai_paused: AI writing is paused for a moment. Try again later. · ai_unavailable · ai_hour_used · ai_day_used", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/profiles": { "get": { "operationId": "getProfiles", "summary": "Your TikTok and Instagram profile cards", "tags": [ "Posting plan" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Profile" } }, "next_cursor": { "type": "null" } }, "required": [ "data", "next_cursor" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/plan": { "get": { "operationId": "getPlan", "summary": "The posting calendar", "description": "Defaults to the next 30 days.", "tags": [ "Posting plan" ], "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PlanItem" } }, "next_cursor": { "type": "null" } }, "required": [ "data", "next_cursor" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "postPlan", "summary": "Put a finished video on the calendar", "description": "Placing is not posting: you post from the app.", "tags": [ "Posting plan" ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "video_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "profile_id": { "description": "Left out: a video already on the plan keeps its profile", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "planned_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "video_id", "planned_at" ] } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanItem" } } } }, "400": { "description": "invalid_input: The request is not valid. See issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "not_ready: An upload it uses is still processing or was deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/plan/{id}": { "delete": { "operationId": "deletePlanById", "summary": "Take a video off the calendar (the video stays)", "tags": [ "Posting plan" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "const": true } }, "required": [ "ok" ], "additionalProperties": false } } } }, "401": { "description": "invalid_key: The API key is missing, wrong or revoked. Make a new one at getuser.app/settings/api.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "suspended: This account is paused. Email support@getuser.app if you think that is a mistake. · terms_not_accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "not_found: Not found in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "rate_limited: Too many requests. Wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "internal: Something went wrong on our side. Try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "unavailable: Getuser is paused for maintenance. Try again in a few minutes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_input", "invalid_key", "not_enough_credits", "suspended", "terms_not_accepted", "not_found", "already_queued", "already_rendered", "already_scheduled", "idempotency_conflict", "request_in_progress", "too_large", "setup_incomplete", "storage_full", "queue_full", "ai_paused", "ai_unavailable", "rerenders_used", "uploads_used", "posts_used", "ai_hour_used", "ai_day_used", "files_gone", "not_failed", "account_not_connected", "text_too_long", "not_ready", "no_demo", "no_personas", "no_lines", "too_many_keys", "rate_limited", "internal", "unavailable" ] }, "message": { "type": "string" }, "docs": { "type": "string", "format": "uri" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "type": [ "string", "number" ] } }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "detail": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "code", "message", "docs" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "Account": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "app_name": { "type": "string" }, "plan": { "type": "string", "enum": [ "free", "trial", "pro", "max" ] }, "credits": { "type": "object", "properties": { "balance": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "held": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "resets_at": { "type": [ "string", "null" ] }, "daily": { "type": "boolean", "description": "Free gets its credits a day at a time" }, "video_cost": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "slideshow_cost": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "balance", "held", "resets_at", "daily", "video_cost", "slideshow_cost" ], "additionalProperties": false }, "storage": { "type": "object", "properties": { "used_bytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "limit_bytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "used_bytes", "limit_bytes" ], "additionalProperties": false }, "setup": { "type": "object", "properties": { "videos": { "type": "object", "properties": { "ready": { "type": "boolean" }, "missing": { "type": "array", "items": { "type": "string", "enum": [ "app", "demos", "reaction", "images" ] } } }, "required": [ "ready", "missing" ], "additionalProperties": false, "description": "Videos need the app, 5 demos and your own reaction" }, "slideshows": { "type": "object", "properties": { "ready": { "type": "boolean" }, "missing": { "type": "array", "items": { "type": "string", "enum": [ "app", "demos", "reaction", "images" ] } } }, "required": [ "ready", "missing" ], "additionalProperties": false, "description": "Slideshows need the app and 5 images" } }, "required": [ "videos", "slideshows" ], "additionalProperties": false, "description": "What is still missing before Getuser can make each" }, "key": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "workspace", "app_name", "plan", "credits", "storage", "setup", "key" ], "additionalProperties": false }, "Persona": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "language": { "type": "string" }, "poster_url": { "type": [ "string", "null" ] }, "ai_made": { "type": "boolean", "const": true, "description": "Every persona is an AI-made person; videos label it as AI" }, "chosen": { "type": "boolean" }, "clip_ids": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "clips": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "duration": { "type": "number" }, "opener": { "type": "boolean" } }, "required": [ "id", "name", "duration", "opener" ], "additionalProperties": false } } }, "required": [ "id", "name", "language", "poster_url", "ai_made", "chosen", "clip_ids", "clips" ], "additionalProperties": false }, "Line": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "own": { "type": "boolean" }, "language": { "type": "string" }, "template": { "type": "string" }, "text": { "description": "The line filled in for your app; null when it does not fit it", "type": [ "string", "null" ] } }, "required": [ "id", "kind", "own", "language", "template", "text" ], "additionalProperties": false }, "Asset": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": [ "hook", "demo", "ending", "image", "music" ] }, "role": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "ready", "rejected" ] }, "uploaded": { "type": "boolean" }, "duration": { "type": [ "number", "null" ] }, "url": { "description": "One-hour link to the processed file, once ready", "type": [ "string", "null" ] }, "reject_reason": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" } }, "required": [ "id", "kind", "role", "name", "status", "uploaded", "duration", "url", "reject_reason", "expires_at", "created_at" ], "additionalProperties": false }, "Recipe": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "settings": {}, "created_at": { "type": "string" } }, "required": [ "id", "name", "settings", "created_at" ], "additionalProperties": false }, "SlideFormat": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "size": { "type": "string", "enum": [ "portrait", "story" ] }, "slides": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "hooks": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "language": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "size", "slides", "hooks", "language", "created_at" ], "additionalProperties": false }, "Track": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "duration": { "type": [ "number", "null" ] } }, "required": [ "id", "name", "duration" ], "additionalProperties": false }, "UploadStarted": { "type": "object", "properties": { "asset_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reused": { "type": "boolean" }, "upload_url": { "description": "PUT the bytes here; null when the same file was already uploaded", "type": [ "string", "null" ] }, "upload_headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "expires_at": { "type": [ "string", "null" ] } }, "required": [ "asset_id", "reused", "upload_url", "upload_headers", "expires_at" ], "additionalProperties": false }, "VideoPlan": { "type": "object", "properties": { "drafts": { "type": "array", "items": { "$ref": "#/components/schemas/Draft" } }, "cost": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "credits_after": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "note": { "type": [ "string", "null" ] } }, "required": [ "drafts", "cost", "credits_after", "note" ], "additionalProperties": false }, "Draft": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "hook-demo", "one-caption" ] }, "pattern_id": { "type": [ "string", "null" ] }, "hook_text": { "type": "string" }, "ending_text": { "default": "", "type": "string" }, "clip_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "The persona reaction; required for hook-demo" }, "hook_asset_id": { "default": null, "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "demo_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "ending_id": { "default": null, "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "track": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "enum": [ "stock", "upload" ] } }, "required": [ "id", "source" ] }, { "type": "null" } ] }, "theme": { "type": "string", "enum": [ "white", "black", "box", "light-box" ] }, "ai_label": { "default": true, "description": "Ignored: every video showing a persona is labelled as AI", "type": "boolean" }, "keep_audio": { "default": false, "type": "boolean" } }, "required": [ "format", "pattern_id", "hook_text", "clip_id", "demo_id", "track", "theme" ] }, "Queued": { "type": "object", "properties": { "batch_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "videos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string", "const": "queued" } }, "required": [ "id", "status" ], "additionalProperties": false } }, "refused": { "anyOf": [ { "type": "object", "properties": { "index": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "code": { "type": "string", "enum": [ "invalid_input", "invalid_key", "not_enough_credits", "suspended", "terms_not_accepted", "not_found", "already_queued", "already_rendered", "already_scheduled", "idempotency_conflict", "request_in_progress", "too_large", "setup_incomplete", "storage_full", "queue_full", "ai_paused", "ai_unavailable", "rerenders_used", "uploads_used", "posts_used", "ai_hour_used", "ai_day_used", "files_gone", "not_failed", "account_not_connected", "text_too_long", "not_ready", "no_demo", "no_personas", "no_lines", "too_many_keys", "rate_limited", "internal", "unavailable" ] }, "message": { "type": "string" } }, "required": [ "index", "code", "message" ], "additionalProperties": false }, { "type": "null" } ], "description": "The first draft refused, if any; the ones after it were not tried" }, "credits_held": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "batch_id", "videos", "refused", "credits_held" ], "additionalProperties": false }, "Video": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "format": { "type": "string", "enum": [ "hook-demo", "one-caption", "slides" ] }, "status": { "type": "string", "enum": [ "queued", "rendering", "ready", "failed" ] }, "error_code": { "anyOf": [ { "type": "string", "enum": [ "invalid_input", "invalid_key", "not_enough_credits", "suspended", "terms_not_accepted", "not_found", "already_queued", "already_rendered", "already_scheduled", "idempotency_conflict", "request_in_progress", "too_large", "setup_incomplete", "storage_full", "queue_full", "ai_paused", "ai_unavailable", "rerenders_used", "uploads_used", "posts_used", "ai_hour_used", "ai_day_used", "files_gone", "not_failed", "account_not_connected", "text_too_long", "not_ready", "no_demo", "no_personas", "no_lines", "too_many_keys", "rate_limited", "internal", "unavailable" ] }, { "type": "null" } ] }, "error": { "type": [ "string", "null" ] }, "hook_text": { "type": "string" }, "persona_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "batch_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "poster_url": { "type": [ "string", "null" ] }, "download_url": { "description": "One-hour link to the MP4, once ready", "type": [ "string", "null" ] }, "credits": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "format", "status", "error_code", "error", "hook_text", "persona_id", "batch_id", "created_at", "poster_url", "download_url", "credits" ], "additionalProperties": false }, "Batch": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "format": { "type": "string" }, "size": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "created_at": { "type": "string" }, "videos": { "type": "array", "items": { "$ref": "#/components/schemas/Video" } }, "zip": { "$ref": "#/components/schemas/ZipPlan" } }, "required": [ "id", "format", "size", "created_at", "videos", "zip" ], "additionalProperties": false }, "ZipPlan": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "files": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": [ "string", "null" ] } }, "required": [ "name", "url" ], "additionalProperties": false } } }, "required": [ "name", "files" ], "additionalProperties": false }, { "type": "null" } ] }, "Slideshow": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "format": { "type": "string", "enum": [ "hook-demo", "one-caption", "slides" ] }, "status": { "type": "string", "enum": [ "queued", "rendering", "ready", "failed" ] }, "error_code": { "anyOf": [ { "type": "string", "enum": [ "invalid_input", "invalid_key", "not_enough_credits", "suspended", "terms_not_accepted", "not_found", "already_queued", "already_rendered", "already_scheduled", "idempotency_conflict", "request_in_progress", "too_large", "setup_incomplete", "storage_full", "queue_full", "ai_paused", "ai_unavailable", "rerenders_used", "uploads_used", "posts_used", "ai_hour_used", "ai_day_used", "files_gone", "not_failed", "account_not_connected", "text_too_long", "not_ready", "no_demo", "no_personas", "no_lines", "too_many_keys", "rate_limited", "internal", "unavailable" ] }, { "type": "null" } ] }, "error": { "type": [ "string", "null" ] }, "hook_text": { "type": "string" }, "persona_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "batch_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "poster_url": { "type": [ "string", "null" ] }, "download_url": { "description": "One-hour link to the MP4, once ready", "type": [ "string", "null" ] }, "credits": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "slides": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] } }, "required": [ "url" ], "additionalProperties": false } }, "zip": { "$ref": "#/components/schemas/ZipPlan" } }, "required": [ "id", "format", "status", "error_code", "error", "hook_text", "persona_id", "batch_id", "created_at", "poster_url", "download_url", "credits", "slides", "zip" ], "additionalProperties": false }, "Profile": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "platform": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "display_name": { "type": [ "string", "null" ] }, "connected": { "type": "boolean" } }, "required": [ "id", "platform", "username", "display_name", "connected" ], "additionalProperties": false } } }, "required": [ "id", "name", "accounts" ], "additionalProperties": false }, "PlanItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The plan item is the video itself" }, "video_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "profile_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "planned_at": { "type": "string" }, "hook_text": { "type": "string" }, "format": { "type": "string" } }, "required": [ "id", "video_id", "profile_id", "planned_at", "hook_text", "format" ], "additionalProperties": false } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "description": "Authorization: Bearer gu_…" }, "apiKey": { "type": "apiKey", "in": "header", "name": "x-api-key" } } } }