# Grok Imagine Image Edit - Core.Today AI API

> Dedicated edit endpoint for xAI's Grok Imagine image model. Pass a source image URL and a prompt describing the change - the fastest, lowest-cost editing tier in the family.

- **Provider**: xAI
- **Model ID**: xai/grok-imagine-image/edit
- **Category**: Image Generation
- **Credits**: 51 per image
- **Speed**: Fast
- **Quality**: Standard

## Features
- Prompt-based editing of an existing image
- Up to 10 edited variants per request (billed per image)
- Aspect ratio control for the output
- 1k / 2k output resolution tiers at the same price

## Use Cases
- Quick object, color, and lighting changes on existing photos
- Bulk variant generation from one source image
- Low-cost iteration before switching to the 2.0/Quality edit tiers

## API Endpoint

Base URL: https://api.core.today/v1
Create Prediction: POST /predictions
Get Status: GET /predictions/{job_id}

## Authentication
Header: X-API-Key: YOUR_API_KEY

## Input Parameters

### Required
- **prompt**: string - Text prompt describing the edit.
- **image**: string - Source image URL to edit. Supports jpg, jpeg, png (max 20MiB).

### Optional
- **n**: integer (default: 1) - Number of edited variants to generate (1-10). Billed per image.
- **aspect_ratio**: string (default: auto) - Aspect ratio of the output image.
  Options: auto, 1:1, 16:9, 9:16, 4:3, 3:4, 3:2, 2:3, 2:1, 1:2, 19.5:9, 9:19.5, 20:9, 9:20
- **resolution**: string - Output resolution tier. Same price for both.
  Options: 1k, 2k

## Examples

### Color Edit
Change an object's color while keeping the scene
```json
{
  "model": "xai/grok-imagine-image/edit",
  "input": {
    "prompt": "Make the apple green and add soft morning light",
    "image": "https://example.com/apple.jpg"
  }
}
```

## Response Format
```json
{
  "job_id": "abc123",
  "status": "pending | processing | completed | failed",
  "result": "URL or data (when completed)"
}
```

## Usage Flow
1. POST /predictions with model and input -> receive job_id
2. GET /predictions/{job_id} -> poll until status is completed or failed
3. Result contains output URL(s)

## Tips
- Describe only the change you want - the rest of the image is preserved
- For pure text-to-image generation, use xai/grok-imagine-image instead
- auto aspect ratio follows the source image