AI

Render AI job visualization

Changed on

Render the visualization from a completed AI job as a PNG image. The endpoint extracts the visualization configuration from the job result, loads Arrow IPC data, and renders it server-side using Vega. For style-only follow-ups (e.g., "make it a bar chart"), the endpoint walks back through previous jobs in the conversation to find the original query data.

get/api/v1/ai/jobs/{jobId}/vis

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/ai/jobs/{jobId}/vis
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The unique identifier of the AI job

Example:123e4567-e89b-12d3-a456-426614174000

Query parameters

auto_visstring

The literal string false disables automatic chart selection and returns 204 if the job has no visualization. All other strings, including empty strings and 0, enable automatic selection. Defaults to true.

debugstring

Returns debug JSON instead of the rendered PNG when enabled. The strings false, 0, and the empty string disable debug; other nonempty strings, including true and 1, enable it. Defaults to false.

Response

Visualization rendered as image/png, or application/json when debug is enabled. Debug JSON contains the compiled visualization and query details, or diagnostic information when Arrow data is unavailable.

OR

Changes

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 to the /// response property oneOf list for the response status

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 to the /// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 from the /// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 from the /// response property oneOf list for the response status

    • info

      added the new optional query request parameter auto_vis

    • info

      added the new optional query request parameter debug

    • info

      added the media type application/json for the response with the status

    • info

      added the success response with the status