lossless-group_image-gin/reference/model-recraft-response.md
mpstaton 0a33233236 inspect(api-response): add scripts to inspect API response
On branch feature/settings
 Changes to be committed:
	modified:   .gitignore
	new file:   reference/model-recraft-response.md
	new file:   scripts/test-api.js
	modified:   scripts/test-recraft-api.ts
	modified:   src/settings/settings.ts
2025-07-20 20:42:04 +03:00

1.7 KiB

Recraft API Response Model

Successful Response (200 OK)

Headers

{
  "date": "Sun, 20 Jul 2025 17:32:02 GMT",
  "content-type": "application/json",
  "content-length": "262",
  "connection": "keep-alive",
  "vary": "Origin",
  "x-recraft-requestid": "7d9c1a22-e28e-42d6-89b8-6bf6e9592851",
  "strict-transport-security": "max-age=31536000; includeSubDomains"
}

Body

{
  // Unix timestamp of when the image was generated
  "created": number;
  
  // Number of credits used for this generation
  "credits": number;
  
  // Array of generated images
  "data": Array<{
    // Unique identifier for the generated image
    "image_id": string;
    
    // URL to access the generated image
    "url": string;
    
    // Optional: Base64 encoded image data (if requested)
    "b64_json"?: string;
  }>;
}

Example

{
  "created": 1753032722,
  "credits": 40,
  "data": [
    {
      "image_id": "eb846eea-f993-4d52-9a01-0874eca231a1",
      "url": "https://img.recraft.ai/qd4W5wCM8prMcqeIGKaoPmM4iBrjo53m3PIr6-8z-h4/rs:fit:1024:1024:0/raw:1/plain/abs://external/images/eb846eea-f993-4d52-9a01-0874eca231a1"
    }
  ]
}

Error Response (4xx/5xx)

Headers

{
  "content-type": "application/json",
  "x-recraft-requestid": "7d9c1a22-e28e-42d6-89b8-6bf6e9592851"
}

Body

{
  // Error type
  "error": {
    // HTTP status code
    "code": number;
    
    // Human-readable error message
    "message": string;
    
    // Optional: Additional error details
    "details"?: Record<string, unknown>;
  }
}

Example

{
  "error": {
    "code": 400,
    "message": "Invalid request parameters",
    "details": {
      "prompt": "This field is required"
    }
  }
}