The array API from TileDB — 29 operation(s) for array.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/tiledb-array-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Tiledb Array API
version: '1.0'
description: 'Operations tagged array across 2 of this provider''s published API definitions: tiledb-cloud-v1-openapi.yaml, tiledb-cloud-v2-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /v1
- url: /v2
security:
- BasicAuth: []
- ApiKeyAuth: []
tags:
- name: array
paths:
/arrays:
parameters:
- name: public_share
in: query
description: Public share values can be one of exclude, only
schema:
type: string
get:
description: get all array metadata user has access to
tags:
- array
operationId: getAllArrayMetadata
responses:
200:
description: array metadata for all arrays user has access to
content:
application/json:
schema:
type: array
x-omitempty: true
items:
$ref: '#/components/schemas/ArrayInfo'
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Get all array metadata
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: with_metadata
in: query
description: include the metadata of the arrays
required: false
schema:
type: boolean
get:
description: get metadata on all arrays in a namespace
tags:
- array
operationId: getArraysInNamespace
responses:
200:
description: array metadata for all arrays in a namespace
content:
application/json:
schema:
type: array
x-omitempty: true
items:
$ref: '#/components/schemas/ArrayInfo'
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Get arrays in namespace
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
- name: Content-Type
in: header
description: Content Type of input and return mime
required: true
schema:
type: string
default: application/json
delete:
description: delete a array
tags:
- array
operationId: deleteArray
responses:
204:
description: delete array successful
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Delete array
x-summary-source: derived
get:
description: get an ArraySchema using a url encoded uri
tags:
- array
operationId: getArray
responses:
200:
description: get ArraySchema
content:
application/json:
schema:
$ref: '#/components/schemas/ArraySchema'
application/capnp:
schema:
$ref: '#/components/schemas/ArraySchema'
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/capnp:
schema:
$ref: '#/components/schemas/Error'
summary: Get array
x-summary-source: derived
post:
description: create a array schema at a specified URI registered to a group/project
tags:
- array
operationId: createArray
parameters:
- name: X-TILEDB-CLOUD-ACCESS-CREDENTIALS-NAME
in: header
description: Optional registered access credentials to use for creation
required: false
schema:
type: string
responses:
204:
description: schema created successfully
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArraySchema'
description: ArraySchema being created
required: true
summary: Create array
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/activity:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
- name: start
in: query
description: 'Start time of window of fetch logs, unix epoch in seconds (default: seven days ago)'
required: false
schema:
type: integer
format: uint64
- name: end
in: query
description: 'End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp)'
required: false
schema:
type: integer
format: uint64
- name: event_types
in: query
description: Refer to ActivityEventType for possible values
schema:
type: string
- name: task_id
in: query
description: Array task ID To filter activity to
schema:
type: string
- name: has_task_id
in: query
description: Excludes activity log results that do not contain an array task UUID
schema:
type: boolean
get:
description: get array activity logs
tags:
- array
operationId: arrayActivityLog
responses:
200:
description: log of array activity
content:
application/json:
schema:
type: array
x-omitempty: true
items:
$ref: '#/components/schemas/ArrayActivityLog'
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Array activity log
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/activity/{id}:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
- name: id
in: path
description: ID of the activity
required: true
schema:
type: string
get:
description: get activity log by ID
tags:
- array
operationId: getActivityLogById
responses:
200:
description: array activity
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayActivityLog'
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Get activity log by id
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/deregister:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
delete:
description: deregister a array
tags:
- array
operationId: deregisterArray
responses:
204:
description: deregistered array successful
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Deregister array
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/array_metadata:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
get:
description: get metadata on an array
tags:
- array
operationId: getArrayMetadataCapnp
responses:
200:
description: array metadata for an array
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayMetadata'
application/capnp:
schema:
$ref: '#/components/schemas/ArrayMetadata'
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/capnp:
schema:
$ref: '#/components/schemas/Error'
summary: Get array metadata capnp
x-summary-source: derived
post:
description: update metadata on an array
tags:
- array
operationId: updateArrayMetadataCapnp
responses:
200:
description: array metadata updated successfully
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/capnp:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayMetadata'
application/capnp:
schema:
$ref: '#/components/schemas/ArrayMetadata'
description: List of metadata entries
required: true
summary: Update array metadata capnp
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/fragment_info:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
- name: Content-Type
in: header
description: Content Type of input and return mime
required: true
schema:
type: string
default: application/json
post:
description: fetch an array's fragment info
tags:
- array
operationId: fragmentInfo
responses:
200:
description: fragment info
content:
application/json:
schema:
$ref: '#/components/schemas/FragmentInfo'
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FragmentInfoRequest'
description: ArraySchema being created
required: true
summary: Fragment info
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/metadata:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
get:
description: get metadata on an array
tags:
- array
operationId: getArrayMetadata
responses:
200:
description: array metadata for an array
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayInfo'
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Get array metadata
x-summary-source: derived
patch:
description: update metadata on an array
tags:
- array
operationId: updateArrayMetadata
responses:
204:
description: array metadata updated successfully
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayInfoUpdate'
description: array metadata to update
required: true
summary: Update array metadata
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/fragment_end_timestamp:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
- name: end_timestamp
in: query
description: Milliseconds since Unix epoch
required: false
schema:
type: integer
format: uint64
get:
description: Get fragment end_timestamp on an array, will search for the closest end_timestamp to the timestamp asked
tags:
- array
operationId: getFragmentEndTimestamp
responses:
200:
description: fragment end_timestamp on an array
content:
application/json:
schema:
description: Milliseconds since Unix epoch, end_timestamp of selected fragment or latest timestamp if input timestamp is omitted
type: integer
format: uint64
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Get fragment end timestamp
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/register:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
post:
description: register an array at a specified URI registered to the given namespace
tags:
- array
operationId: registerArray
responses:
200:
description: array registered successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayInfo'
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayInfoUpdate'
description: metadata associated with array
required: true
summary: Register array
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/consolidate:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
post:
description: consolidate an array at a specified URI
tags:
- array
operationId: consolidateArray
responses:
204:
description: array consolidated successfully
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayConsolidationRequest'
description: Consolidate Request
required: true
summary: Consolidate array
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/vacuum:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
post:
description: vacuum an array at a specified URI
tags:
- array
operationId: vacuumArray
responses:
204:
description: array vacuumed successfully
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayVacuumRequest'
description: Vaccum Request
required: true
summary: Vacuum array
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/enumerations:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
post:
description: request to get the enumerations of the arrays' attributes
tags:
- array
operationId: loadEnumerations
responses:
200:
description: enumerations returned successfully
content:
application/json:
schema:
$ref: '#/components/schemas/LoadEnumerationsResponse'
404:
description: Array does not exist or user does not have permissions to access it
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadEnumerationsRequest'
description: Load Enumerations Request
required: true
summary: Load enumerations
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/schema:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
post:
description: request to get the array schema
tags:
- array
operationId: loadArraySchema
responses:
200:
description: array schemas returned successfully
content:
application/json:
schema:
$ref: '#/components/schemas/LoadArraySchemaResponse'
404:
description: Array does not exist or user does not have permissions to access it
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadArraySchemaRequest'
description: Load Array Schema Request
required: true
summary: Load array schema
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/share:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
get:
description: Get all sharing details of the array
tags:
- array
operationId: getArraySharingPolicies
responses:
200:
description: List of all specific sharing policies
content:
application/json:
schema:
type: array
x-omitempty: true
items:
$ref: '#/components/schemas/ArraySharing'
404:
description: Array does not exist or user does not have permissions to view array-sharing policies
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Get array sharing policies
x-summary-source: derived
patch:
description: Share an array with a user
tags:
- array
operationId: shareArray
responses:
204:
description: Array shared successfully
404:
description: Array does not exist or user does not have permissions to share array
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArraySharing'
description: Namespace and list of permissions to share with. An empty list of permissions will remove the namespace; if permissions already exist they will be deleted then new ones added. In the event of a failure, the new policies will be rolled back to prevent partial policies, and it's likely the array will not be shared with the namespace at all.
required: true
summary: Share array
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/non_empty_domain:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
- name: Content-Type
in: header
description: Content Type of input and return mime
required: true
schema:
type: string
default: application/json
- name: X-Payer
in: header
description: Name of organization or user who should be charged for this request
schema:
type: string
get:
description: get the non empty domain of an array
tags:
- array
operationId: getArrayNonEmptyDomain
responses:
200:
description: get the non empty domain of an array
content:
application/json:
schema:
$ref: '#/components/schemas/NonEmptyDomain'
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Get array non empty domain
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/max_buffer_sizes:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
- name: subarray
in: query
description: CSV string of subarray to get max buffer sizes for
required: true
schema:
type: string
- name: Content-Type
in: header
description: Content Type of input and return mime
required: true
schema:
type: string
default: application/json
- name: X-Payer
in: header
description: Name of organization or user who should be charged for this request
schema:
type: string
get:
description: get the max buffer sizes of an array for a subarray
tags:
- array
operationId: getArrayMaxBufferSizes
responses:
200:
description: get the max buffer sizes of an array for a subarray
content:
application/json:
schema:
$ref: '#/components/schemas/MaxBufferSizes'
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
summary: Get array max buffer sizes
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/sample:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
- name: samples
in: query
description: Number of sample results to return
schema:
type: number
format: uint8
default: 5
get:
description: get an sample set of data from the array
tags:
- array
operationId: getArraySampleData
responses:
200:
description: get array sample data
content:
application/json:
schema:
$ref: '#/components/schemas/ArraySample'
example:
dim1:
- 1
- 2
- 3
- 1
- 2
dim2:
- 1
- 1
- 1
- 2
- 2
attribute1:
- 1
- 2
- 3
- 4
- 5
attribute2:
- test1
- test2
- test3
- test4
- test5
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: Error try again
code: 1
summary: Get array sample data
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/metadata_json:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
- name: length
in: query
description: (optional) limit character length of returned values
required: false
schema:
type: integer
- name: end_timestamp
in: query
description: Milliseconds since Unix epoch, metadata will use open_at functionality to open array at the specific timestamp
required: false
schema:
type: integer
format: uint64
get:
description: get metadata from the array in JSON format
tags:
- array
operationId: getArrayMetaDataJson
responses:
200:
description: get array metadata
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayMetadataJson'
example:
key1: 25
key2:
- 25
- 26
- 27
- 28
key3: 25.1
key4:
- 25.1
- 26.2
- 27.3
- 28.4
key5: This is TileDB array metadata
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: Error try again
code: 1
summary: Get array meta data json
x-summary-source: derived
servers:
- url: /v1
/arrays/{namespace}/{array}/non_empty_domain_json:
parameters:
- name: namespace
in: path
description: namespace array is in (an organization name or user's username)
required: true
schema:
type: string
- name: array
in: path
description: name/uri of array that is url-encoded
required: true
schema:
type: string
get:
description: get non-empty domain from the array in json format
tags:
- array
operationId: getArrayNonEmptyDomainJson
responses:
200:
description: get array non-empty domaim
content:
application/json:
schema:
$ref: '#/components/schemas/NonEmptyDomainJson'
example:
dim1:
- 1
- 20
dim2:
- a
- c
502:
description: Bad Gateway
default:
description: error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: Error try again
code: 1
summary: Get array non empty domain json
x-summa
# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tiledb/refs/heads/main/openapi/tiledb-array-api-openapi.yml