mixpeek.PrivateApi

All URIs are relative to https://api.mixpeek.com

Method	HTTP request	Description
accept_invitation_organizations	POST /v1/private/organizations/invitations/accept	Accept Invitation
add_user_to_organization	POST /v1/private/organizations/add-user	Add User To Organization Private
complete_tier_internal_batches_batch_id_num	POST /v1/internal/batches/{batch_id}/tiers/{tier_num}/complete	Mark tier complete and trigger next tier (KISS - Engine callback)
configure_storage_cors_configurations	POST /v1/private/configurations/storage/cors	Configure CORS for Object Storage
create_bootstrap_key_organizations_id_users_email	POST /v1/private/organizations/{organization_id}/users/{user_email}/bootstrap-key	Create Bootstrap Api Key
create_organization	POST /v1/private/organizations	Create Organization Private
delete_organization	DELETE /v1/private/organizations/{organization_identifier}	Delete Organization Private
diagnose_clickhouse_configurations_diagnostics	GET /v1/private/configurations/clickhouse/diagnostics	Diagnose ClickHouse Configuration
get_organization	GET /v1/private/organizations/{organization_identifier}	Get Organization Private
get_pending_invitations_organizations_email	GET /v1/private/organizations/invitations/{email}	Get Pending Invitations
get_storage_cors_configurations	GET /v1/private/configurations/storage/cors	Get Current CORS Configuration
remove_user_from_organization	POST /v1/private/organizations/remove-user	Remove User From Organization Private
update_organization	PATCH /v1/private/organizations/{organization_identifier}	Update Organization Private
update_task_status_internal	POST /v1/internal/tasks/{task_id}/status	Update task status (Engine callback)

accept_invitation_organizations

Dict[str, object] accept_invitation_organizations(request_body)

Accept Invitation

Activate a pending invitation (status: pending → active).

Expected payload: email: str organization_id: str user_name: str | None (optional, updates display name)

Example

