Overview
/
Developer Tools
/
API Reference
/
Orgs
/
Register a new org dataset.

Register a new org dataset

HTTP Request

  • application/json

    //
    • description:

      string,
      //
    • name:

      string,
      //
    • require_raw_kcl_similarity_score_for_success:

      boolean,
      //
    • :

      {{ ... }
      //
      • access_role_arn:

        string,
        //
      • uri:

        string,
        //
      • provider:

        "s3"+1
        • //Amazon Simple Storage Service.
          "s3"
        • //Zoo-managed dataset storage backed by the API's internal object store.
          "zoo_managed"
        //
      }
    }

Response

  • 201 Created
    • //
      • access_role_arn:

        string,
        //
      • created_at:

        stringISO-8601,
        //
      • description:

        string,
        //
      • id:

        stringUUID,
        //
      • last_sync_error:

        string,
        //
      • last_sync_error_at:

        stringISO-8601,
        //
      • name:

        string,
        //
      • org_id:

        stringUUID,
        //
      • require_raw_kcl_similarity_score_for_success:

        boolean,
        //
      • source_uri:

        string,
        //
      • updated_at:

        stringISO-8601,
        //
      • status:

        "active"+2
        • //Dataset is active and can be used.
          "active"
        • //Dataset is being deleted and should not be mutated or used.
          "deleting"
        • //Dataset encountered sync errors and needs attention.
          "errored"
        ,
        //
      • storage_provider:

        "s3"+1
        • //Amazon Simple Storage Service.
          "s3"
        • //Zoo-managed dataset storage backed by the API's internal object store.
          "zoo_managed"
        //
      }

Examples

post
/org/datasets
201 Created
Response