Estimate the credits of an analysis or a build

About

Call it before analyze_project (POST /v1/projects/{projectId}/analyze), before the build of a split screen, streamer or Reddit story project, or before preparing a Vibe Editing project, to show the price and to check that the account can pay it. It refuses for the same reasons the start would (no source video, settings still to choose, a video that no longer exists), so a project it accepts is ready to start, and the price it gives is the one the start charges. The price of an analysis depends only on the length of the source video, never on the settings: when the user only wants the price of an Auto Clip project with settings still to choose, choose them with update_project (PATCH /v1/projects/{projectId}) (get_setting_options (GET /v1/reference/setting-options) lists the values) and estimate again, and tell the user they can change them before analyze_project. payer says who would pay now: the plan or the API bonus. When the same work is already running, creditsToCharge is 0, runningJobId is its job, payer is null and enough is true, even when planRequired is true. Fake text projects have no price here: their story and voices use the daily fake text allowance. Nothing is charged or changed.

Example use

A nightly script goes through the projects in its queue one at a time. It estimates each one and starts the analysis only when enough is true. The projects it cannot pay for wait for the next night.

Endpoint

POST https://api.gpt-video.com/v1/projects/{projectId}/analyze/estimate

• Scope clips:read.
• Rate limit 120 requests a minute for each key and 240 for each account, shared by every read call. See rate limits.
• No Idempotency-Key.

Parameters

Path

Request

Price an analysis before starting it.

curl -X POST "https://api.gpt-video.com/v1/projects/prj_7c2e9a4f1b3d4e8096a5/analyze/estimate" \
  -H "Authorization: Bearer $GPT_VIDEO_API_KEY"

const res = await fetch("https://api.gpt-video.com/v1/projects/prj_7c2e9a4f1b3d4e8096a5/analyze/estimate", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.GPT_VIDEO_API_KEY}`,
  },
});
const data = await res.json();
console.log(data);

import os

import requests

r = requests.post(
    "https://api.gpt-video.com/v1/projects/prj_7c2e9a4f1b3d4e8096a5/analyze/estimate",
    headers={
        "Authorization": f"Bearer {os.environ['GPT_VIDEO_API_KEY']}",
    },
)
data = r.json()
print(data)

{
  "method": "tools/call",
  "params": {
    "name": "estimate_analysis",
    "arguments": {
      "projectId": "prj_7c2e9a4f1b3d4e8096a5"
    }
  }
}

Response

A successful call answers HTTP 200.

Fields to check

Response example

{
  "estimate": {
    "credits": 30,
    "creditsToCharge": 30,
    "sourceDurationSec": 1800,
    "runningJobId": null,
    "creditsAvailable": 640,
    "planRequired": false,
    "enough": true,
    "payer": "plan",
    "bonusRemaining": null
  }
}

{
  "estimate": {
    "credits": 30,
    "creditsToCharge": 0,
    "sourceDurationSec": 1800,
    "runningJobId": "job_6c1e8b4a2f0d4a97e3b5",
    "creditsAvailable": 640,
    "planRequired": false,
    "enough": true,
    "payer": null,
    "bonusRemaining": null
  }
}

{
  "estimate": {
    "credits": 31,
    "creditsToCharge": 31,
    "sourceDurationSec": 1860,
    "runningJobId": null,
    "creditsAvailable": 640,
    "planRequired": false,
    "enough": true,
    "payer": "plan",
    "bonusRemaining": null
  }
}

{
  "estimate": {
    "credits": 1,
    "creditsToCharge": 1,
    "sourceDurationSec": 0,
    "runningJobId": null,
    "creditsAvailable": 640,
    "planRequired": false,
    "enough": true,
    "payer": "plan",
    "bonusRemaining": null
  }
}

{
  "error": {
    "code": "SOURCE_MISSING",
    "message": "Upload or import a source video before starting the analysis.",
    "hint": "A project's video cannot be changed through the API. Upload the video, then create a new project with its asset id as sourceAssetId.",
    "requestId": "req_b4e0a7c3d9f14a62c8e5d1b7"
  }
}

Errors

Every call can also answer these errors. VALIDATION_FAILED, UNKNOWN_PARAMETER, UNAUTHORIZED, SCOPE_MISSING, PAYLOAD_TOO_LARGE, RATE_LIMITED, INTERNAL, UNAVAILABLE.

Cost

No credits are used.

Related operations

• analyze_project (POST /v1/projects/{projectId}/analyze) Analyze a project
• build_split_screen_video (POST /v1/projects/{projectId}/split-screen/build) Build a split screen video
• build_streamer_video (POST /v1/projects/{projectId}/streamer/build) Build a streamer video
• build_reddit_story_video (POST /v1/projects/{projectId}/reddit-story/build) Build a Reddit story video
• get_project (GET /v1/projects/{projectId}) Get a project
• get_credits (GET /v1/credits) Get the credit balance

Questions

Does an estimate reserve the credits?

No. Nothing is reserved: the credits are charged when the analysis or the build starts, at the price it reports then.

Why is creditsToCharge 0 when credits is not?

The same work is already running on the project. The start would return that job and charge nothing; credits is the price of a new one.

Who pays when the account has the API bonus?

payer says it. Through the API the bonus pays first while it covers the whole price, and on the Creator and Studio plans the plan pays otherwise. On any other plan a price the bonus cannot cover is refused. The bonus never pays part of a price, and a price is never split between the two.

View as Markdown