import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    request_body = None # Dict[str, object] | 

    try:
        # Accept Invitation
        api_response = api_instance.accept_invitation_organizations(request_body)
        print("The response of PrivateApi->accept_invitation_organizations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->accept_invitation_organizations: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	Dict[str, object]

Return type

Dict[str, object]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_user_to_organization

OrganizationModelResponse add_user_to_organization(add_user_to_organization_request)

Add User To Organization Private

Add a user to a private organization.

Example

import mixpeek
from mixpeek.models.add_user_to_organization_request import AddUserToOrganizationRequest
from mixpeek.models.organization_model_response import OrganizationModelResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    add_user_to_organization_request = mixpeek.AddUserToOrganizationRequest() # AddUserToOrganizationRequest | 

    try:
        # Add User To Organization Private
        api_response = api_instance.add_user_to_organization(add_user_to_organization_request)
        print("The response of PrivateApi->add_user_to_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->add_user_to_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_user_to_organization_request	AddUserToOrganizationRequest

Return type

OrganizationModelResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

complete_tier_internal_batches_batch_id_num

object complete_tier_internal_batches_batch_id_num(batch_id, tier_num, trigger_tier_request, authorization=authorization)

Mark tier complete and trigger next tier (KISS - Engine callback)

Called by Engine/BatchPoller when a tier completes. Simplified single-endpoint flow.

Example

import mixpeek
from mixpeek.models.trigger_tier_request import TriggerTierRequest
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    batch_id = 'batch_id_example' # str | 
    tier_num = 56 # int | 
    trigger_tier_request = mixpeek.TriggerTierRequest() # TriggerTierRequest | 
    authorization = 'authorization_example' # str |  (optional)

    try:
        # Mark tier complete and trigger next tier (KISS - Engine callback)
        api_response = api_instance.complete_tier_internal_batches_batch_id_num(batch_id, tier_num, trigger_tier_request, authorization=authorization)
        print("The response of PrivateApi->complete_tier_internal_batches_batch_id_num:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->complete_tier_internal_batches_batch_id_num: %s\n" % e)

Parameters

Name	Type	Notes
batch_id	str
tier_num	int
trigger_tier_request	TriggerTierRequest
authorization	str	[optional]

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

configure_storage_cors_configurations

CORSConfigurationResponse configure_storage_cors_configurations(configure_cors_request)

Configure CORS for Object Storage

Configure CORS (Cross-Origin Resource Sharing) on the object storage bucket.

**Why is this needed?**
When using presigned URLs for browser-based uploads, browsers enforce CORS policies.
Without proper CORS configuration, uploads from the frontend will fail with CORS errors.

**When to use this:**
- During initial setup of the Mixpeek platform
- When adding new frontend domains (development, staging, production)
- When troubleshooting browser upload failures

**Important notes:**
- This is an admin-only operation (requires admin API key)
- CORS is configured on the entire object storage bucket (not per-namespace)
- Changes take effect immediately but may be cached by browsers
- This works for any object storage provider (S3, LocalStack, GCS)

**Common use cases:**
1. Local development: Configure localhost origins
2. Production: Configure production domain origins
3. Multi-environment: Configure multiple origins for dev/staging/prod

Example

import mixpeek
from mixpeek.models.cors_configuration_response import CORSConfigurationResponse
from mixpeek.models.configure_cors_request import ConfigureCORSRequest
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    configure_cors_request = mixpeek.ConfigureCORSRequest() # ConfigureCORSRequest | 

    try:
        # Configure CORS for Object Storage
        api_response = api_instance.configure_storage_cors_configurations(configure_cors_request)
        print("The response of PrivateApi->configure_storage_cors_configurations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->configure_storage_cors_configurations: %s\n" % e)

Parameters

Name	Type	Description	Notes
configure_cors_request	ConfigureCORSRequest

Return type

CORSConfigurationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_bootstrap_key_organizations_id_users_email

Dict[str, object] create_bootstrap_key_organizations_id_users_email(organization_id, user_email)

Create Bootstrap Api Key

Create the organization's primary API key (requires MIXPEEK_PRIVATE_KEY).

🔑 IMPORTANT - Two Different Keys (DO NOT CONFUSE):

MIXPEEK_PRIVATE_KEY (what you use to call THIS endpoint):
- Static, hardcoded token shared between studio proxy and backend
- Used ONLY for server-to-server /v1/private/* endpoint calls
- Never changes, never stored in database
- Never used by frontend UI
- Example: xnefritAiaKQiddNL3ZHWEN4cHWLsCkwEycUDLU2wLekQEuf
Organization API Key (what THIS endpoint creates and returns):
- Created ONCE per organization with ADMIN permissions
- Used by frontend UI for ALL /v1/* API calls
- Named "admin-key" and stored in database (hashed)
- Plaintext returned ONCE on creation
- 🔒 PROTECTED: Users CANNOT delete, rotate, or change permissions on this key
- Example: sk_kbHvXHAySDUrzrPo2ajwmqBAXJ...

This endpoint creates an Organization API key (type #2) that the frontend will use. It does NOT create, modify, or touch the MIXPEEK_PRIVATE_KEY (type #1).

⚠️ The plaintext key is only returned ONCE on creation - store it in localStorage! ✅ If called when key exists: Revokes old key and returns a new one (idempotent)

Example

import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    organization_id = 'organization_id_example' # str | 
    user_email = 'user_email_example' # str | 

    try:
        # Create Bootstrap Api Key
        api_response = api_instance.create_bootstrap_key_organizations_id_users_email(organization_id, user_email)
        print("The response of PrivateApi->create_bootstrap_key_organizations_id_users_email:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->create_bootstrap_key_organizations_id_users_email: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str
user_email	str

Return type

Dict[str, object]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_organization

OrganizationModel create_organization(create_organization_request)

Create Organization Private

Create a new private organization.

NOTE: This endpoint returns OrganizationModel (with internal_id) instead of OrganizationModelResponse because it's admin-only and callers need the internal_id for service initialization and E2E testing.

Example

import mixpeek
from mixpeek.models.create_organization_request import CreateOrganizationRequest
from mixpeek.models.organization_model import OrganizationModel
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    create_organization_request = mixpeek.CreateOrganizationRequest() # CreateOrganizationRequest | 

    try:
        # Create Organization Private
        api_response = api_instance.create_organization(create_organization_request)
        print("The response of PrivateApi->create_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->create_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_organization_request	CreateOrganizationRequest

Return type

OrganizationModel

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_organization

GenericDeleteResponse delete_organization(organization_identifier)

Delete Organization Private

Delete a private organization.

Example

import mixpeek
from mixpeek.models.generic_delete_response import GenericDeleteResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    organization_identifier = 'organization_identifier_example' # str | 

    try:
        # Delete Organization Private
        api_response = api_instance.delete_organization(organization_identifier)
        print("The response of PrivateApi->delete_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->delete_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_identifier	str

Return type

GenericDeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

diagnose_clickhouse_configurations_diagnostics

object diagnose_clickhouse_configurations_diagnostics()

Diagnose ClickHouse Configuration

Run diagnostics on ClickHouse to check version, settings, and data type behavior.

This is useful for:
- Debugging differences between local and production environments
- Verifying ClickHouse configuration
- Checking if COUNT() returns strings or integers

Example

import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)

    try:
        # Diagnose ClickHouse Configuration
        api_response = api_instance.diagnose_clickhouse_configurations_diagnostics()
        print("The response of PrivateApi->diagnose_clickhouse_configurations_diagnostics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->diagnose_clickhouse_configurations_diagnostics: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_organization

OrganizationModelResponse get_organization(organization_identifier)

Get Organization Private

Get a private organization by ID or name.

Example

import mixpeek
from mixpeek.models.organization_model_response import OrganizationModelResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    organization_identifier = 'organization_identifier_example' # str | 

    try:
        # Get Organization Private
        api_response = api_instance.get_organization(organization_identifier)
        print("The response of PrivateApi->get_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->get_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_identifier	str

Return type

OrganizationModelResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_pending_invitations_organizations_email

Dict[str, object] get_pending_invitations_organizations_email(email)

Get Pending Invitations

Return all pending Mixpeek invitations for the given email address.

Searches across all organizations for users with this email and status=pending. Used on the signup flow to offer invited users a chance to join their org.

Example

import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    email = 'email_example' # str | 

    try:
        # Get Pending Invitations
        api_response = api_instance.get_pending_invitations_organizations_email(email)
        print("The response of PrivateApi->get_pending_invitations_organizations_email:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->get_pending_invitations_organizations_email: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str

Return type

Dict[str, object]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_storage_cors_configurations

CORSConfigurationInfo get_storage_cors_configurations()

Get Current CORS Configuration

Retrieve the current CORS configuration for the object storage bucket.

**Use this to:**
- Verify CORS is properly configured
- Check which origins are currently allowed
- Troubleshoot CORS-related issues
- Audit current security settings

Example

import mixpeek
from mixpeek.models.cors_configuration_info import CORSConfigurationInfo
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)

    try:
        # Get Current CORS Configuration
        api_response = api_instance.get_storage_cors_configurations()
        print("The response of PrivateApi->get_storage_cors_configurations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->get_storage_cors_configurations: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CORSConfigurationInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_user_from_organization

GenericDeleteResponse remove_user_from_organization(request_body)

Remove User From Organization Private

Remove a user from an organization by email (admin-only).

Mirrors the add-user endpoint. Accepts: - organization_identifier: org ID or name - email: user email to remove

Example

import mixpeek
from mixpeek.models.generic_delete_response import GenericDeleteResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    request_body = None # Dict[str, object] | 

    try:
        # Remove User From Organization Private
        api_response = api_instance.remove_user_from_organization(request_body)
        print("The response of PrivateApi->remove_user_from_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->remove_user_from_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	Dict[str, object]

Return type

GenericDeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_organization

OrganizationModelResponse update_organization(organization_identifier, organization_admin_update_request)

Update Organization Private

Admin-only: update organization tier, rate limits, and infrastructure.

Security: This endpoint is ONLY accessible with MIXPEEK_PRIVATE_TOKEN. It allows updating infrastructure configuration (Qdrant/Ray URLs) for ENTERPRISE customers.

Infrastructure updates require Mixpeek admin privileges and are logged for audit.

Example

import mixpeek
from mixpeek.models.organization_admin_update_request import OrganizationAdminUpdateRequest
from mixpeek.models.organization_model_response import OrganizationModelResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    organization_identifier = 'organization_identifier_example' # str | 
    organization_admin_update_request = mixpeek.OrganizationAdminUpdateRequest() # OrganizationAdminUpdateRequest | 

    try:
        # Update Organization Private
        api_response = api_instance.update_organization(organization_identifier, organization_admin_update_request)
        print("The response of PrivateApi->update_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->update_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_identifier	str
organization_admin_update_request	OrganizationAdminUpdateRequest

Return type

OrganizationModelResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_task_status_internal

object update_task_status_internal(task_id, task_status_update_request, authorization=authorization)

Update task status (Engine callback)

Internal endpoint for Engine to update task status after async job completion.

Example

import mixpeek
from mixpeek.models.task_status_update_request import TaskStatusUpdateRequest
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.PrivateApi(api_client)
    task_id = 'task_id_example' # str | 
    task_status_update_request = mixpeek.TaskStatusUpdateRequest() # TaskStatusUpdateRequest | 
    authorization = 'authorization_example' # str |  (optional)

    try:
        # Update task status (Engine callback)
        api_response = api_instance.update_task_status_internal(task_id, task_status_update_request, authorization=authorization)
        print("The response of PrivateApi->update_task_status_internal:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivateApi->update_task_status_internal: %s\n" % e)

Parameters

Name	Type	Notes
task_id	str
task_status_update_request	TaskStatusUpdateRequest
authorization	str	[optional]

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

PrivateApi.md

Latest commit

History

PrivateApi.md

File metadata and controls

mixpeek.PrivateApi

accept_invitation_organizations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_user_to_organization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

complete_tier_internal_batches_batch_id_num

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configure_storage_cors_configurations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_bootstrap_key_organizations_id_users_email

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_organization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_organization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

diagnose_clickhouse_configurations_diagnostics

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_organization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_pending_invitations_organizations_email

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_storage_cors_configurations

Example

Parameters