Intellex API Python client (generated from OpenAPI)
Project description
intellex-shared-client
Python client for the Intellex API
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.2.0
- Package version: 0.1.1
- Generator version: 7.17.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.9+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import intellex_shared_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import intellex_shared_client
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import intellex_shared_client
from intellex_shared_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = intellex_shared_client.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with intellex_shared_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = intellex_shared_client.AuthApi(api_client)
email = 'email_example' # str | Email to fetch a specific user (optional)
user_id = 'user_id_example' # str | Supabase auth/user id to fetch a specific user (optional)
skip_revoked_check = False # bool | (optional) (default to False)
authorization = 'authorization_example' # str | (optional)
x_device_id = 'x_device_id_example' # str | (optional)
try:
# Current User
api_response = api_instance.current_user_auth_me_get(email=email, user_id=user_id, skip_revoked_check=skip_revoked_check, authorization=authorization, x_device_id=x_device_id)
print("The response of AuthApi->current_user_auth_me_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AuthApi->current_user_auth_me_get: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthApi | current_user_auth_me_get | GET /auth/me | Current User |
| AuthApi | delete_account_auth_account_delete | DELETE /auth/account | Delete Account |
| AuthApi | delete_device_auth_devices_device_id_delete | DELETE /auth/devices/{deviceId} | Delete Device |
| AuthApi | list_devices_auth_devices_get | GET /auth/devices | List Devices |
| AuthApi | login_auth_login_post | POST /auth/login | Login |
| AuthApi | revoke_devices_auth_devices_revoke_post | POST /auth/devices/revoke | Revoke Devices |
| AuthApi | upsert_device_auth_devices_post | POST /auth/devices | Upsert Device |
| DefaultApi | db_health_health_db_get | GET /health/db | Db Health |
| DefaultApi | health_check_health_get | GET /health | Health Check |
| DefaultApi | root_get | GET / | Root |
| DefaultApi | supabase_health_health_supabase_get | GET /health/supabase | Supabase Health |
| ProjectsApi | create_project_projects_post | POST /projects | Create Project |
| ProjectsApi | delete_project_projects_project_id_delete | DELETE /projects/{project_id} | Delete Project |
| ProjectsApi | get_messages_projects_project_id_messages_get | GET /projects/{project_id}/messages | Get Messages |
| ProjectsApi | get_plan_projects_project_id_plan_get | GET /projects/{project_id}/plan | Get Plan |
| ProjectsApi | get_project_projects_project_id_get | GET /projects/{project_id} | Get Project |
| ProjectsApi | list_project_shares_projects_project_id_shares_get | GET /projects/{project_id}/shares | List Project Shares |
| ProjectsApi | list_projects_projects_get | GET /projects | List Projects |
| ProjectsApi | project_stats_projects_stats_get | GET /projects/stats | Project Stats |
| ProjectsApi | recent_activity_projects_activity_get | GET /projects/activity | Recent Activity |
| ProjectsApi | revoke_project_share_projects_project_id_shares_share_id_delete | DELETE /projects/{project_id}/shares/{share_id} | Revoke Project Share |
| ProjectsApi | send_message_projects_project_id_messages_post | POST /projects/{project_id}/messages | Send Message |
| ProjectsApi | share_project_projects_project_id_shares_post | POST /projects/{project_id}/shares | Share Project |
| ProjectsApi | update_project_projects_project_id_patch | PATCH /projects/{project_id} | Update Project |
| UsersApi | get_api_keys_users_api_keys_get | GET /users/api-keys | Get Api Keys |
| UsersApi | save_api_keys_users_api_keys_post | POST /users/api-keys | Save Api Keys |
Documentation For Models
- ActivityItem
- AgentThought
- ApiKeyPayload
- ApiKeySummary
- ApiKeysResponse
- ChatMessage
- CreateMessageRequest
- CreateProjectRequest
- DeleteAccountRequest
- DeviceDeleteResponse
- DeviceListResponse
- DeviceRecord
- DeviceRevokeRequest
- DeviceRevokeResponse
- DeviceUpsertRequest
- HTTPValidationError
- LoginRequest
- Preferences
- ProjectShare
- ProjectStats
- ResearchPlan
- ResearchPlanItem
- ResearchProject
- SendMessageResponse
- ShareProjectRequest
- UpdateProjectRequest
- User
- ValidationError
- ValidationErrorLocInner
Documentation For Authorization
Endpoints do not require authorization.
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters