Skip to main content
POST
/
projects
/
{slug}
/
slides
/
{slideId}
/
editing
Start slide editing
curl --request POST \
  --url https://faces.app/api/v1/projects/{slug}/slides/{slideId}/editing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentName": "<string>",
  "editPrompt": "<string>"
}
'
{
  "success": true
}

Authorizations

Authorization
string
header
required

API key with "faces_" prefix. Create one at Settings > Developers.

Path Parameters

slug
string
required
slideId
string
required

Body

application/json
agentName
string

Name of the agent editing (shown in UI). Defaults to "AI Agent".

editPrompt
string

Brief description of the edit (shown in the editor).

Response

Editing session started

success
boolean
required