> ## Documentation Index > Fetch the complete documentation index at: https://docs.magichour.ai/llms.txt > Use this file to discover all available pages before exploring further. # AI Headshot Generator > Create an AI headshot. Each headshot costs 50 credits. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/ai-headshot-generator openapi: 3.0.2 info: title: Magic Hour API version: beta description: > Magic Hour provides an API (beta) that can be integrated into your own application to generate videos and images using AI. Webhook documentation can be found [here](https://docs.magichour.ai/webhook-reference). If you have any questions, please reach out to us via [discord](https://discord.gg/JX5rgsZaJp). # Authentication Every request requires an API key. To get started, first generate your API key [here](https://magichour.ai/developer?tab=api-keys&utm_source=docs&utm_medium=referral&utm_campaign=api-reference). Then, add the `Authorization` header to the request. | Key | Value | |-|-| | Authorization | Bearer mhk_live_apikey | > **Warning**: any API call that renders a video will utilize credits in your account. termsOfService: https://magichour.ai/terms-of-service servers: - url: https://api.magichour.ai security: [] tags: - name: Files description: API related to uploading and reusing assets - name: Image Projects description: API related to image projects - name: Video Projects description: API related to video projects - name: Audio Projects description: API related to audio projects - name: Account description: API related to the account that owns the API key paths: /v1/ai-headshot-generator: post: tags: - Image Projects summary: AI Headshot Generator description: Create an AI headshot. Each headshot costs 50 credits. operationId: aiHeadshotGenerator.createImage parameters: [] requestBody: required: true description: Body content: application/json: schema: type: object properties: name: type: string description: Give your image a custom name for easy identification. example: My Ai Headshot image default: Ai Headshot - dateTime style: type: object properties: prompt: type: string description: >- 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. assets: type: object properties: image_file_path: type: string minLength: 1 description: > The image used to generate the headshot. This image must contain one detectable face. This value is either - a direct URL to the video file - `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. example: api-assets/id/1234.png required: - image_file_path description: Provide the assets for headshot photo required: - assets responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string example: cuid-example description: >- Unique ID of the image. Use it with the [Get image Project API](https://docs.magichour.ai/api-reference/image-projects/get-image-details) to fetch status and downloads. credits_charged: type: integer description: >- The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund. example: 50 required: - id - credits_charged description: Success '400': description: Invalid Request content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - invalid_request description: >- Machine-readable error code. - `invalid_request`: Fix request syntax or validation errors before retrying. message: type: string description: Human-readable error message. '401': description: Unauthorized content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - unauthorized description: |- Machine-readable error code. - `unauthorized`: Provide a valid API key before retrying. message: type: string description: Human-readable error message. '402': description: Payment Required content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - insufficient_credits - subscription_required - plan_upgrade_required description: >- Machine-readable error code. - `insufficient_credits`: Purchase credits before retrying. - `subscription_required`: Start a subscription before retrying. - `plan_upgrade_required`: Upgrade the subscription plan before retrying. message: type: string description: Human-readable error message. '404': description: Not Found content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - not_found description: |- Machine-readable error code. - `not_found`: Check the route or resource identifier. message: type: string description: Human-readable error message. '422': description: Unprocessable Entity content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - unprocessable_entity description: >- Machine-readable error code. - `unprocessable_entity`: Change the request values before retrying. message: type: string description: Human-readable error message. '500': description: Internal Server Error content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - internal_server_error description: >- Machine-readable error code. - `internal_server_error`: Retry later or contact support if the error continues. message: type: string description: Human-readable error message. security: - bearerAuth: [] x-codeSamples: - lang: python source: |- from magic_hour import Client from os import getenv client = Client(token=getenv("API_TOKEN")) res = client.v1.ai_headshot_generator.generate( assets={"image_file_path": "/path/to/1234.png"}, name="Ai Headshot image", wait_for_completion=True, download_outputs=True, download_directory="." ) - lang: javascript source: |- import { Client } from "magic-hour"; const client = new Client({ token: process.env["API_TOKEN"]!! }); const res = await client.v1.aiHeadshotGenerator.generate( { assets: { imageFilePath: "/path/to/1234.png" }, name: "Ai Headshot image", }, { waitForCompletion: true, downloadOutputs: true, downloadDirectory: ".", }, ); - lang: go source: "package main\n\nimport (\n\tos \"os\"\n\n\tsdk \"github.com/magichourhq/magic-hour-go/client\"\n\tnullable \"github.com/magichourhq/magic-hour-go/nullable\"\n\tai_headshot_generator \"github.com/magichourhq/magic-hour-go/resources/v1/ai_headshot_generator\"\n\ttypes \"github.com/magichourhq/magic-hour-go/types\"\n)\n\nfunc main() {\n\tclient := sdk.NewClient(\n\t\tsdk.WithBearerAuth(os.Getenv(\"API_TOKEN\")),\n\t)\n\tres, err := client.V1.AiHeadshotGenerator.Create(ai_headshot_generator.CreateRequest{\n\t\tAssets: types.V1AiHeadshotGeneratorCreateBodyAssets{\n\t\t\tImageFilePath: \"api-assets/id/1234.png\",\n\t\t},\n\t\tName: nullable.NewValue(\"My Ai Headshot image\"),\n\t})\n}" - lang: rust source: |- 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; - lang: curl source: |- curl --request POST \ --url https://api.magichour.ai/v1/ai-headshot-generator \ --header 'accept: application/json' \ --header 'authorization: Bearer ' \ --header 'content-type: application/json' \ --data ' { "name": "My Ai Headshot image", "style": { "prompt": "string" }, "assets": { "image_file_path": "api-assets/id/1234.png" } } ' - lang: php source: |- "https://api.magichour.ai/v1/ai-headshot-generator", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => json_encode([ 'name' => 'My Ai Headshot image', 'style' => [ 'prompt' => 'string' ], 'assets' => [ 'image_file_path' => 'api-assets/id/1234.png' ] ]), CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: Bearer ", "content-type: application/json" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: java source: >- HttpResponse response = Unirest.post("https://api.magichour.ai/v1/ai-headshot-generator") .header("accept", "application/json") .header("content-type", "application/json") .header("authorization", "Bearer ") .body("{\"name\":\"My Ai Headshot image\",\"style\":{\"prompt\":\"string\"},\"assets\":{\"image_file_path\":\"api-assets/id/1234.png\"}}") .asString(); components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Bearer authentication header of the form `Bearer `, where `` is your API key. To get your API key, go to [Developer Hub](https://magichour.ai/developer?tab=api-keys&utm_source=docs&utm_medium=referral&utm_campaign=api-reference) and click "Create new API Key". ````