FrameMe
  1. Prompts
FrameMe
  • Default module
    • Devices
      • Get Init Device
      • Init remote device
    • Prompts
    • Schemas
      • device
      • prompts
      • organization
      • user
      • member
      • event
  • FrameMe Admin API
    • Authentication
      • Better Auth GET endpoint
      • Better Auth POST endpoint
    • Invitations
      • Accept organization invitation
    • Devices
      • Validate device credentials
      • Disconnect device
      • Delete device
    • Prompts
      • Get prompts by device ID
        POST
      • Create a new prompt
        POST
    • Generation
      • Generate image with Flux AI
      • Poll for generation result
      • Demo API endpoint
    • Notifications
      • Send notification via NTFY
    • Upload
      • Upload file to S3
    • Schemas
      • Error
      • User
      • Device
      • Prompt
      • PromptInput
      • FluxGenerationRequest
      • FluxResponse
      • FluxResult
      • Organization
      • Member
      • Invitation
  • Frameme
    • Default
      • socialSignIn
      • /get-session
      • /sign-out
      • /sign-up/email
      • /sign-in/email
      • /forget-password
      • /reset-password
      • /verify-email
      • /send-verification-email
      • /change-email
      • /change-password
      • /update-user
      • /delete-user
      • /reset-password/{token}
      • /request-password-reset
      • /list-sessions
      • /revoke-session
      • /revoke-sessions
      • /revoke-other-sessions
      • /link-social
      • /list-accounts
      • /delete-user/callback
      • /unlink-account
      • /refresh-token
      • /get-access-token
      • /account-info
      • /ok
      • /error
    • Admin
      • setRole
      • getUser
      • createUser
      • updateUser
      • listUsers
      • listUserSessions
      • unbanUser
      • banUser
      • impersonateUser
      • /admin/stop-impersonating
      • revokeUserSession
      • revokeUserSessions
      • removeUser
      • setUserPassword
      • /admin/has-permission
    • Passkey
      • /passkey/generate-register-options
      • /passkey/generate-authenticate-options
      • /passkey/verify-registration
      • /passkey/verify-authentication
      • /passkey/list-user-passkeys
      • /passkey/delete-passkey
      • /passkey/update-passkey
    • Multi-session
      • /multi-session/list-device-sessions
      • /multi-session/set-active
      • /multi-session/revoke
    • Magic-link
      • /sign-in/magic-link
      • /magic-link/verify
    • Email-otp
      • /email-otp/send-verification-otp
      • /email-otp/check-verification-otp
      • /email-otp/verify-email
      • /sign-in/email-otp
      • /forget-password/email-otp
      • /email-otp/reset-password
    • Organization
      • /organization/create
      • /organization/update
      • /organization/delete
      • /organization/set-active
      • /organization/get-full-organization
      • /organization/list
      • /organization/invite-member
      • /organization/cancel-invitation
      • /organization/accept-invitation
      • /organization/get-invitation
      • /organization/reject-invitation
      • /organization/list-invitations
      • /organization/get-active-member
      • /organization/check-slug
      • /organization/remove-member
      • /organization/update-member-role
      • /organization/leave
      • /organization/list-user-invitations
      • /organization/list-members
      • /organization/get-active-member-role
      • /organization/has-permission
    • Schemas
      • User
      • Prompt
      • Session
      • Device
      • Apikey
      • Account
      • Verification
      • Event
      • Passkey
      • Organization
      • Member
      • Invitation
      • PromptTemplates
      • RouteProtection
      • DeviceInformation
  1. Prompts

Create a new prompt

POST
/api/prompts
Creates a new prompt for a device

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Prompt created successfully
Body

🟠400Bad Request
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/prompts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "prompt": {
        "title": "string",
        "prompt": "string",
        "key": "string",
        "gender": "string",
        "style": "string",
        "view": "string",
        "lighting": "string",
        "deviceId": "string",
        "active": false,
        "medium": "photo",
        "maleSubject": "string",
        "femaleSubject": "string",
        "environment": "string",
        "color": "string",
        "mood": "string",
        "composition": "string",
        "styleReferenceImageUrl": "string",
        "firstImageUrl": "string",
        "secondImageUrl": "string",
        "promptMj": "string",
        "promptMjAi": "string",
        "promptExpress": "string",
        "promptExpressAi": "string",
        "promptFlux": "string",
        "promptFluxAi": "string",
        "fluxNegativePrompt": "string",
        "useFaceSwap": true
    }
}'
Response Response Example
200 - Example 1
{
    "id": "string",
    "title": "string",
    "prompt": "string",
    "active": false,
    "key": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "style": "string",
    "view": "string",
    "lighting": "string",
    "gender": "string",
    "color": "string",
    "composition": "string",
    "environment": "string",
    "femaleSubject": "string",
    "maleSubject": "string",
    "medium": "photo",
    "mood": "string",
    "deviceId": "string",
    "fluxNegativePrompt": "",
    "promptExpress": "Prompt",
    "promptExpressAi": "Prompt",
    "promptFlux": "Prompt",
    "promptFluxAi": "Prompt",
    "promptMj": "Prompt",
    "promptMjAi": "Prompt",
    "useFaceSwap": true,
    "styleReferenceImageUrl": "string",
    "firstImageUrl": "string",
    "secondImageUrl": "string"
}
Modified at 2025-11-01 04:36:35
Previous
Get prompts by device ID
Next
Generate image with Flux AI
Built with