odinai-sdk

odin-sdk

API Documentation to interact with

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 3.0.111
• Generator version: 7.14.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 odin_sdk

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 odin_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import odin_sdk
from odin_sdk.rest import ApiException
from pprint import pprint

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



# Enter a context with an instance of the API client
with odin_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = odin_sdk.ActionsApi(api_client)
    api_tool_request = odin_sdk.ApiToolRequest() # ApiToolRequest | 
    x_api_key = 'x_api_key_example' # str | Your Odin API key. (optional)
    x_api_secret = 'x_api_secret_example' # str | Your Odin API secret. (optional)

    try:
        # Api Tool
        api_response = api_instance.api_tool_tools_api_post(api_tool_request, x_api_key=x_api_key, x_api_secret=x_api_secret)
        print("The response of ActionsApi->api_tool_tools_api_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ActionsApi->api_tool_tools_api_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://127.0.0.1:8001

Class	Method	HTTP request	Description
ActionsApi	api_tool_tools_api_post	POST /tools/api	Api Tool
ActionsApi	deploy_bot_tool_tools_deploy_bot_post	POST /tools/deploy-bot	Deploy Bot Tool
AgentsApi	activate_custom_agent_agents_activate_post	POST /agents/activate	Activate an Existing Custom Agent
AgentsApi	edit_existing_custom_agent_agents_edit_post	POST /agents/edit	Edit an Existing Custom Agent
AgentsApi	list_agents_for_project_agents_project_id_list_get	GET /agents/{project_id}/list	List Agents for Project
AgentsApi	save_new_custom_agent_agents_new_post	POST /agents/new	Save a New Custom Agent
ChatApi	create_chat_chat_create_post	POST /chat/create	Create Chat
ChatApi	delete_chat_chat_delete_delete	DELETE /chat/delete	Delete Chat
ChatApi	get_chat_project_project_id_chat_chat_id_get	GET /project/{project_id}/chat/{chat_id}	Get Chat
ChatApi	get_chats_project_project_id_chat_get	GET /project/{project_id}/chat	Get Chats
ChatApi	get_default_models_chat_models_get	GET /chat/models	Get Default Models
ChatApi	send_message_v3_v3_chat_message_post	POST /v3/chat/message	Send Message V3
CustomToolsApi	clone_public_tool_tools_custom_clone_post	POST /tools/custom/clone	Clone Public Tool
CustomToolsApi	create_custom_tool_tools_custom_post	POST /tools/custom	Create Custom Tool
CustomToolsApi	delete_custom_tool_tools_custom_tool_id_delete	DELETE /tools/custom/{tool_id}	Delete Custom Tool
CustomToolsApi	execute_workflow_stream_tools_execute_workflow_stream_get	GET /tools/execute-workflow-stream	Execute Workflow Stream
CustomToolsApi	execute_workflow_tools_execute_workflow_post	POST /tools/execute-workflow	Execute Workflow
CustomToolsApi	execute_workflow_with_file_upload_tools_execute_workflow_file_upload_post	POST /tools/execute-workflow-file-upload	Execute Workflow With File Upload
CustomToolsApi	export_custom_tool_tools_custom_tool_id_export_post	POST /tools/custom/{tool_id}/export	Export Custom Tool
CustomToolsApi	get_available_toolkit_tools_tools_available_toolkit_tools_get	GET /tools/available-toolkit-tools	Get Available Toolkit Tools
CustomToolsApi	get_custom_tool_tools_custom_tool_id_get	GET /tools/custom/{tool_id}	Get Custom Tool
CustomToolsApi	get_custom_tools_tools_custom_get	GET /tools/custom	Get Custom Tools
CustomToolsApi	get_public_custom_tools_tools_custom_public_get	GET /tools/custom/public	Get Public Custom Tools
CustomToolsApi	get_tool_schedule_status_tools_custom_tool_id_schedule_status_get	GET /tools/custom/{tool_id}/schedule-status	Get Tool Schedule Status
CustomToolsApi	get_tool_version_tools_custom_tool_id_version_version_get	GET /tools/custom/{tool_id}/version/{version}	Get Tool Version
CustomToolsApi	get_tool_versions_tools_custom_tool_id_versions_get	GET /tools/custom/{tool_id}/versions	Get Tool Versions
CustomToolsApi	get_toolkit_oauth_login_url_tools_oauth_login_url_get	GET /tools/oauth/login-url	Get Toolkit Oauth Login Url
CustomToolsApi	get_toolkit_oauth_status_tools_oauth_status_get	GET /tools/oauth/status	Get Toolkit Oauth Status
CustomToolsApi	get_tools_schedule_status_batch_tools_custom_schedule_status_batch_post	POST /tools/custom/schedule-status/batch	Get Tools Schedule Status Batch
CustomToolsApi	import_custom_tool_tools_custom_import_post	POST /tools/custom/import	Import Custom Tool
CustomToolsApi	pause_tool_schedule_tools_custom_tool_id_pause_schedule_post	POST /tools/custom/{tool_id}/pause-schedule	Pause Tool Schedule
CustomToolsApi	publish_custom_tool_tools_custom_tool_id_publish_post	POST /tools/custom/{tool_id}/publish	Publish Custom Tool
CustomToolsApi	resume_tool_schedule_tools_custom_tool_id_resume_schedule_post	POST /tools/custom/{tool_id}/resume-schedule	Resume Tool Schedule
CustomToolsApi	revert_draft_to_version_tools_custom_tool_id_revert_to_version_post	POST /tools/custom/{tool_id}/revert-to-version	Revert Draft To Version
CustomToolsApi	update_custom_tool_tools_custom_tool_id_put	PUT /tools/custom/{tool_id}	Update Custom Tool
DataTypesApi	cancel_compute_column_job_project_project_id_data_type_data_type_id_compute_column_cancel_execution_id_post	POST /project/{project_id}/data-type/{data_type_id}/compute-column/cancel/{execution_id}	Cancel Compute Column Job
DataTypesApi	compute_column_values_async_project_project_id_data_type_data_type_id_compute_column_async_post	POST /project/{project_id}/data-type/{data_type_id}/compute-column/async	Compute Column Values Async
DataTypesApi	create_data_type_project_project_id_data_types_post	POST /project/{project_id}/data-types	Create Data Type
DataTypesApi	create_data_type_view_project_project_id_data_type_data_type_id_view_post	POST /project/{project_id}/data-type/{data_type_id}/view	Create Data Type View
DataTypesApi	delete_data_type_by_id_project_project_id_data_types_data_type_id_delete	DELETE /project/{project_id}/data-types/{data_type_id}	Delete Data Type By Id
DataTypesApi	get_compute_column_jobs_project_project_id_data_type_data_type_id_compute_column_jobs_get	GET /project/{project_id}/data-type/{data_type_id}/compute-column/jobs	Get Compute Column Jobs
DataTypesApi	get_compute_column_status_project_project_id_data_type_data_type_id_compute_column_status_execution_id_get	GET /project/{project_id}/data-type/{data_type_id}/compute-column/status/{execution_id}	Get Compute Column Status
DataTypesApi	get_data_type_by_id_project_project_id_data_types_data_type_id_get	GET /project/{project_id}/data-types/{data_type_id}	Get Data Type By Id
DataTypesApi	get_data_type_view_by_id_project_project_id_data_types_data_type_id_view_get	GET /project/{project_id}/data-types/{data_type_id}/view	Get Data Type View By Id
DataTypesApi	get_data_types_project_project_id_data_types_get	GET /project/{project_id}/data-types	Get Data Types
DataTypesApi	get_grouped_data_type_view_by_id_project_project_id_data_types_data_type_id_view_grouped_get	GET /project/{project_id}/data-types/{data_type_id}/view/grouped	Get Grouped Data Type View By Id
DataTypesApi	get_template_details_project_project_id_data_type_templates_template_name_get	GET /project/{project_id}/data-type-templates/{template_name}	Get Template Details
DataTypesApi	get_templates_project_project_id_data_type_templates_get	GET /project/{project_id}/data-type-templates	Get Templates
DataTypesApi	import_table_project_project_id_import_table_post	POST /project/{project_id}/import-table	Import Table
DataTypesApi	update_column_metadata_project_project_id_data_type_data_type_id_column_column_name_metadata_put	PUT /project/{project_id}/data-type/{data_type_id}/column/{column_name}/metadata	Update Column Metadata
DataTypesApi	update_data_type_view_project_project_id_data_type_data_type_id_view_view_id_put	PUT /project/{project_id}/data-type/{data_type_id}/view/{view_id}	Update Data Type View
DataTypesApi	use_template_project_project_id_data_type_templates_use_post	POST /project/{project_id}/data-type-templates/use	Use Template
ExecutionHistoryApi	get_execution_history_tools_execution_history_get	GET /tools/execution-history	Get Execution History
ExecutionHistoryApi	get_execution_run_details_tools_execution_history_run_id_get	GET /tools/execution-history/{run_id}	Get Execution Run Details
JsonsApi	delete_json_json_delete	DELETE /json	Delete Json
JsonsApi	edit_json_json_put	PUT /json	Edit Json
JsonsApi	get_json_json_post	POST /json	Get Json
JsonsApi	get_jsons_jsons_post	POST /jsons	Get Jsons
KnowledgeBaseApi	add_file_to_knowledge_base_v3_v3_project_knowledge_add_file_post	POST /v3/project/knowledge/add/file	Add File To Knowledge Base V3
KnowledgeBaseApi	batch_delete_project_knowledge_delete_delete	DELETE /project/knowledge/delete	Batch Delete
KnowledgeBaseApi	sync_kb_file_v2_v2_project_knowledge_sync_file_post	POST /v2/project/knowledge/sync/file	Sync Kb File V2
ProjectsApi	add_user_to_project_project_user_add_post	POST /project/user/add	Add User To Project
ProjectsApi	create_project_project_create_post	POST /project/create	Create Project
ProjectsApi	delete_project_project_delete_delete	DELETE /project/delete	Delete Project
ProjectsApi	edit_project_user_project_user_edit_post	POST /project/user/edit	Edit Project User
ProjectsApi	get_project_members_project_project_id_members_get	GET /project/{project_id}/members	Get Project Members
ProjectsApi	get_projects_projects_get	GET /projects	Get Projects
ProjectsApi	update_project_project_update_post	POST /project/update	Update Project
RolesApi	create_role_project_project_id_roles_post	POST /project/{project_id}/roles	Create Role
RolesApi	get_all_role_ids_project_project_id_roles_get	GET /project/{project_id}/roles	Get All Role Ids
ScheduleManagementApi	get_tool_schedule_status_tools_custom_tool_id_schedule_status_get	GET /tools/custom/{tool_id}/schedule-status	Get Tool Schedule Status
ScheduleManagementApi	get_tools_schedule_status_batch_tools_custom_schedule_status_batch_post	POST /tools/custom/schedule-status/batch	Get Tools Schedule Status Batch
ScheduleManagementApi	pause_tool_schedule_tools_custom_tool_id_pause_schedule_post	POST /tools/custom/{tool_id}/pause-schedule	Pause Tool Schedule
ScheduleManagementApi	resume_tool_schedule_tools_custom_tool_id_resume_schedule_post	POST /tools/custom/{tool_id}/resume-schedule	Resume Tool Schedule
ToolsApi	ai_classify_tools_ai_classify_post	POST /tools/ai/classify	Ai Classify
ToolsApi	ai_summary_tools_ai_summarize_post	POST /tools/ai/summarize	Ai Summary
ToolsApi	check_pii_in_documents_tools_pii_check_post	POST /tools/pii-check	Check Pii In Documents
ToolsApi	convert_md_html_tools_md_html_conversion_post	POST /tools/md-html-conversion	Convert Md Html
ToolsApi	create_blog_from_title_tools_ai_blog_create_auto_post	POST /tools/ai/blog/create/auto	Create Blog From Title
ToolsApi	create_blog_key_points_tools_ai_blog_ideas_post	POST /tools/ai/blog/ideas	Create Blog Key Points
ToolsApi	create_blog_sections_tools_ai_blog_sections_post	POST /tools/ai/blog/sections	Create Blog Sections
ToolsApi	create_blog_title_tools_ai_blog_title_post	POST /tools/ai/blog/title	Create Blog Title
ToolsApi	create_blog_tools_ai_blog_create_post	POST /tools/ai/blog/create	Create Blog
ToolsApi	execute_step_tools_execute_step_post	POST /tools/execute-step	Execute Step
ToolsApi	extract_data_tools_extract_data_post	POST /tools/extract_data	Extract Data
ToolsApi	extract_info_from_file_tools_file_extract_start_post	POST /tools/file/extract/start	Extract Info From File
ToolsApi	fetch_data_tools_file_extract_fetch_post	POST /tools/file/extract/fetch	Fetch Data
ToolsApi	fetch_kb_documents_tools_kb_fetch_documents_post	POST /tools/kb/fetch_documents	Fetch Kb Documents
ToolsApi	find_prospeo_data_tools_prospeo_post	POST /tools/prospeo	Find Prospeo Data
ToolsApi	get_available_tools_by_category_tools_available_by_category_get	GET /tools/available/by-category	Get Available Tools By Category
ToolsApi	get_available_tools_tools_available_get	GET /tools/available	Get Available Tools
ToolsApi	get_step_result_tools_step_result_project_id_tool_id_step_id_get	GET /tools/step-result/{project_id}/{tool_id}/{step_id}	Get Step Result
ToolsApi	get_stock_data_tools_v2_yahoo_finance_stock_data_post	POST /tools/v2/yahoo-finance/stock/data	Get Stock Data
ToolsApi	recreate_blog_section_tools_ai_blog_regenerate_post	POST /tools/ai/blog/regenerate	Recreate Blog Section
ToolsApi	recreate_blog_section_tools_ai_blog_section_regenerate_post	POST /tools/ai/blog/section/regenerate	Recreate Blog Section
ToolsApi	search_available_tools_tools_available_search_get	GET /tools/available/search	Search Available Tools
ToolsApi	translate_texts_tools_ai_translate_post	POST /tools/ai/translate	Translate Texts
ToolsApi	write_blog_section_tools_create_blog_section_post	POST /tools/create_blog_section	Write Blog Section
ToolsApi	write_blog_tools_ai_blog_write_post	POST /tools/ai/blog/write	Write Blog
DefaultApi	get_youtube_captions_json_tools_ai_extract_youtube_captions_post	POST /tools/ai/extract-youtube-captions	Get Youtube Captions Json
DefaultApi	sse_endpoint_tools_push_get	GET /tools/push	Sse Endpoint

Documentation For Models

• AIClassifyRequest
• AIClassifyResponse
• AISummarizeRequest
• AISummarizeResponse
• APIKey
• ActionsRules
• ActivateCustomAgentResponse
• AddMembersRules
• AddUserToProjectRequest
• AddUserToProjectResponse
• AgentsRules
• AnalyticsRules
• ApiToolRequest
• ApiToolResponse
• AssistantRules
• BatchDeleteRequest
• BatchDeleteResponse
• Blog
• BlogRegenerateRequest
• BlogRegenerateResponse
• BlogRegenerateSectionRequest
• BlogRegenerateSectionResponse
• BlogRequest
• BlogResponse
• BlogSection
• BodyFindProspeoDataToolsProspeoPost
• CategoryInput
• ChatModelInfoResponse
• ChatRules
• ClonePublicToolRequest
• ComputeColumnAsyncResponse
• ComputeColumnCancelResponse
• ComputeColumnJobsResponse
• ComputeColumnRequest
• ComputeColumnStatusResponse
• CreateBlogSectionRequest
• CreateBlogSectionResponse
• CreateChatPromptRequest
• CreateChatPromptResponse
• CreateCustomToolRequest
• CreateProjectRequest
• CreateProjectResponse
• CreateRoleRequest
• CreateRoleResponse
• CreateViewRequest
• CreateViewResponse
• CustomChatbot
• CustomToolListResponse
• CustomToolResponse
• CustomToolVersionListResponse
• CustomToolVersionResponse
• DTField
• DataTypeWithSchema
• DeleteChatRequest
• DeleteChatResponse
• DeleteDataTypeResponse
• DeleteJsonRequest
• DeleteJsonResponse
• DeleteProjectRequest
• DeleteProjectResponse
• DeployBotToolRequest
• DeployBotToolResponse
• DocumentRules
• DomainSearchRequest
• EditExistingCustomAgent
• EditExistingCustomAgentResponse
• EditProjectRequest
• EditProjectResponse
• EmailFinderRequest
• EmailVerifierRequest
• ExecutionMode
• ExecutionTriggerMode
• ExportToolRequest
• ExportToolResponse
• ExtractDataResponse
• ExtractMetaDataRequest
• ExtractYoutubeCaptionsRequest
• FetchDataRequest
• FetchDataResponse
• FetchKBDocumentsRequest
• FetchKBDocumentsResponse
• FlowsRules
• GetAllProjectsResponse
• GetAllRoleNamesResponse
• GetChatResponse
• GetChatsResponse
• GetDataTypeViewResponse
• GetGroupedDataTypeViewResponse
• GetJsonRequest
• GetJsonsRequest
• GetProjectMembersResponse
• GetTemplatesResponse
• HTTPValidationError
• Images
• ImportTableResponse
• ImportToolRequest
• InvitedUser
• KBFileStatus
• KBRules
• KbInfo
• KeywordPair
• LLMModel
• LinkedInEmailFinderRequest
• ListAgentsForProjectResponse
• MdHTMLConversionRequest
• ModelJson
• PIICheckRequest
• PersonalityId
• Project
• ProjectInfo
• ProjectMember
• ProspeoRequest
• PublishToolRequest
• QuickUploadMultiple
• Resource
• Role
• RolesRules
• RoutesDataTypesAddDataTypeRequest
• RoutesDataTypesAddDataTypeResponse
• RoutesDataTypesGetDataTypeResponse
• RoutesDataTypesGetDataTypesResponse
• RoutesKnowledgebaseKnowledgeBaseDataResponse
• RoutesProjectsActivateCustomAgentRequest
• RoutesProjectsMember
• RoutesToolsToolsMiscRoutesResponseKBDocument
• RoutesToolsToolsModelsExecutionHistoryResponse
• Rules
• SaveNewCustomAgent
• SaveNewCustomAgentResponse
• SendMessageResponse
• SettingsRules
• StepExecutionRequest
• StepExecutionResult
• StockDataRequest
• SyncFileRequestLegacy
• SystemPromptInfo
• TemplateField
• TemplatePreview
• ToolInput
• ToolStep
• TopicModel
• TopicModelKeyword
• TranslateTextsRequest
• TranslateTextsResponse
• TranslatedText
• UpdateColumnMetadataRequest
• UpdateColumnMetadataResponse
• UpdateCustomToolRequest
• UpdateJsonRequest
• UpdateProjectRequest
• UpdateProjectResponse
• UpdateViewRequest
• UpdateViewResponse
• UseTemplateRequest
• UseTemplateResponse
• UserDetails
• UserInfo
• ValidationError
• ValidationErrorLocInner
• WorkflowExecutionRequest
• WorkflowExecutionResponse
• WorkflowExecutionResult

Documentation For Authorization

Authentication schemes defined for the API:

APIKeyHeader

• Type: API key
• API key parameter name: X-Test-API-Key
• Location: HTTP header

Author