# PiktID Docs - [Anonymize](/docs/v1/anonymize): Remove face identities and replace them with AI generated ones - [Authentication](/docs/v1/auth): Authenticate your requests to PiktID APIs - [Change expression](/docs/v1/change-expression): Change facial expressions with our advanced AI model - [Create image](/docs/v1/create-image): Generate images from a prompt - [Edit background](/docs/v1/edit-background): Change a photo's background and lighting - [Magic expand](/docs/v1/expand): Augment images by generating outside borders - [Generate person](/docs/v1/generate-person): Transform people with our advanced AI model - [Introduction](/docs/v1): General information about the APIs - [Swap](/docs/v1/swap): Remove face identities and replace them with user-supplied ones - [Upscale](/docs/v1/upscale): Increase image resolution without compromising facial features - [Authentication](/docs/v2/auth): Authenticate your requests to the APIs - [Create an identity](/docs/v2/create-identity): Generate a new identity from a brief or a reference image and promote it into your library - [Create packshot](/docs/v2/create-packshot): Generate clean product packshots from raw garment photos - [Detail repair](/docs/v2/detail-repair): Regenerate a masked logo, text, or small detail and blend only that region back - [Flat lay on model](/docs/v2/flat-lay): Virtual try-on from flat lay images with a custom model - [Garment recolor](/docs/v2/garment-recolor): Recolor one garment consistently across a set of product images - [Image playground](/docs/v2/image-playground): Generate or edit a single image from a prompt, existing images, or a saved identity - [Introduction](/docs/v2): General information about the APIs - [Model swap](/docs/v2/model-swap): Replace model identities in multiple PDPs at once - [Coordinates and bounding boxes](/docs/v1/concepts/coordinates): Common concepts and functionality shared between services - [Image ID](/docs/v1/concepts/image-id): Common concepts and functionality shared between services - [Ask questions](/docs/v1/tag/ask-questions): Ask our model a question about your images - [Describe an image](/docs/v1/tag/describe-image): Extract useful descriptions and visual aspects of your image - [Ask for new generated faces (deprecated)](/docs/v1/ask_generate_faces/post): - [Assets](/docs/v2/concepts/assets): Manage the uploaded images you reuse across jobs - [Credits](/docs/v2/concepts/credits): Understand cost calculation, pre-checks, and billing ownership - [Errors](/docs/v2/concepts/errors): Error response formats, validation details, and reference codes - [Groups](/docs/v2/concepts/groups): Collaborate with your team through shared resources and billing - [Identities](/docs/v2/concepts/identities): Upload, generate, preprocess, and reuse model identities across jobs - [Jobs](/docs/v2/concepts/jobs): Understand job states, progress tracking, and per-image outputs - [Notifications](/docs/v2/concepts/notifications): Track progress via polling, SSE streams, and webhook fan-out - [Presets](/docs/v2/concepts/presets): Save and reuse instruction sets across jobs - [Projects](/docs/v2/concepts/projects): Organize uploads and jobs into reusable workspaces - [Rate limits](/docs/v2/concepts/rate-limits): API throttling, 429 behavior, and best practices for retries - [Webhooks](/docs/v2/concepts/webhooks): Receive notification events as signed HTTP callbacks - [Ask for new generated skin - full body](/docs/v1/ask_generate_skin_full_body/post): - [Ask for new expression](/docs/v1/ask_new_expression/post): - [Ask for new random face](/docs/v1/ask_random_face/post): - [Billing user data](/docs/v1/billing/post): - [Contact us](/docs/v1/contactus/post): - [Get generated faces](/docs/v1/generated_faces/post): - [Get identities (deprecated)](/docs/v1/get_identities/post): - [Get face mask](/docs/v1/get_mask/post): - [Get face mask all sections](/docs/v1/get_mask_all/post): - [Image annotations - Get caption (deprecated)](/docs/v1/getcaption/post): - [Image annotations - Get image description (deprecated)](/docs/v1/getimagedescription/post): - [Get aligned face](/docs/v1/get_aligned_face/post): - [Image annotations - Get tags](/docs/v1/gettags/post): - [health check](/docs/v1/health/get): - [health check](/docs/v1/health/post): - [Download history of generated images by image ID.](/docs/v1/history/post): - [Get my images - list info about your images (deprecated)](/docs/v1/images/post): - [Get image info by id - list info about your image (deprecated)](/docs/v1/images_by_id/post): - [Get user data](/docs/v1/me/get): - [Get notifications by name (deprecated)](/docs/v1/notification_by_name/post): - [Get notifications by name - json](/docs/v1/notification_by_name_json/post): - [Paste a flag](/docs/v1/pasteflag/post): - [Pick face - substitutes generated face in input image (deprecated)](/docs/v1/pick_face/post): - [Pick face 2 - substitutes generated face in input image](/docs/v1/pick_face2/post): - [Remove image](/docs/v1/remove/post): - [Remove identity - remove stored identity (deprecated)](/docs/v1/remove_identity/post): - [Retrieve superid project: uploaded image and info](/docs/v1/retrieve_superid_project/post): - [Select faces to process (for images with more than 1 face)](/docs/v1/selection/post): - [Store a generated identity from EraseID to use as a reference for creating consistent identities.](/docs/v1/set_identity/post): - [Set face mask](/docs/v1/set_mask/post): - [Set mask based on keywords](/docs/v1/set_mask_by_keyword/post): - [Get SuperID generated images (deprecated)](/docs/v1/superid/get): - [Upscaler - SuperID (deprecated)](/docs/v1/superid/post): - [Upscaler - SuperID fast](/docs/v1/superid_fast/post): - [Get SuperID generated images (deprecated)](/docs/v1/superid_images/post): - [Get SuperID Info](/docs/v1/superid_info/get): - [Get SuperID Info](/docs/v1/superid_info/post): - [Revoke an access token](/docs/v1/tokens/delete): - [Create new access and refresh tokens](/docs/v1/tokens/post): - [Refresh an access token](/docs/v1/tokens/put): - [List active access and refresh tokens](/docs/v1/tokens_list/post): - [Upload an image and process faces - eraseid (form version)](/docs/v1/upload/post): - [Upload an image for SuperID (deprecated)](/docs/v1/upload_extra/post): - [Upload identity used as reference for consistent identity generation (deprecated)](/docs/v1/upload_identity/post): - [Upload an image and process faces - eraseid (pro version)](/docs/v1/upload_pro/post): - [Ask for upscaled image (deprecated)](/docs/v1/upscaler/post): - [Image annotations - Get question](/docs/v1/getquestion/post): - [Delete a single asset by ID](/docs/v2/assets/delete_asset__delete): - [Bulk delete assets](/docs/v2/assets/delete_assets_bulk__post): - [Get a single asset by ID](/docs/v2/assets/get_single_asset__get): - [Get paginated list of image assets](/docs/v2/assets/list_assets__get): - [Update asset styling note](/docs/v2/assets/update_asset_note__patch): - [Update asset tags](/docs/v2/assets/update_asset_tags__patch): - [Upload an image](/docs/v2/assets/upload__post): - [Bulk upload](/docs/v2/assets/upload_bulk__post): - [Generate an API token](/docs/v2/authentication/generate_new_token__post): - [Get current user information](/docs/v2/authentication/get_current_user__get): - [List API tokens](/docs/v2/authentication/list_tokens__get): - [Revoke an API token](/docs/v2/authentication/revoke_token__delete): - [Get credit usage summary](/docs/v2/billing/get_billing_credits__get): - [Get group usage breakdown by member](/docs/v2/billing/get_group_usage__get): - [List available billing destinations](/docs/v2/billing/list_billing_destinations__get): - [Set billing destination](/docs/v2/billing/set_billing_destination__put): - [Start a new job](/docs/v2/create-packshot/create_packshot_job__post): - [Start a new job](/docs/v2/detail-repair/create_detail_repair_job__post): - [Bulk download job results](/docs/v2/download/create_bulk_download_url__post): - [Download job results](/docs/v2/download/create_job_download_url__post): - [Start a new job](/docs/v2/flat-lay-to-model/create_flat_2_model_job__post): - [Gallery of images grouped by job](/docs/v2/gallery/get_gallery_by_job__get): - [Gallery of images grouped by project](/docs/v2/gallery/get_gallery_by_project__get): - [Start a new job](/docs/v2/garment-recolor/create_garment_recolor_job__post): - [Create a new group](/docs/v2/groups/create_group__post): - [Delete group](/docs/v2/groups/delete_group__delete): - [Invite user to group](/docs/v2/groups/invite_user__post): - [Join group](/docs/v2/groups/join_group__post): - [List group members](/docs/v2/groups/list_members__get): - [List all members of all joined groups](/docs/v2/groups/list_my_group_members__get): - [List my groups](/docs/v2/groups/list_my_groups__get): - [Remove member from group / Leave group](/docs/v2/groups/remove_member__delete): - [Update member role](/docs/v2/groups/update_member_role__patch): - [Generate identity drafts](/docs/v2/identities/create_identity__post): - [Delete an identity](/docs/v2/identities/delete_identity__delete): - [Get identity data](/docs/v2/identities/get_identity__get): - [Get the preprocessed images](/docs/v2/identities/get_identity_results__get): - [Get preprocessing status](/docs/v2/identities/get_identity_status__get): - [List identities](/docs/v2/identities/list_identities__get): - [Promote a generated draft to a full identity](/docs/v2/identities/promote_generated__post): - [Share an identity with a group](/docs/v2/identities/share_identity__post): - [Unshare an identity from a group](/docs/v2/identities/unshare_identity__delete): - [Update identity metadata](/docs/v2/identities/update_identity_metadata__patch): - [Upload an identity](/docs/v2/identities/upload_identity__post): - [Upload a corrected POV](/docs/v2/identities/upload_identity_pov__post): - [Generate or edit an image](/docs/v2/image-playground/create_edit_chat_job__post): - [Abort a running job](/docs/v2/jobs/abort_job__post): - [Delete a job and its results](/docs/v2/jobs/delete_job__delete): - [Get all versions of an image](/docs/v2/jobs/get_image_versions__get): - [Get job results](/docs/v2/jobs/get_job_results__get): - [Get job status](/docs/v2/jobs/get_job_status__get): - [List jobs](/docs/v2/jobs/list_jobs__get): - [Regenerate a single image](/docs/v2/jobs/regenerate_image__post): - [Retry a job](/docs/v2/jobs/retry_job__get): - [Start a new job](/docs/v2/model-swap/create_model_swap_job__post): - [Assign a preset to a category](/docs/v2/preset-categories/assign_preset_to_category__post): - [Create preset category](/docs/v2/preset-categories/create_category__post): - [Delete a preset category](/docs/v2/preset-categories/delete_category__delete): - [Duplicate a preset category (deep copy)](/docs/v2/preset-categories/duplicate_category__post): - [Extract a category of consistent presets from a set of reference images](/docs/v2/preset-categories/extract_category_from_images__post): - [Get a preset category with its presets](/docs/v2/preset-categories/get_category__get): - [List preset categories](/docs/v2/preset-categories/list_categories__get): - [Share a category with a group](/docs/v2/preset-categories/share_category__post): - [Unassign a preset from a category](/docs/v2/preset-categories/unassign_preset_from_category__delete): - [Unshare a category from a group](/docs/v2/preset-categories/unshare_category__delete): - [Update a preset category](/docs/v2/preset-categories/update_category__patch): - [Create a preset](/docs/v2/presets/create_preset__post): - [Delete a preset](/docs/v2/presets/delete_preset__delete): - [Bulk delete presets](/docs/v2/presets/delete_presets_bulk__post): - [Extract preset from image](/docs/v2/presets/extract_preset_from_image__post): - [Extract preset from text description](/docs/v2/presets/extract_preset_from_text__post): - [Get preset data](/docs/v2/presets/get_preset__get): - [List presets](/docs/v2/presets/list_presets__get): - [Share a preset with a group](/docs/v2/presets/share_preset__post): - [Unshare a preset from a group](/docs/v2/presets/unshare_preset__delete): - [Update a preset](/docs/v2/presets/update_preset__patch): - [Create a new project](/docs/v2/projects/create_project__post): - [Delete a project](/docs/v2/projects/delete_project__delete): - [Get project details](/docs/v2/projects/get_project__get): - [List projects](/docs/v2/projects/list_projects__get): - [Upload an image](/docs/v2/upload/upload__post): - [Bulk upload](/docs/v2/upload/upload_bulk__post): - [Delete webhook](/docs/v2/webhooks/delete_webhook__delete): - [Get webhook](/docs/v2/webhooks/get_webhook__get): - [Test webhook](/docs/v2/webhooks/test_webhook__post): - [Create or update webhook](/docs/v2/webhooks/upsert_webhook__put): - [Get job notifications](/docs/v2/notifications/notifications__post): - [Delete a notification](/docs/v2/notifications/notifications_delete__delete): - [Stream notifications](/docs/v2/notifications/notifications_stream__get): - [Billing overview](/docs/v1/billing/overview/post): - [Gallery target images](/docs/v1/consistent_identities/gallery/post): - [Gallery uploaded faces](/docs/v1/consistent_identities/gallery_faces/post): - [Step 3) New swap](/docs/v1/consistent_identities/generate/post): - [Remove faces - remove stored identity](/docs/v1/consistent_identities/remove_faces/post): - [Step 2) Upload a face/identity](/docs/v1/consistent_identities/upload_face/post): - [Step 1) Uploading a target image](/docs/v1/consistent_identities/upload_target/post): - [Create image - New Image](/docs/v1/create/new/post): - [Edit image - Background](/docs/v1/edit/background/post): - [Edit image - Fill](/docs/v1/edit/fill/post): - [Edit image - Generate variation](/docs/v1/edit/generate/post): - [Edit image - Upload reference image](/docs/v1/edit/reference/post): - [Edit image - Swap](/docs/v1/edit/swap/post): - [Edit image - Upload target image](/docs/v1/edit/target/post): - [Expand - Generate variation](/docs/v1/expand/generate/post): - [Expand image - Upload target image](/docs/v1/expand/target/post): - [Image annotations - Get caption](/docs/v1/getcaption/v2/post): - [Get my images - list info about your images](/docs/v1/images/v2/post): - [Get image info by id - list info about your image](/docs/v1/images_by_id/v2/post): - [Delete a notification - json](/docs/v1/notification/delete_json/delete): - [Delete a notification](/docs/v1/notification/id/delete): - [Reset the output image to the original](/docs/v1/pick/full_reset/post): - [Get SuperID history](/docs/v1/superid/history/post): - [Upload an image for SuperID](/docs/v1/superid/upload/post): - [Upscaler - SuperID](/docs/v1/superid/v2/post): - [Consistent identity - Upload all and swap (deprecated)](/docs/v1/swap/all/post): - [Consistent identity - Upload face image to swap (deprecated)](/docs/v1/swap/face/post): - [Consistent identity - Generate swap (deprecated)](/docs/v1/swap/generate/post): - [Get notifications by name (deprecated)](/docs/v1/swap/notification_by_name/post): - [Consistent identity - Upload target image (deprecated)](/docs/v1/swap/target/post): - [Upload an image and process - v2](/docs/v1/upload/v2/post): - [Copy an identity in a shared folder](/docs/v1/consistent_identities/gallery_faces/copy_identity_in_shared_folder/post): - [Gallery uploaded faces - list files](/docs/v1/consistent_identities/gallery_faces/list_files/post): - [List shared folders](/docs/v1/consistent_identities/gallery_faces/list_shared_folders/post): - [List only the immediate subfolders within a specific S3 folder path.](/docs/v1/consistent_identities/gallery_faces/list_folders/post): - [Move an identity in a different folder](/docs/v1/consistent_identities/gallery_faces/move_identity/post): - [Gallery uploaded faces - v2](/docs/v1/consistent_identities/gallery_faces/v2/post): - [Swap generate v2 - one face head swap](/docs/v1/consistent_identities/generate/v2/post): - [Step 5) Delete a notification (optional)](/docs/v1/consistent_identities/notification/delete/delete): - [Delete a notification (deprecated)](/docs/v1/swap/notification/delete/delete): - [Step 4) Get notifications](/docs/v1/consistent_identities/notification/read/post):