Skip to main content
API docs by Redocly

DataCovey API (0.1.0)

Download OpenAPI specification:Download

tenants

Create Tenant

Create a new tenant.

This endpoint is protected and requires a valid JWT token. Only users with appropriate permissions can create tenants.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

List Tenants

List all tenants.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

Get Tenant

Get a tenant by ID.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
tenant_id
required
string <uuid> (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

Update Tenant

Update a tenant.

This endpoint is protected and requires a valid JWT token. Only users with appropriate permissions can update tenants.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
tenant_id
required
string <uuid> (Tenant Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Any of
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

Delete Tenant

Delete a tenant (soft delete).

This endpoint is protected and requires a valid JWT token. Only users with appropriate permissions can delete tenants.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
tenant_id
required
string <uuid> (Tenant Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

users

Get Tenant Users

Get all users in the current tenant

Authorizations:
HTTPBearerHTTPBearer

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Create User

Create a new user

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
email
required
string (Email)
name
required
string (Name)
role
string (Role)
Default: "Dataset user"
Enum: "Dataset user" "Dataset editor" "Org admin"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "role": "Dataset user"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "role": "Dataset user",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "identity_provider_id": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Get User

Get user by ID

Authorizations:
HTTPBearerHTTPBearer
path Parameters
user_id
required
string (User Id)

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "role": "Dataset user",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "identity_provider_id": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Update User

Update user by ID

Authorizations:
HTTPBearerHTTPBearer
path Parameters
user_id
required
string (User Id)
Request Body schema: application/json
required
email
required
string (Email)
name
required
string (Name)
role
string (Role)
Default: "Dataset user"
Enum: "Dataset user" "Dataset editor" "Org admin"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "role": "Dataset user"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "role": "Dataset user",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "identity_provider_id": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Delete User Endpoint

Soft delete a user

This endpoint is protected and requires a valid JWT token. The user making the request must have the 'Org admin' role.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
user_id
required
string (User Id)

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Invite New User

Invite a new user to the system

This endpoint is protected and requires a valid JWT token. The user sending the invitation must have the 'Org admin' role.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
email
required
string (Email)
name
required
string (Name)
role
string (Role)
Default: "Dataset user"
Enum: "Dataset user" "Dataset editor" "Org admin"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "role": "Dataset user"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "role": "Dataset user",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "identity_provider_id": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Get Current User

Get the current user's details

Authorizations:
HTTPBearer

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "role": "Dataset user",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "identity_provider_id": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Update User Role Endpoint

Update a user's role

This endpoint is protected and requires a valid JWT token. The user making the request must have the 'Org admin' role.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
user_id
required
string (User Id)
Request Body schema: application/json
required
role
required
string (Role)
Enum: "Dataset user" "Dataset editor" "Org admin"

Responses

Request samples

Content type
application/json
{
  • "role": "Dataset user"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "role": "Dataset user",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "identity_provider_id": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

projects

Create Project

Create a new project.

This endpoint is protected and requires a valid JWT token. Projects are created within the current user's tenant.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

List Projects

List all projects in the current tenant.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "projects": [
    ]
}

Get Project

Get a project by ID.

This endpoint is protected and requires a valid JWT token. Only projects within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

Update Project

Update a project.

This endpoint is protected and requires a valid JWT token. Only projects within the current user's tenant can be updated.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
project_id
required
string <uuid> (Project Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Description (string) or Description (null) (Description)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

Delete Project

Delete a project (soft delete).

This endpoint is protected and requires a valid JWT token. Only projects within the current user's tenant can be deleted.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

datasets

Create Dataset

Create a new dataset.

This endpoint is protected and requires a valid JWT token. Datasets are created within the current user's tenant. A corresponding BigQuery dataset will be created synchronously.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
project_id
required
string <uuid> (Project Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

List Datasets

List all datasets in the current tenant.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "datasets": [
    ]
}

Get Dataset

Get a dataset by ID.

This endpoint is protected and requires a valid JWT token. Only datasets within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
dataset_id
required
string <uuid> (Dataset Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

Update Dataset

Update a dataset.

This endpoint is protected and requires a valid JWT token. Only datasets within the current user's tenant can be updated. The corresponding BigQuery dataset will be updated synchronously.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
dataset_id
required
string <uuid> (Dataset Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Description (string) or Description (null) (Description)
Project Id (string) or Project Id (null) (Project Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

Delete Dataset

Delete a dataset (soft delete).

This endpoint is protected and requires a valid JWT token. Only datasets within the current user's tenant can be deleted. The corresponding BigQuery dataset will be deleted synchronously.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
dataset_id
required
string <uuid> (Dataset Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Datasets By Project

List all datasets in a specific project.

This endpoint is protected and requires a valid JWT token. Only datasets within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "datasets": [
    ]
}

tables

Create Table

Create a new table.

This endpoint is protected and requires a valid JWT token. Tables are created within the current user's tenant. A corresponding BigQuery table will be created synchronously.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
name
required
string (Name)
schema
required
any (Schema)
dataset_id
required
string <uuid> (Dataset Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "schema": null,
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "schema": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

List Tables

List all tables in the current tenant.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "tables": [
    ]
}

Get Table

Get a table by ID.

This endpoint is protected and requires a valid JWT token. Only tables within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
table_id
required
string <uuid> (Table Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "schema": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

Update Table

Update a table.

This endpoint is protected and requires a valid JWT token. Only tables within the current user's tenant can be updated. The corresponding BigQuery table will be updated synchronously.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
table_id
required
string <uuid> (Table Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Schema (any) or Schema (null) (Schema)
Dataset Id (string) or Dataset Id (null) (Dataset Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "schema": { },
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "schema": null,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

Delete Table

Delete a table (soft delete).

This endpoint is protected and requires a valid JWT token. Only tables within the current user's tenant can be deleted. The corresponding BigQuery table will be deleted synchronously.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
table_id
required
string <uuid> (Table Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Tables By Dataset

List all tables in a specific dataset.

This endpoint is protected and requires a valid JWT token. Only tables within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
dataset_id
required
string <uuid> (Dataset Id)

Responses

Response samples

Content type
application/json
{
  • "tables": [
    ]
}

import_jobs

Create Import Job

Create a new import job.

This endpoint is protected and requires a valid JWT token. Import jobs are created within the current user's tenant.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
status
required
string (Status)
table_id
required
string <uuid> (Table Id)

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

List Import Jobs

List all import jobs in the current tenant.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "import_jobs": [
    ]
}

Get Import Job

Get an import job by ID.

This endpoint is protected and requires a valid JWT token. Only import jobs within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
job_id
required
string <uuid> (Job Id)

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

List Import Jobs By Table

List all import jobs for a specific table.

This endpoint is protected and requires a valid JWT token. Only import jobs within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
table_id
required
string <uuid> (Table Id)

Responses

Response samples

Content type
application/json
{
  • "import_jobs": [
    ]
}

export_jobs

Create Export Job

Create a new export job.

This endpoint is protected and requires a valid JWT token. Export jobs are created within the current user's tenant.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
status
required
string (Status)
table_id
required
string <uuid> (Table Id)

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

List Export Jobs

List all export jobs in the current tenant.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "export_jobs": [
    ]
}

Get Export Job

Get an export job by ID.

This endpoint is protected and requires a valid JWT token. Only export jobs within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
job_id
required
string <uuid> (Job Id)

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

List Export Jobs By Table

List all export jobs for a specific table.

This endpoint is protected and requires a valid JWT token. Only export jobs within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
table_id
required
string <uuid> (Table Id)

Responses

Response samples

Content type
application/json
{
  • "export_jobs": [
    ]
}

query_jobs

Get Query Job Results

Get paginated query results for a completed query job.

This endpoint is protected and requires a valid JWT token. Only query jobs within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
job_id
required
string <uuid> (Job Id)
query Parameters
page
integer (Page) >= 1
Default: 1

Page number (1-indexed)

page_size
integer (Page Size) [ 1 .. 200 ]
Default: 50

Number of rows per page

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "columns": [
    ],
  • "column_privacy": { },
  • "total_rows": 0,
  • "page": 0,
  • "page_size": 0,
  • "total_pages": 0
}

Get Query Job

Get a query job by ID.

This endpoint is protected and requires a valid JWT token. Only query jobs within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
job_id
required
string <uuid> (Job Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "running_job_id": "string",
  • "status": "string",
  • "error_result": { },
  • "error_details": { },
  • "created": "2019-08-24T14:15:22Z",
  • "started": "2019-08-24T14:15:22Z",
  • "ended": "2019-08-24T14:15:22Z",
  • "total_rows": 0,
  • "total_bytes_processed": 0,
  • "total_slot_ms": 0,
  • "cache_hit": true,
  • "dml_stats": { },
  • "query_plan": { },
  • "timeline": { },
  • "destination_table": { },
  • "num_dml_affected_rows": 0,
  • "script_statistics": { },
  • "session_info": { },
  • "transaction_info": { },
  • "reservation_usage": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "private_row_count": 0,
  • "exports": [
    ]
}

List Query Jobs

List all query jobs in the current tenant.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "query_jobs": [
    ]
}

List Query Jobs By Query

List all query jobs for a specific query.

This endpoint is protected and requires a valid JWT token. Only query jobs within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
query_id
required
string <uuid> (Query Id)

Responses

Response samples

Content type
application/json
{
  • "query_jobs": [
    ]
}

query_result_exports

Create Export

Create a new export job for query results.

This endpoint is protected and requires a valid JWT token. Only users from the same tenant as the query job can create exports. Export jobs are created within the current user's tenant.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
job_id
required
string <uuid> (Job Id)
Request Body schema: application/json
required
format
string (ExportFormat)
Default: "CSV"
Enum: "CSV" "JSON" "AVRO" "PARQUET"
compression
string (ExportCompression)
Default: "GZIP"
Enum: "GZIP" "DEFLATE" "NONE"

Responses

Request samples

Content type
application/json
{
  • "format": "CSV",
  • "compression": "GZIP"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "query_job_id": "9bdb210e-7f90-412b-9a10-f1b506f822ee",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "status": "string",
  • "format": "string",
  • "compression": "string",
  • "gcs_path": "string",
  • "signed_url": "string",
  • "error_message": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z"
}

List Exports

List all export jobs for a query job.

This endpoint is protected and requires a valid JWT token. Only exports within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
job_id
required
string <uuid> (Job Id)

Responses

Response samples

Content type
application/json
{
  • "exports": [
    ]
}

Get Export

Get export job details by ID.

This endpoint is protected and requires a valid JWT token. Only exports within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
export_id
required
string <uuid> (Export Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "query_job_id": "9bdb210e-7f90-412b-9a10-f1b506f822ee",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "status": "string",
  • "format": "string",
  • "compression": "string",
  • "gcs_path": "string",
  • "signed_url": "string",
  • "error_message": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z"
}

Download Export

Get download URL for an export.

This endpoint is protected and requires a valid JWT token. Only users from the same tenant as the export can download. Generates a new signed URL if needed.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
export_id
required
string <uuid> (Export Id)

Responses

Response samples

Content type
application/json
null

query

Create Query

Create a new query.

This endpoint is protected and requires a valid JWT token. Queries are created within the current user's tenant.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
query_text
required
string (Query Text)
project_id
required
string <uuid> (Project Id)

Responses

Request samples

Content type
application/json
{
  • "query_text": "string",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

Response samples

Content type
application/json
{
  • "query_text": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

List Queries

List all queries in the current tenant, optionally filtered by project.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
project_id
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "queries": [
    ]
}

Get Query

Get a query by ID.

This endpoint is protected and requires a valid JWT token. Only queries within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
query_id
required
string <uuid> (Query Id)

Responses

Response samples

Content type
application/json
{
  • "query_text": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

Update Query

Update a query.

This endpoint is protected and requires a valid JWT token. Only queries within the current user's tenant can be updated.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
query_id
required
string <uuid> (Query Id)
Request Body schema: application/json
required
Query Text (string) or Query Text (null) (Query Text)
Project Id (string) or Project Id (null) (Project Id)

Responses

Request samples

Content type
application/json
{
  • "query_text": "string",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

Response samples

Content type
application/json
{
  • "query_text": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

Delete Query

Delete a query (soft delete).

This endpoint is protected and requires a valid JWT token. Only queries within the current user's tenant can be deleted.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
query_id
required
string <uuid> (Query Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Run Query

Run a query. Returns a job_id (query_job_id) immediately after starting the job. Job completion is handled asynchronously in the background. Errors will be returned as HTTP exceptions with detailed error messages.

Authorizations:
HTTPBearer
Request Body schema: application/json
required
query_id
required
string (Query Id)
query_text
required
string (Query Text)

Responses

Request samples

Content type
application/json
{
  • "query_id": "string",
  • "query_text": "string"
}

Response samples

Content type
application/json
{
  • "job_id": "string"
}

Cancel Query

Request Body schema: application/json
required
job_id
required
string (Job Id)

Responses

Request samples

Content type
application/json
{
  • "job_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Download Query Result

path Parameters
job_id
required
string (Job Id)

Responses

Response samples

Content type
application/json
null

query-quota

Get Query Quota Summary

Get query quota summary for current tenant (read-only, Org admin only)

Returns current quota limits, usage, and remaining amounts. Only accessible by users with 'Org admin' role.

Authorizations:
HTTPBearer

Responses

Response samples

Content type
application/json
{
  • "quota": {
    },
  • "usage": {
    },
  • "daily_remaining_usd": "string",
  • "monthly_remaining_usd": "string",
  • "daily_percentage_used": 0,
  • "monthly_percentage_used": 0,
  • "is_daily_quota_exceeded": true,
  • "is_monthly_quota_exceeded": true
}

Get Query Cost History

Get query execution cost history with pagination (read-only, Org admin only)

Args: page: Page number (1-indexed) page_size: Number of records per page (max 100)

Returns: Paginated query cost history

Note: Only accessible by users with 'Org admin' role.

Authorizations:
HTTPBearer
query Parameters
page
integer (Page)
Default: 1
page_size
integer (Page Size)
Default: 20

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "page_size": 0
}

approvals

Create Project Tenant Approval

Create a project-tenant approval request.

This endpoint allows users to request that a tenant be invited to join a project. The request will be sent to all Org admins of the tenant being invited.

Authorizations:
HTTPBearer
Request Body schema: application/json
required
project_id
required
string <uuid> (Project Id)

ID of the project requesting tenant association

tenant_id
required
string <uuid> (Tenant Id)

ID of the tenant being invited

Responses

Request samples

Content type
application/json
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
  • "reviewed_by": "92ab4dbc-1b27-40ce-b24b-7dde8f4709be",
  • "created_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "reviewed_at": "2019-08-24T14:15:22Z",
  • "rejection_reason": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_name": "string",
  • "tenant_name": "string",
  • "requester_name": "string",
  • "requester_email": "string"
}

Create Project Dataset Approval

Create a project-dataset approval request.

This endpoint allows users to request that a dataset be added to a project. The request will be sent to all Org admins of the dataset's owning tenant.

Authorizations:
HTTPBearer
Request Body schema: application/json
required
project_id
required
string <uuid> (Project Id)

ID of the project requesting dataset access

dataset_id
required
string <uuid> (Dataset Id)

ID of the dataset being requested

Responses

Request samples

Content type
application/json
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
  • "reviewed_by": "92ab4dbc-1b27-40ce-b24b-7dde8f4709be",
  • "created_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "reviewed_at": "2019-08-24T14:15:22Z",
  • "rejection_reason": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "project_name": "string",
  • "dataset_name": "string",
  • "requester_name": "string",
  • "requester_email": "string"
}

List Pending Approvals

List all pending approval requests for the current user's tenant.

This endpoint is only accessible to Org admins and returns all pending approval requests that require their attention.

Authorizations:
HTTPBearer

Responses

Response samples

Content type
application/json
{
  • "project_tenant_approvals": [
    ],
  • "project_dataset_approvals": [
    ]
}

Get Approval Details

Get detailed information about a specific approval request.

This endpoint is only accessible to Org admins and returns detailed information about the approval request including all related entities.

Authorizations:
HTTPBearer
path Parameters
approval_id
required
string <uuid> (Approval Id)

Responses

Response samples

Content type
application/json
{
  • "approval": {
    },
  • "project_tenant_details": {
    },
  • "project_dataset_details": {
    }
}

Approve Request

Approve an approval request.

This endpoint is only accessible to Org admins and allows them to approve pending approval requests. The actual association will be created upon approval.

Authorizations:
HTTPBearer
path Parameters
approval_id
required
string <uuid> (Approval Id)

Responses

Response samples

Content type
application/json
{ }

Reject Request

Reject an approval request.

This endpoint is only accessible to Org admins and allows them to reject pending approval requests with an optional reason.

Authorizations:
HTTPBearer
path Parameters
approval_id
required
string <uuid> (Approval Id)
Request Body schema: application/json
required
Rejection Reason (string) or Rejection Reason (null) (Rejection Reason)

Reason for rejection if applicable

Any of
string (Rejection Reason)

Reason for rejection if applicable

Responses

Request samples

Content type
application/json
{
  • "rejection_reason": "string"
}

Response samples

Content type
application/json
{ }

Expire Approvals

Internal endpoint for expiring old approval requests.

This endpoint is called by the Cloud Scheduler to automatically expire approval requests that are older than 15 days.

query Parameters
internal_token
string (Internal Token)

Responses

Response samples

Content type
application/json
{ }

agents

Create Agent

Create a new agent.

This endpoint is protected and requires a valid JWT token. Only users with 'Org admin' role can create agents. Agents are created within the current user's tenant.

IMPORTANT: Agents must have at least one project assignment. The project_id and optional role must be provided in the request body.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
protocol
required
string (Protocol)

Protocol type: 'A2A' or 'MCP'

endpoint_url
required
string (Endpoint Url)

Agent endpoint URL

Capabilities (object) or Capabilities (null) (Capabilities)
Agent Metadata (object) or Agent Metadata (null) (Agent Metadata)
project_id
required
string <uuid> (Project Id)

Project ID to assign the agent to. Agents must have at least one project assignment.

Role (string) or Role (null) (Role)

Optional role for the agent in the project

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "protocol": "string",
  • "endpoint_url": "string",
  • "capabilities": { },
  • "agent_metadata": { },
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "protocol": "string",
  • "endpoint_url": "string",
  • "capabilities": { },
  • "agent_metadata": { },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z",
  • "gateway_url": "string"
}

List Agents

List all agents in the current tenant.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "agents": [
    ]
}

Get Agent

Get an agent by ID.

This endpoint is protected and requires a valid JWT token. Only agents within the current user's tenant are accessible.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
agent_id
required
string <uuid> (Agent Id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "protocol": "string",
  • "endpoint_url": "string",
  • "capabilities": { },
  • "agent_metadata": { },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z",
  • "gateway_url": "string"
}

Update Agent

Update an agent.

This endpoint is protected and requires a valid JWT token. Only agents within the current user's tenant can be updated.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
agent_id
required
string <uuid> (Agent Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Description (string) or Description (null) (Description)
Protocol (string) or Protocol (null) (Protocol)
Endpoint Url (string) or Endpoint Url (null) (Endpoint Url)
Capabilities (object) or Capabilities (null) (Capabilities)
Agent Metadata (object) or Agent Metadata (null) (Agent Metadata)
Status (string) or Status (null) (Status)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "protocol": "string",
  • "endpoint_url": "string",
  • "capabilities": { },
  • "agent_metadata": { },
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "protocol": "string",
  • "endpoint_url": "string",
  • "capabilities": { },
  • "agent_metadata": { },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z",
  • "gateway_url": "string"
}

Delete Agent

Delete an agent (soft delete).

This endpoint is protected and requires a valid JWT token. Only agents within the current user's tenant can be deleted.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
agent_id
required
string <uuid> (Agent Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Test Agent Connection

Test agent connection (stub).

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
agent_id
required
string <uuid> (Agent Id)

Responses

Response samples

Content type
application/json
{ }

Get Agent Tools

Get tools available for an agent

Authorizations:
HTTPBearerHTTPBearer
path Parameters
agent_id
required
string <uuid> (Agent Id)

Responses

Response samples

Content type
application/json
null

Get Agent Rate Limit

Get rate limit configuration for an agent

Authorizations:
HTTPBearerHTTPBearer
path Parameters
agent_id
required
string <uuid> (Agent Id)

Responses

Response samples

Content type
application/json
{
  • "max_requests_per_second": "string",
  • "max_requests_per_minute": "string",
  • "max_requests_per_hour": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978"
}

Update Agent Rate Limit

Update rate limit configuration for an agent

Authorizations:
HTTPBearerHTTPBearer
path Parameters
agent_id
required
string <uuid> (Agent Id)
Request Body schema: application/json
required
required
Max Requests Per Second (number) or Max Requests Per Second (string) (Max Requests Per Second)

Maximum requests per second

required
Max Requests Per Minute (number) or Max Requests Per Minute (string) (Max Requests Per Minute)

Maximum requests per minute

required
Max Requests Per Hour (number) or Max Requests Per Hour (string) (Max Requests Per Hour)

Maximum requests per hour

Responses

Request samples

Content type
application/json
{
  • "max_requests_per_second": 0,
  • "max_requests_per_minute": 0,
  • "max_requests_per_hour": 0
}

Response samples

Content type
application/json
{
  • "max_requests_per_second": "string",
  • "max_requests_per_minute": "string",
  • "max_requests_per_hour": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978"
}

project-agents

Assign Agent To Project

Assign an agent to a project.

This endpoint is protected and requires a valid JWT token. Only users with 'Org admin' role can assign agents to projects.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
project_id
required
string <uuid> (Project Id)
Request Body schema: application/json
required
agent_id
required
string <uuid> (Agent Id)
Role (string) or Role (null) (Role)

Responses

Request samples

Content type
application/json
{
  • "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
  • "role": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z"
}

List Project Agents

List all agents assigned to a project.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
project_id
required
string <uuid> (Project Id)

Responses

Response samples

Content type
application/json
{
  • "agents": [
    ]
}

Remove Agent From Project

Remove an agent from a project.

This endpoint is protected and requires a valid JWT token. Only users with 'Org admin' role can remove agents from projects.

Authorizations:
HTTPBearerHTTPBearer
path Parameters
project_id
required
string <uuid> (Project Id)
agent_id
required
string <uuid> (Agent Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

agent-gateway

Route To Agent

Route a message to a specific agent.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
agent_id
required
string <uuid> (Agent Id)
message
required
object (Message)
Project Id (string) or Project Id (null) (Project Id)

Responses

Request samples

Content type
application/json
{
  • "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
  • "message": { },
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
}

Response samples

Content type
application/json
{
  • "result": { },
  • "error": { },
  • "id": "string"
}

Route To Project Agents

Route a message to all agents assigned to a project.

This endpoint is protected and requires a valid JWT token.

Authorizations:
HTTPBearerHTTPBearer
Request Body schema: application/json
required
project_id
required
string <uuid> (Project Id)
message
required
object (Message)

Responses

Request samples

Content type
application/json
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "message": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

Health Check

Health check endpoint for Docker and monitoring.

Checks:

  • Application status
  • Database connectivity and health

Returns: - 200 OK: All checks passed - 503 Service Unavailable: One or more checks failed

Responses

Response samples

Content type
application/json
null