POST
/
workshops
/
{WorkShop_id}
/
prompt
/
run
curl --request POST \
  --url https://api.lume.ai/workshops/{WorkShop_id}/prompt/run \
  --header 'Content-Type: application/json' \
  --header 'lume-api-key: <api-key>' \
  --data '{
  "target_fields_to_prompt": {},
  "auto_deploy": true,
  "immediate_return": true
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workshop_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "created",
  "spec": {},
  "updated_at": "2023-11-07T05:31:56Z"
}

Runs an edit in the workshop by providing an AI prompt.

See step 2 in the Edit Mapper Guide to learn more.

Authorizations

lume-api-key
string
headerrequired

Path Parameters

WorkShop_id
string
required

Body

application/json
target_fields_to_prompt
object
required
auto_deploy
boolean | null
immediate_return
boolean | null

Response

200 - application/json
id
string
required

The unique identifier of this object

created_at
string
required

The date and time this object was created

job_id
string | null
required

The id of the job the result is associated with

workshop_id
string | null
required

The id of the workshop the result is associated with

pipeline_id
string
required

The id of the pipeline the result is associated with

status
enum<string>
required

The status of the mapping task

Available options:
created,
running,
finished,
failed,
needs review
spec
object | null

The spec of the data to be transformed

updated_at
string | null
required

The date and time this object was last updated