Studio API

The Studio API provides programmatic access to Girard's generation capabilities. Create images, videos, and music through simple REST API calls.

Base URL

https://www.girardai.com/api/studio

Authentication

All requests require authentication via Bearer token:

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Image Generation

Generate Image

Create an image from a text prompt.

Endpoint: POST /api/studio/generate

Request Body:

Available Models:

Aspect Ratios:

Example Request:

curl -X POST https://www.girardai.com/api/studio/generate \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A serene mountain landscape at golden hour, photorealistic",
    "negativePrompt": "blurry, low quality",
    "model": "flux-pro-1.1",
    "aspectRatio": "16:9",
    "quality": "high"
  }'

Response:

{
  "success": true,
  "data": {
    "id": "gen_abc123xyz",
    "url": "https://storage.girardai.com/generations/abc123.png",
    "prompt": "A serene mountain landscape at golden hour, photorealistic",
    "model": "flux-pro-1.1",
    "aspectRatio": "16:9",
    "width": 1920,
    "height": 1080,
    "seed": 42857361,
    "creditsUsed": 2,
    "createdAt": "2025-01-15T10:30:00Z"
  }
}

Enhance Prompt

Improve a prompt using AI.

Endpoint: POST /api/studio/enhance-prompt

Request Body:

Example Request:

curl -X POST https://www.girardai.com/api/studio/enhance-prompt \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "a cat on a chair",
    "style": "photorealistic"
  }'

Response:

{
  "success": true,
  "data": {
    "original": "a cat on a chair",
    "enhanced": "A fluffy orange tabby cat sitting gracefully on an antique wooden chair, soft natural lighting streaming through a nearby window, shallow depth of field, professional pet photography, warm and cozy atmosphere, highly detailed fur texture, 8k resolution"
  }
}

Upscale Image

Increase image resolution.

Endpoint: POST /api/studio/upscale

Request Body:

Example Request:

curl -X POST https://www.girardai.com/api/studio/upscale \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "imageUrl": "https://storage.girardai.com/generations/abc123.png",
    "scale": 4
  }'

Response:

{
  "success": true,
  "data": {
    "id": "upscale_xyz789",
    "url": "https://storage.girardai.com/upscaled/xyz789.png",
    "originalWidth": 512,
    "originalHeight": 512,
    "newWidth": 2048,
    "newHeight": 2048,
    "scale": 4,
    "creditsUsed": 2
  }
}

Remove Background

Remove the background from an image.

Endpoint: POST /api/studio/remove-bg

Request Body:

Example Request:

curl -X POST https://www.girardai.com/api/studio/remove-bg \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "imageUrl": "https://storage.girardai.com/generations/abc123.png"
  }'

Response:

{
  "success": true,
  "data": {
    "id": "rmbg_def456",
    "url": "https://storage.girardai.com/processed/def456.png",
    "format": "png",
    "hasTransparency": true,
    "creditsUsed": 1
  }
}

Video Generation

Generate Video

Create a video from text or image.

Endpoint: POST /api/studio/generate-video

Request Body:

Available Models:

Example Request:

curl -X POST https://www.girardai.com/api/studio/generate-video \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A timelapse of clouds moving over a mountain peak",
    "model": "runway-gen3",
    "duration": 5,
    "aspectRatio": "16:9"
  }'

Response:

{
  "success": true,
  "data": {
    "id": "video_abc123",
    "status": "processing",
    "estimatedTime": 120
  }
}

Check Video Status

Poll for video generation completion.

Endpoint: GET /api/studio/generate-video?id={videoId}

Response (Processing):

{
  "success": true,
  "data": {
    "id": "video_abc123",
    "status": "processing",
    "progress": 45
  }
}

Response (Completed):

{
  "success": true,
  "data": {
    "id": "video_abc123",
    "status": "completed",
    "url": "https://storage.girardai.com/videos/abc123.mp4",
    "duration": 5,
    "width": 1920,
    "height": 1080,
    "creditsUsed": 25
  }
}

Music Generation

Generate Music

Create original music from a text description.

Endpoint: POST /api/studio/generate-music

Request Body:

Available Models:

Example Request:

curl -X POST https://www.girardai.com/api/studio/generate-music \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Upbeat electronic dance music with driving beats, 128 BPM",
    "model": "stable-audio",
    "duration": 30
  }'

Response:

{
  "success": true,
  "data": {
    "id": "music_xyz789",
    "url": "https://storage.girardai.com/music/xyz789.mp3",
    "duration": 30,
    "format": "mp3",
    "creditsUsed": 9
  }
}

Generation History

Get History

Retrieve generation history.

Endpoint: GET /api/studio/history

Query Parameters:

Example Request:

curl -X GET "https://www.girardai.com/api/studio/history?type=image&limit=10" \
  -H "Authorization: Bearer sk_live_xxx"

Response:

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "gen_abc123",
        "type": "image",
        "url": "https://storage.girardai.com/generations/abc123.png",
        "prompt": "A mountain landscape",
        "model": "flux-pro-1.1",
        "createdAt": "2025-01-15T10:30:00Z"
      }
    ],
    "total": 150,
    "limit": 10,
    "offset": 0
  }
}

Error Responses

Standard Error Format

{
  "success": false,
  "error": {
    "code": "error_code",
    "message": "Human readable message",
    "details": {}
  }
}

Error Codes

Example Error

{
  "success": false,
  "error": {
    "code": "insufficient_credits",
    "message": "Not enough credits to complete this generation",
    "details": {
      "required": 5,
      "available": 2
    }
  }
}

Credit Usage

Previous: Authentication | Next: Chat API