# v1.ai_headshot_generator
## Module Functions
### AI Headshot Generator <a name="create"></a>
Create an AI headshot. Each headshot costs 50 credits.
**API Endpoint**: `POST /v1/ai-headshot-generator`
#### Parameters
| Parameter | Required | Description | Example |
| -------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `assets` | ✓ | Provide the assets for headshot photo | `V1AiHeadshotGeneratorCreateBodyAssets {image_file_path: "api-assets/id/1234.png".to_string()}` |
| `└─ image_file_path` | ✓ | The image used to generate the headshot. This image must contain one detectable face. This value is either - a direct URL to the file. The URL path must end in a supported file extension. - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls). See the [file upload guide](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) for details. | `"api-assets/id/1234.png".to_string()` |
| `name` | ✗ | Give your image a custom name for easy identification. | `"My Ai Headshot image".to_string()` |
| `style` | ✗ | | `V1AiHeadshotGeneratorCreateBodyStyle {prompt: Some("Professional studio headshot with soft lighting and a neutral background".to_string())}` |
| `└─ prompt` | ✗ | Prompt used to guide the style of your headshot. We recommend omitting the prompt unless you want to customize your headshot. You can visit [AI headshot generator](https://magichour.ai/create/ai-headshot-generator) to view an example of a good prompt used for our 'Professional' style. | `"Professional studio headshot with soft lighting and a neutral background".to_string()` |
#### Example Snippet
```rust
let client = magic_hour::Client::default()
.with_bearer_auth(&std::env::var("API_TOKEN").unwrap());
let res = client
.v1()
.ai_headshot_generator()
.create(magic_hour::resources::v1::ai_headshot_generator::CreateRequest {
assets: magic_hour::models::V1AiHeadshotGeneratorCreateBodyAssets {
image_file_path: "api-assets/id/1234.png".to_string(),
},
name: Some("My Ai Headshot image".to_string()),
..Default::default()
})
.await;
```
#### Response
##### Type
[V1AiHeadshotGeneratorCreateResponse](/src/models/v1_ai_headshot_generator_create_response.rs)
##### Example
```rust
V1AiHeadshotGeneratorCreateResponse {credits_charged: 50, frame_cost: 123, id: "cuid-example".to_string()}
```