This endpoint requires authentication by an org admin. It gets the authenticated user's org.

Access-Control-Allow-Headers header. This is a comma-separated list of headers.

The Content-Location header for responses that are not the final destination. This is used to indicate where the resource can be found, when it is finished.

The location header for redirects and letting users know if there is a websocket they can listen to for status updates on their operation.

ID for this request. We return it so that users can report this to us and help us debug their problems.

Get an org.

This endpoint requires authentication by an org admin. It updates the authenticated user's org.

The user-modifiable parts of an organization.

Update an org.

This endpoint requires authentication by a Zoo user that is not already in an org. It creates a new org for the authenticated user and makes them an admin.

Create an org.

In order to delete an org, you must first delete all of its members, except yourself.

You must also have no outstanding invoices or unpaid balances.

This endpoint requires authentication by an org admin. It deletes the authenticated user's org.

Delete an org.

Dataset URI used to scope generated IAM policies.

IAM role ARN customers expect Zoo to assume when reading the dataset.

role_arn

Aggregated AWS policies required for onboarding an org dataset stored in S3.

Return the IAM policies customers should apply when onboarding an S3 dataset.

Maximum number of items returned by a single call

limit

Token returned by previous call to retrieve the subsequent page

page_token

sort_by

Supported set of sort modes for scanning by created_at only.

Currently, we only support scanning in ascending order.

Sort in increasing order of "created_at".

Sort in decreasing order of "created_at".

List every dataset that belongs to the caller's organization.

If the dataset lives in S3, call `/org/dataset/s3/policies` first so you can generate the trust, permission, and bucket policies scoped to your dataset before invoking this endpoint.

Dataset owned by an organization, reusable across multiple features.

Register a new org dataset.

Fetch a single dataset by id so long as it belongs to the authenticated org.

Fetch a single dataset by ID so long as it belongs to the authenticated org.

IMPORTANT: Use this endpoint to fix connectivity to the same underlying storage location (e.g. rotating credentials or correcting a typo). Do not repoint an existing dataset at a completely different bucket or provider—create a new dataset instead so conversions in flight keep their original source. This warning applies to every storage backend, not just S3.

Update dataset metadata or storage credentials for the caller's organization.

This is a destructive operation that: - requires org admin authentication and the dataset must belong to the caller's org. - fails with a 409 Conflict if the dataset is still attached to any custom model. - deletes Zoo-managed artifacts for this dataset (converted outputs and embeddings). - does **not** delete or modify the customer's source bucket/prefix.

All internal artifact deletions are strict; if any cleanup fails, the request fails.

Delete a dataset owned by the caller's organization.

Bulk-download KCL outputs for successful dataset conversions.

This endpoint returns lightweight conversion summaries only (including `phase`), and intentionally omits converted KCL output and snapshot image payloads for speed. Use the optional `filter` query parameter to filter results (example: `?filter=status:success`).

Supported sort modes for org dataset conversions.

Optional filter string for conversions (example: `status:success`).

filter

List the file conversions that have been processed for a given dataset owned by the caller's org.

Unlike list/search endpoints, this returns the full conversion payload: latest output text plus decoded snapshot image payloads for original, raw-KCL, and salon-KCL stages.

conversion_id

Detailed response that bundles conversion metadata with converted file and snapshot contents.

Fetch the metadata and converted output for a single dataset conversion.

Download the original source file for a specific dataset conversion.

Retrigger a specific dataset conversion for the caller's org.

Optional comma-separated set of conversion statuses to retrigger.

Example: `statuses=success,in_progress` If omitted, we retrigger all non-success conversions, but only retrigger `in_progress` conversions that have been running for more than 5 minutes.

statuses

Request a retrigger of conversions for a dataset that belongs to the caller's org.

Supports exact conversion-ID matching and fuzzy file-path matching.

Search text matched against conversion id or file path.

Requested sort mode for matched conversions.

Search dataset conversions by conversion ID or file path.

This embeds the query text with the org-dataset embedding model and returns top chunk matches ranked by cosine similarity.

Natural-language query text to embed and search.

Max number of matching chunks to return.

Defaults to 10 and is capped at 100.

Array_of_OrgDatasetSemanticSearchMatch

Run semantic search across chunked conversion outputs for a dataset.

Summary statistics for an org dataset's conversions.

Return aggregate conversion stats for a dataset owned by the caller's org.

This endpoint accepts `multipart/form-data` where each file part becomes a source object in the dataset. Paths are normalized and must be relative.

Response payload for uploading files into a Zoo-managed dataset.

Upload source files into a Zoo-managed dataset.

This endpoint requires authentication by an org admin. It lists the members of the authenticated user's org.

role

Members of an org can not modify an org, but they belong in the org.

List members of your org.

If the user exists, this will add them to your org. If they do not exist, this will create a new user and add them to your org.

In both cases the user gets an email that they have been added to the org.

If the user is already in your org, this will return a 400 and a message.

If the user is already in a different org, this will return a 400 and a message.

This endpoint requires authentication by an org admin. It adds the specified member to the authenticated user's org.

Add a member to your org.

This endpoint requires authentication by an org admin. It gets the specified member of the authenticated user's org.

user_id

Get a member of your org.

This endpoint requires authentication by an org admin. It updates the specified member of the authenticated user's org.

Update a member of your org.

This endpoint requires authentication by an org admin. It removes the specified member from the authenticated user's org.

Remove a member from your org.

This endpoint requires authentication by an org member. It lists the organization's active public OAuth apps.

List org OAuth apps.

This endpoint requires authentication by an org admin. It creates an active public OAuth app owned by the authenticated organization.

Request body for creating a public OAuth app.

Create an org OAuth app.

This endpoint requires authentication by an org member. It returns the organization's active public OAuth app by client ID.

client_id

Get an org OAuth app.

This endpoint requires authentication by an org admin. It updates the configuration of the organization's active public OAuth app.

Request body for updating a public OAuth app.

Update an org OAuth app.

This endpoint requires authentication by an org admin. It deactivates the organization's active public OAuth app.

Delete an org OAuth app.

This endpoint requires authentication by an org admin. It gets the privacy settings for the authenticated user's org.

Get the privacy settings for an org.

This endpoint requires authentication by an org admin. It updates the privacy settings for the authenticated user's org.

Update the privacy settings for an org.

This endpoint requires authentication by an org admin.

Get the SAML identity provider.

Parameters for creating a SAML identity provider.

Update the SAML identity provider.

Create a SAML identity provider.

Delete an SAML identity provider.

This endpoint requires authentication by an org admin. It gets the shortlinks for the authenticated user's org.

Get the shortlinks for an org.

Zoo admins can retrieve extended information about any organization, while non-admins receive a 404 to avoid leaking existence.

Extra admin-only details for an organization.

Get admin-only details for an organization.

This endpoint requires Zoo admin authentication. It returns the active contract for the organization, or the latest draft when no active contract exists.

Serialized contract snapshot returned from the database.

Get the billing contract for an organization.

This endpoint requires Zoo admin authentication. It upserts the contract definition used for admin-managed enterprise billing.

Complete contract payload used to create or replace an org's contract.

Create or replace the billing contract for an organization.

This endpoint requires authentication by any Zoo user. It gets the authenticated user's org.

If the user is not a member of an org, this endpoint will return a 404.

A user's information about an org, including their role.

Get a user's org.

An organization is a group of users of the Zoo API. Here, we can add users to an org and perform operations on orgs.

Orgs

Endpoints