general

Edit a scientific figure

Change a figure made with create_figure using a plain-language instruction (e.g. "make the arrows thicker", "rename the label X to Y"). Returns a new image; the original is kept.

Discipline pack: general. Cost: 100 credits per finished figure (paid accounts only).

post/api/v1/edit_figure

Request

  • Base URL: https://scholarmuse.ai
  • URL: https://scholarmuse.ai/api/v1/edit_figure
  • Auth: HTTP bearer

Request body

figure_idstring uuid required

The figure_id returned by create_figure, edit_figure or get_figure.

instructionstring required

What to change. One or two changes per call work best.

Response

The tool result.

summarystring required
partialboolean
extraobject
credits_usednumber required
call_idstring required

Example response

{
  "billing": {
    "lowBalanceThreshold": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.