logo
OpenapiStudio

Get a Studio generation

API Docs with browser client
GET
/studio/generations/{generationId}

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

Authorization

x-api-key<token>

In: header

Path Parameters

generationId*string

Studio generation ID.

Formatuuid

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/generations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "kind": "logo",
  "status": "FAILED",
  "referenceGenerationId": "59c8f501-277e-4ad3-8ebc-e341820105e9",
  "request": {
    "kind": "logo",
    "logoType": "string",
    "logoStyle": "string",
    "model": "string",
    "textTreatment": "string",
    "typography": "string"
  },
  "result": {
    "kind": "logo",
    "logoType": "string",
    "logoStyle": "string",
    "model": "string",
    "textTreatment": "string",
    "typography": "string",
    "logoColorTreatment": "string",
    "backgroundTreatment": "string"
  },
  "asset": {
    "url": "string",
    "thumbnailUrl": "string",
    "mimeType": "string"
  },
  "failure": {
    "code": "GENERATION_FAILED",
    "message": "Generation failed. Please try again."
  },
  "pollAfterSeconds": 2,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "startedAt": "2019-08-24T14:15:22Z",
  "finishedAt": "2019-08-24T14:15:22Z"
}
{
  "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
}

Get Studio credit usage GET

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

List domains with Studio generations GET

List the authenticated user's domains that have Studio generations, including sourced counts by asset kind and the latest generation timestamp.