general

Get a figure

Fetch a figure by figure_id: returns the image URL when it is ready, or tells you it is still rendering.

Discipline pack: general. Cost: Free.

post/api/v1/get_figure

Request

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

Request body

figure_idstring uuid required

The figure_id returned by create_figure or edit_figure.

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.