logo
OpenapiStudio

Get Studio credit usage

API Docs with browser client
GET
/studio/credits

Get sourced AI credit usage, limits, refresh time, and current Studio generation costs. The same AI credit pool is shared with Outbound.

Authorization

x-api-key<token>

In: header

Header Parameters

x-namefi-eip7702-account?string

Optional delegated account address to authenticate as when the signer is an approved signer. Preferred header name.

x-namefi-eip1271-account?string

Legacy alias for x-namefi-erc1271-account. When multiple delegated account headers are present, x-namefi-eip7702-account takes precedence, then x-namefi-erc1271-account.

x-namefi-erc1271-account?string

Optional delegated account address to authenticate as when the signer is an approved signer. Preferred ERC-1271 header name.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.namefi.dev/v-next/studio/credits"
{
  "creditsUsed": 9007199254740991,
  "creditsIncluded": 9007199254740991,
  "creditsAwarded": 9007199254740991,
  "creditsLimit": 9007199254740991,
  "creditsRemaining": 9007199254740991,
  "creditsRefreshAt": "2019-08-24T14:15:22Z",
  "creditCosts": {
    "logo": {
      "defaultCredits": 9007199254740991,
      "creditsByModel": {
        "property1": 9007199254740991,
        "property2": 9007199254740991
      },
      "creditsByMode": {
        "property1": {
          "defaultCredits": 9007199254740991,
          "creditsByModel": {
            "property1": 9007199254740991,
            "property2": 9007199254740991
          }
        },
        "property2": {
          "defaultCredits": 9007199254740991,
          "creditsByModel": {
            "property1": 9007199254740991,
            "property2": 9007199254740991
          }
        }
      }
    },
    "poster": {
      "defaultCredits": 9007199254740991,
      "creditsByModel": {
        "property1": 9007199254740991,
        "property2": 9007199254740991
      },
      "creditsByMode": {
        "property1": {
          "defaultCredits": 9007199254740991,
          "creditsByModel": {
            "property1": 9007199254740991,
            "property2": 9007199254740991
          }
        },
        "property2": {
          "defaultCredits": 9007199254740991,
          "creditsByModel": {
            "property1": 9007199254740991,
            "property2": 9007199254740991
          }
        }
      }
    },
    "animation": {
      "defaultCredits": 9007199254740991,
      "creditsByModel": {
        "property1": 9007199254740991,
        "property2": 9007199254740991
      },
      "creditsByMode": {
        "property1": {
          "defaultCredits": 9007199254740991,
          "creditsByModel": {
            "property1": 9007199254740991,
            "property2": 9007199254740991
          }
        },
        "property2": {
          "defaultCredits": 9007199254740991,
          "creditsByModel": {
            "property1": 9007199254740991,
            "property2": 9007199254740991
          }
        }
      }
    }
  }
}
{
  "defined": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "Bad Request",
  "data": null
}
{
  "defined": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "Unauthorized",
  "data": null
}
{
  "defined": true,
  "code": "PAYMENT_REQUIRED",
  "status": 402,
  "message": "Payment Required",
  "data": null
}
{
  "defined": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "Forbidden",
  "data": null
}
{
  "defined": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "Not Found",
  "data": null
}
{
  "defined": true,
  "code": "NOT_ACCEPTABLE",
  "status": 406,
  "message": "Not Acceptable",
  "data": null
}
{
  "defined": true,
  "code": "TIMEOUT",
  "status": 408,
  "message": "Request Timeout",
  "data": null
}
{
  "defined": true,
  "code": "CONFLICT",
  "status": 409,
  "message": "Conflict",
  "data": null
}
{
  "defined": true,
  "code": "PRECONDITION_FAILED",
  "status": 412,
  "message": "Precondition Failed",
  "data": null
}
{
  "defined": true,
  "code": "TOO_MANY_REQUESTS",
  "status": 429,
  "message": "Too Many Requests",
  "data": null
}
{
  "defined": true,
  "code": "INTERNAL_SERVER_ERROR",
  "status": 500,
  "message": "Internal Server Error",
  "data": null
}

Generate a Studio poster POST

Start an idempotent asynchronous poster or marketing-mockup generation, optionally using an owned successful logo generation as its reference. Reuse idempotencyKey on retry and poll getStudioGeneration for completion.

Get a Studio generation GET

Get an owner-scoped Studio generation and its current status. Poll using pollAfterSeconds while the status is PENDING or PROCESSING.