Skip to content

OrganizationsApi.md

Latest commit

 

History

History
251 lines (171 loc) · 8.81 KB

OrganizationsApi.md

File metadata and controls

251 lines (171 loc) · 8.81 KB

mixpeek.OrganizationsApi

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

Method HTTP request Description
add_credits_organizations POST /v1/organizations/credits Add Credits
get_organization GET /v1/organizations Get Organization
update_organization PATCH /v1/organizations Update Organization

add_credits_organizations

AddCreditsResponse add_credits_organizations(add_credits_request, authorization=authorization)

Add Credits

Add credits to the organization.

When credits are added to a FREE-tier organization:

  • If new balance >= 100,000: Auto-upgrade to PRO tier
  • If new balance >= 1,000,000: Auto-upgrade to TEAM tier

PRO and TEAM tiers get enhanced rate limits automatically.

Example

import mixpeek
from mixpeek.models.add_credits_request import AddCreditsRequest
from mixpeek.models.add_credits_response import AddCreditsResponse
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.OrganizationsApi(api_client)
    add_credits_request = mixpeek.AddCreditsRequest() # AddCreditsRequest | 
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)

    try:
        # Add Credits
        api_response = api_instance.add_credits_organizations(add_credits_request, authorization=authorization)
        print("The response of OrganizationsApi->add_credits_organizations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationsApi->add_credits_organizations: %s\n" % e)

Parameters

Name Type Description Notes
add_credits_request AddCreditsRequest
authorization str REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. [optional]

Return type

AddCreditsResponse

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]

get_organization

OrganizationModelResponse get_organization(authorization=authorization)

Get Organization

Get current organization details.

Security: Infrastructure configuration is NOT exposed via this endpoint. Infrastructure (Qdrant URLs, Ray clusters) is only accessible via private admin endpoints.

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.OrganizationsApi(api_client)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)

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

Parameters

Name Type Description Notes
authorization str REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. [optional]

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]

update_organization

OrganizationModelResponse update_organization(organization_update_request, authorization=authorization)

Update Organization

Update organization settings (requires ADMIN permission).

Security: Infrastructure configuration cannot be modified via this endpoint. Infrastructure updates require Mixpeek admin access via private endpoints.

Example

import mixpeek
from mixpeek.models.organization_model_response import OrganizationModelResponse
from mixpeek.models.organization_update_request import OrganizationUpdateRequest
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.OrganizationsApi(api_client)
    organization_update_request = mixpeek.OrganizationUpdateRequest() # OrganizationUpdateRequest | 
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)

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

Parameters

Name Type Description Notes
organization_update_request OrganizationUpdateRequest
authorization str REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. [optional]

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]