Retrieve a list of repositories

GET 
https://api.pharia.example.com/v1/studio/data/repositories

Fetches a paginated list of all available repositories with optional filters for media type, modality, and name.

Request

Query Parameters

page integer

The page number to retrieve, used for paginated responses.

size integer

The number of items to include per page in the response.

media_type string

Filter repositories by their specific media type, such as application/x-ndjson, application/csv

modality string

Filter repositories by modality, indicating the format or approach, like text.

name string

Search for repositories by their specific name.

Responses

200

OK

application/json

Schema

Schema

repositories object[]
Array [
repositoryIdstring
Unique identifier for the repository.
Example: cb26237c-3beb-40f3-8e13-77d862f722b5
namestring
The name assigned to the repository for easy identification.
Example: My Repository
mediaTypestring
The media type of the data stored in the repository
Possible values: [application/x-ndjson, application/json, application/jsonlines, jsonlines]
Example: application/x-ndjson
modalitystring
The format or type of data, indicating the way it is structured, such as text.
Possible values: [text]
Example: text
mutableboolean
Indicates if the repository data is mutable (modifiable) after creation.
Example: false
schemaobjectnullable
Defines the schema(AVRO) for data points in the dataset of a given repository, including field types and defaults. This is optional and can be null. The schema is not enforced when upload a dataset(comming feature)
Example: {"type":"record","name":"MySchema","fields":[{"name":"model","type":"string","default":"pharia"}]}
createdAtstring
The timestamp for when the repository was created in ISO 8601 format.
Example: 2021-08-25T15:04:05Z
updatedAtstring
The timestamp for when the repository was last updated in ISO 8601 format.
Example: 2021-08-25T15:04:05Z
]
pageinteger
The current page number in the paginated list.
Example: 0
sizeinteger
The number of repositories displayed per page.
Example: 1
totalinteger
The total number of repositories available.
Example: 1

Example (auto)

{
  "repositories": [
    {
      "repositoryId": "cb26237c-3beb-40f3-8e13-77d862f722b5",
      "name": "My Repository",
      "mediaType": "application/x-ndjson",
      "modality": "text",
      "mutable": false,
      "schema": {
        "type": "record",
        "name": "MySchema",
        "fields": [
          {
            "name": "model",
            "type": "string",
            "default": "pharia"
          }
        ]
      },
      "createdAt": "2021-08-25T15:04:05Z",
      "updatedAt": "2021-08-25T15:04:05Z"
    }
  ],
  "page": 0,
  "size": 1,
  "total": 1
}

400

BAD REQUEST

application/json

Schema

Schema

messagestring
Example: A descriptive error message based on the specific status code encountered, detailing the issue and possible causes.

Example (auto)

{
  "message": "A descriptive error message based on the specific status code encountered, detailing the issue and possible causes."
}

401

UNAUTHORIZED When access token is invalid.

application/json

Schema

Schema

messagestring
Example: A descriptive error message based on the specific status code encountered, detailing the issue and possible causes.

Example (auto)

{
  "message": "A descriptive error message based on the specific status code encountered, detailing the issue and possible causes."
}

500

INTERNAL SERVER ERROR

application/json

Schema

Schema

messagestring
Example: A descriptive error message based on the specific status code encountered, detailing the issue and possible causes.

Example (auto)

{
  "message": "A descriptive error message based on the specific status code encountered, detailing the issue and possible causes."
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.pharia.example.com/v1/studio/data/repositories");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.pharia.example.com/v1/studio/data

Parameters

page — query

size — query

media_type — query

modality — query

name — query

ResponseClear

Click the Send API Request button above and see the response here!