Sign up

API → ML → List all ML prompts
hidden

Parameters

Name

Type

Req.

  • limit

    integer
    optional

  • page_token

    string
    optional

  • sort_by

    string
    required
    Possible values
    • created_at_ascending:  Sort in increasing order of "created_at".
    • created_at_descending:  Sort in decreasing order of "created_at".

Returns

  • 200 OK

    successful operation

    Name

    Type

    Req.

    body

    object
    optional
    Object Properties

    • items

      array
      optional
      Array of

      • completed_at

        string / ISO-8601
        optional

      • created_at

        string / ISO-8601
        optional

      • error

        string
        optional

      • feedback

        string
        optional
        Possible values
        • thumbs_up:  Thumbs up.
        • thumbs_down:  Thumbs down.
        • accepted:  Accepted.
        • rejected:  Rejected.

      • id

        string / UUID
        optional

      • metadata

        object
        optional
        Object Properties

      • model_version

        string
        optional

      • output_file

        string
        optional

      • prompt

        string
        optional

      • started_at

        string / ISO-8601
        optional

      • status

        string
        optional
        Possible values
        • queued:  The async API call is queued.
        • uploaded:  The async API call was uploaded to be converted.
        • in_progress:  The async API call is in progress.
        • completed:  The async API call has completed.
        • failed:  The async API call has failed.

      • type

        string
        optional
        Possible values
        • text_to_cad:  Text to CAD.
        • text_to_kcl:  Text to KCL.
        • text_to_kcl_iteration:  Text to Kcl iteration,

      • updated_at

        string / ISO-8601
        optional

      • user_id

        string / UUID
        optional

    • next_page

      string
      optional
get
/ml-prompts
$ curl "https://api.zoo.dev/ml-prompts" \
	--header "Authorization: Bearer $TOKEN"
200 OK
Response
{
  "items": [
    {
      "completed_at": "2024-09-20T22:41:10.179Z",
      "created_at": "2024-09-20T22:41:10.179Z",
      "error": "w16xMhhZwR",
      "feedback": "rejected",
      "id": "7aa71d0d-e4a5-4268-ab52-b63c076eaf3c",
      "metadata": {
        "code": "8Ebx6JEMoaKAHiNNS2Zj9Gp",
        "original_source_code": "Qjq7YSaNSP36ZDoWf0U0co1W",
        "source_ranges": [
          {
            "prompt": "VCvF8LBdz0p9i5ZYEPIs552",
            "range": {
              "end": {
                "column": 19,
                "line": 21
              },
              "start": {
                "column": 12,
                "line": 23
              }
            }
          }
        ]
      },
      "model_version": "rUKevDmM0w",
      "output_file": "pnM5qz7FuPUlS",
      "prompt": "cILEtaqj9jLCRxYx",
      "started_at": "2024-09-20T22:41:10.179Z",
      "status": "failed",
      "type": "text_to_kcl",
      "updated_at": "2024-09-20T22:41:10.179Z",
      "user_id": "31309fae-0e67-4ed6-a2dd-109bcec80d3a"
    }
  ],
  "next_page": "8hcwMH7o"
}