hlix

The hlix control-plane API.

Protected operations are tenant-scoped. Authenticate with an API key in the x-api-key header, or — for a browser client — with the session cookie better-auth sets at /v1/api/auth/*. The tenant is the X-Organization-Id header, falling back to the session's active organization when the header is absent. Client portal requests use X-Client-Portal (client account id); the server derives the agency and restricts the caller to that account. Discovery and personal-workspace bootstrap need authentication but no active organization.

Only HANDLED failures are documented. An unhandled server error is answered by the framework as a text/plain 500 and is deliberately not part of this contract.

Internal Cloud Machine callbacks (/v1/api/internal/*) and webhook receivers (/webhooks/*) are not a supported client surface and never appear here.

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

  • API version: 1.0.0
  • Package version: 0.1.1
  • Generator version: 7.22.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install hlix-sdk

Set configuration.api_key["apiKey"] and pass the workspace ID as x_organization_id on tenant-scoped calls.

Getting Started

Please follow the installation procedure and then run the following:

import os

import hlix
from hlix.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'


# Enter a context with an instance of the API client
async with hlix.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hlix.AgentRunsApi(api_client)
    id = 'id_example' # str | 
    x_organization_id = 'x_organization_id_example' # str | The workspace (organization) to act in. Omitted, the session's active organization is used. (optional)

    try:
        # Get one run's recorded input and output
        api_response = await api_instance.get_agent_run_snapshot(id, x_organization_id=x_organization_id)
        print("The response of AgentRunsApi->get_agent_run_snapshot:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentRunsApi->get_agent_run_snapshot: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://server.hlix.ai

Class Method HTTP request Description
AgentRunsApi get_agent_run_snapshot GET /v1/api/agent-runs/{id}/snapshot Get one run's recorded input and output
AgentRunsApi list_cycle_agent_runs GET /v1/api/agent-runs/cycle/{cycleId} List the runs of every task in a cycle
AgentRunsApi list_project_agent_runs GET /v1/api/agent-runs/project/{projectId} List every run of a project
AgentRunsApi list_task_agent_run_timeline GET /v1/api/agent-runs/task/{taskId}/timeline List one task's runs in start order
AgentRunsApi list_task_agent_runs GET /v1/api/agent-runs/task/{taskId} List the runs recorded against one task
AgentsApi create_agent POST /v1/api/agents Create an agent
AgentsApi deactivate_agent POST /v1/api/agents/{id}/deactivate Deactivate an agent
AgentsApi fork_agent POST /v1/api/agents/{id}/fork Fork an agent into a new custom one
AgentsApi generate_agent_avatar POST /v1/api/agents/avatar-image Generate a custom avatar using the Hlix avatar skill
AgentsApi get_agent GET /v1/api/agents/{id} Get one agent
AgentsApi get_agent_avatar_image GET /v1/api/agents/avatar-image Read a generated avatar in this workspace
AgentsApi list_agent_roles GET /v1/api/agents/roles List the role library the project manager hires from
AgentsApi list_agents GET /v1/api/agents List the workspace's agents
AgentsApi update_agent PATCH /v1/api/agents/{id} Update an agent
AiApi analyze_ai_media POST /v1/api/ai/media/analyze Ask a question about an image or a video
AiApi create_hlix_code_chat_completion POST /v1/api/ai/w/{workspaceId}/chat/completions Run an OpenAI-compatible chat completion on the workspace's own model budget
AiApi create_hlix_code_message POST /v1/api/ai/w/{workspaceId}/v1/messages Run an Anthropic Messages request on the workspace's own model budget
AiApi create_hlix_code_response POST /v1/api/ai/w/{workspaceId}/responses Run an OpenAI Responses request on the workspace's own model budget
AiApi generate_ai_images POST /v1/api/ai/media/images Generate images
AiApi generate_ai_video POST /v1/api/ai/media/video Submit a video generation
AiApi get_ai_asset GET /v1/api/ai/assets/{key} Fetch one stored AI artifact
AiApi get_ai_batch GET /v1/api/ai/batches/{id} Read one batch and a page of its items
AiApi get_ai_document GET /v1/api/ai/documents/{id} Read one parsed document
AiApi get_ai_video_job GET /v1/api/ai/media/video/{id} Read one video job
AiApi list_ai_documents GET /v1/api/ai/documents List recently parsed documents
AiApi list_hlix_code_models GET /v1/api/ai/w/{workspaceId}/models List the models a Hlix Code session may run, and the workspace default
AiApi parse_ai_document POST /v1/api/ai/documents Parse a document into markdown
AiApi poll_ai_batch POST /v1/api/ai/batches/{id}/poll Poll one batch now
AiApi review_ai_video_job POST /v1/api/ai/media/video/{id}/review Record a review verdict on a generated video
AiApi submit_ai_batch POST /v1/api/ai/batches Submit a batch of offline requests
AiApi synthesize_ai_speech POST /v1/api/ai/media/speech Synthesize speech
AiApi transcribe_ai_audio POST /v1/api/ai/media/transcriptions Transcribe stored audio
AlertsApi delete_slack_alert_route DELETE /v1/api/alerts/slack Stop posting alerts to Slack
AlertsApi get_alert_settings GET /v1/api/alerts Get where workspace alerts are posted
AlertsApi list_slack_alert_channels GET /v1/api/alerts/slack/channels List Slack channels the bot can post alerts to
AlertsApi save_slack_alert_route PUT /v1/api/alerts/slack Choose the Slack channel and alert kinds
AlertsApi save_telegram_alert_route PUT /v1/api/alerts/telegram Choose which alerts the linked Telegram chats receive
AlertsApi test_slack_alert_route POST /v1/api/alerts/slack/test Send a test alert to the Slack channel
AlertsApi test_telegram_alert_route POST /v1/api/alerts/telegram/test Send a test alert to the linked Telegram chats
AttentionApi get_attention_inbox GET /v1/api/attention Get the operator attention inbox
AuditLogApi get_audit_entry GET /v1/api/audit-log/{id} Get one audit entry and its correlated rows
AuditLogApi list_audit_log GET /v1/api/audit-log List the workspace's audit trail
AuditLogApi list_project_audit_log GET /v1/api/audit-log/projects/{projectId} List one project's audit trail
AuditLogApi verify_audit_chain GET /v1/api/audit-log/verify Verify the tamper-evidence hash chain
BillingApi claim_bonus_credit POST /v1/api/bonus-credits/{action}/claim Claim the bonus credit for one action
BillingApi create_org_billing_checkout POST /v1/api/billing/checkout Open a hlix billing checkout billed to the workspace
BillingApi create_org_billing_portal POST /v1/api/billing/portal Open the billing portal for the workspace
BillingApi get_monthly_spend_limits GET /v1/api/usage/monthly-limits Read Growth and Delivery limits and spending this UTC month
BillingApi get_org_billing GET /v1/api/billing Read the workspace's plan, meters, orders and entitlement
BillingApi get_org_credits GET /v1/api/billing/credits Read the per-task credit prices and the credits the workspace has left
BillingApi get_org_extra_usage GET /v1/api/billing/extra-usage Read whether work may continue past the included usage
BillingApi get_project_extra_usage GET /v1/api/projects/{projectId}/extra-usage Read a project's extra usage override and what it resolves to
BillingApi get_project_task_charges GET /v1/api/projects/{projectId}/task-charges Read a project's accepted tasks, task price and review rounds
BillingApi get_workspace_usage GET /v1/api/usage Read workspace usage and entitlement
BillingApi list_bonus_credits GET /v1/api/bonus-credits List the bonus credit actions and which are claimed
BillingApi list_org_task_charges GET /v1/api/billing/task-charges List the workspace's accepted tasks and their credits
BillingApi remove_workspace_usage_limit DELETE /v1/api/usage/limit Clear the workspace usage limit
BillingApi set_delivery_monthly_limit PATCH /v1/api/usage/delivery-limit Set or clear the monthly Delivery spending limit
BillingApi set_org_extra_usage PUT /v1/api/billing/extra-usage Allow or stop usage past the included credit for the workspace
BillingApi set_project_extra_usage PUT /v1/api/projects/{projectId}/extra-usage Set a project's extra usage override
BillingApi set_workspace_usage_limit PUT /v1/api/usage/limit Set the workspace usage limit
BrandKitApi extract_workspace_brand_kit POST /v1/api/brand-kit/extract Extract a draft brand from one website URL
BrandKitApi get_workspace_brand_kit GET /v1/api/brand-kit Read workspace brand settings
BrandKitApi publish_workspace_brand_kit POST /v1/api/brand-kit/publish Publish a reviewed brand and portal
BrandKitApi save_workspace_brand_kit PUT /v1/api/brand-kit Save a brand draft
ChangesApi commit_project_file_edits POST /v1/api/projects/{id}/files/commit Commit hand edits to an edit branch
ChangesApi get_project_change_file GET /v1/api/projects/{id}/changes/file Get one changed file's unified diff
ChangesApi get_project_changes GET /v1/api/projects/{id}/changes Get the project's changed files and checkpoint commits
ChangesApi get_project_file_content GET /v1/api/projects/{id}/files/content Get one file of the project's head tree
ChangesApi list_project_branches GET /v1/api/projects/{id}/branches List the branches of the project the Files surface can read
ChangesApi list_project_files GET /v1/api/projects/{id}/files List every path in the project's head tree
ChangesApi merge_project_edit_branch POST /v1/api/projects/{id}/branches/merge Merge an edit branch back into the branch it was cut from
ChangesApi save_project_working_file PUT /v1/api/projects/{id}/files/working Save one file into a running cycle's Cloud Machine
ChangesApi start_project_edit_branch POST /v1/api/projects/{id}/branches Cut a branch to edit files by hand
ChatApi check_urgent_chat_message POST /v1/api/chat/urgent Stop only the project's recent work an urgent message contradicts
ChatApi create_chat_session POST /v1/api/chat/sessions Start a chat session with an agent, or fork one at a message
ChatApi get_chat_turn GET /v1/api/chat/turns/{turnId} Read where a sent message stands and the agent's answer
ChatApi list_chat_directory GET /v1/api/chat/directory Search your private and accessible shared project conversations
ChatApi list_chat_messages GET /v1/api/chat/messages Read the projectless chat transcript
ChatApi list_chat_session_messages GET /v1/api/chat/sessions/{id}/messages Read one chat session's history
ChatApi list_chat_sessions GET /v1/api/chat/sessions List your chat sessions with one agent
ChatApi send_chat_turn POST /v1/api/chat/turns Send a message to a project and return while the agent works
ChatApi set_private_chat_model PATCH /v1/api/chat/sessions/{id}/model Choose the model for your private conversation
ChatApi stop_chat_turn POST /v1/api/chat/stop Request cancellation of your exact model turn across replicas
ChatApi upload_chat_attachment POST /v1/api/chat/attachments Store a file for a chat turn to name
ClientAccountsApi assign_project_to_client_account PUT /v1/api/client-accounts/{id}/projects/{projectId} Assign a project to a customer
ClientAccountsApi create_client_account POST /v1/api/client-accounts Add a customer
ClientAccountsApi delete_client_account DELETE /v1/api/client-accounts/{id} Delete a customer
ClientAccountsApi get_client_account GET /v1/api/client-accounts/{id} Get one customer
ClientAccountsApi list_client_account_projects GET /v1/api/client-accounts/{id}/projects List one customer's projects
ClientAccountsApi list_client_accounts GET /v1/api/client-accounts List the agency's customers
ClientAccountsApi unassign_project_from_client_account DELETE /v1/api/client-accounts/{id}/projects/{projectId} Unassign a project from a customer
ClientAccountsApi update_client_account PATCH /v1/api/client-accounts/{id} Update a customer
ClientBillingApi adjust_client_billable POST /v1/api/client-billing/billables/{id}/adjust Append a correction to a charge
ClientBillingApi create_client_billable POST /v1/api/client-billing/billables Record a billable
ClientBillingApi get_client_billable GET /v1/api/client-billing/billables/{id} Get one ledger row
ClientBillingApi list_client_billables GET /v1/api/client-billing/billables List the ledger
ClientBillingApi void_client_billable POST /v1/api/client-billing/billables/{id}/void Reverse a charge
ClientBillingProfileApi delete_agency_billing_profile DELETE /v1/api/client-billing/profile Remove the workspace's billing identity
ClientBillingProfileApi get_agency_billing_profile GET /v1/api/client-billing/profile Get the workspace's billing identity
ClientBillingProfileApi get_agency_billing_profile_logo GET /v1/api/client-billing/profile/logo Download the workspace's logo
ClientBillingProfileApi upsert_agency_billing_profile PUT /v1/api/client-billing/profile Replace the workspace's billing identity
ClientInvoicesApi create_client_invoice_draft POST /v1/api/client-billing/invoices Assemble a draft invoice from billables
ClientInvoicesApi create_client_invoice_payment_link POST /v1/api/client-billing/invoices/{id}/payment-link Open a provider-hosted checkout for an issued invoice
ClientInvoicesApi get_client_invoice GET /v1/api/client-billing/invoices/{id} Get one invoice with its lines
ClientInvoicesApi get_client_invoice_logo GET /v1/api/client-billing/invoices/{id}/logo Download the logo frozen onto this invoice
ClientInvoicesApi get_client_invoice_pdf GET /v1/api/client-billing/invoices/{id}/pdf Download the invoice as a PDF
ClientInvoicesApi issue_client_invoice POST /v1/api/client-billing/invoices/{id}/issue Issue a draft, assigning its number
ClientInvoicesApi list_client_invoices GET /v1/api/client-billing/invoices List invoices
ClientInvoicesApi pay_client_invoice POST /v1/api/client-billing/invoices/{id}/pay Record an out-of-band settlement (bank transfer, cheque)
ClientInvoicesApi void_client_invoice POST /v1/api/client-billing/invoices/{id}/void Withdraw an invoice, or discard a draft
ClientPortalApi approve_client_request POST /v1/api/client-portal/requests/{id}/approve Approve the exact saved plan once and enter operator intake
ClientPortalApi create_client_request POST /v1/api/client-portal/requests Start a personal request conversation visible to the agency
ClientPortalApi download_client_request_attachment GET /v1/api/client-portal/requests/{id}/attachments/{attachmentId} Read a request-owned attachment
ClientPortalApi get_client_portal_overview GET /v1/api/client-portal/overview Get the portal landing view
ClientPortalApi get_client_request GET /v1/api/client-portal/requests/{id} Read an authorized request and its canonical conversation
ClientPortalApi list_client_portal_activity GET /v1/api/client-portal/activity List client-visible activity
ClientPortalApi list_client_requests GET /v1/api/client-portal/requests List your personal requests or the agency's client requests
ClientPortalApi upload_client_request_attachment POST /v1/api/client-portal/requests/{id}/attachments Upload a request-owned file or voice recording
ClientPortalsApi accept_client_portal_invitation POST /v1/api/portal-invitations/{token}/accept Accept an email-bound client portal invitation
ClientPortalsApi create_client_portal_idea POST /v1/api/portal/projects Create a brainstorming project
ClientPortalsApi enter_workspace_client_portal POST /v1/api/portals/{agencySlug}/session Enter the agency portal using the signed-in verified email
ClientPortalsApi get_client_portal_identity GET /v1/api/portals/{agencySlug}/identity Read the published agency identity
ClientPortalsApi get_workspace_portal_settings GET /v1/api/client-portal/settings Read default client permissions
ClientPortalsApi initialize_personal_workspace POST /v1/api/me/workspace Initialize your personal Hlix workspace
ClientPortalsApi invite_workspace_portal_client POST /v1/api/client-portal/invitations Invite an email directly to the agency client portal
ClientPortalsApi list_my_client_portals GET /v1/api/me/portals Discover your available agency client portals
ClientPortalsApi list_workspace_portal_clients GET /v1/api/client-portal/members List the agency's portal clients
ClientPortalsApi list_workspace_portal_invitations GET /v1/api/client-portal/invitations List agency client invitations
ClientPortalsApi list_workspace_portal_project_access GET /v1/api/client-portal/members/{userId}/projects List a client's current agency portal project access
ClientPortalsApi remove_workspace_portal_client DELETE /v1/api/client-portal/members/{userId} Remove a client's agency portal access
ClientPortalsApi remove_workspace_portal_customer_access DELETE /v1/api/client-portal/members/{userId}/accounts/{clientAccountId} Take one customer away from a client
ClientPortalsApi remove_workspace_portal_project_access DELETE /v1/api/client-portal/members/{userId}/projects/{projectId} Remove one explicit portal project grant
ClientPortalsApi restore_workspace_portal_customer_access PUT /v1/api/client-portal/members/{userId}/accounts/{clientAccountId} Give a client back one customer's access
ClientPortalsApi revoke_workspace_portal_invitation DELETE /v1/api/client-portal/invitations/{invitationId} Revoke an unaccepted client invitation
ClientPortalsApi set_workspace_portal_project_access PUT /v1/api/client-portal/members/{userId}/projects/{projectId} Grant one project, with steering and project insights
ClientPortalsApi update_workspace_portal_client PATCH /v1/api/client-portal/members/{userId} Set or clear a client's permission override
ClientPortalsApi update_workspace_portal_settings PATCH /v1/api/client-portal/settings Update default client permissions
CoderAccountsApi cancel_coder_account_connect DELETE /v1/api/coder-accounts/connect/{sessionId} Cancel subscription sign-in
CoderAccountsApi complete_coder_account_connect POST /v1/api/coder-accounts/connect/{sessionId}/complete Finish subscription sign-in or poll device authorization
CoderAccountsApi create_coder_account POST /v1/api/coder-accounts Import a subscription credential or custom API key
CoderAccountsApi delete_coder_account DELETE /v1/api/coder-accounts/{id} Remove an account and its credential
CoderAccountsApi get_coder_account_models GET /v1/api/coder-accounts/{id}/models Read cached models advertised by an account
CoderAccountsApi list_coder_accounts GET /v1/api/coder-accounts List safe coder accounts
CoderAccountsApi reconnect_coder_account PUT /v1/api/coder-accounts/{id}/credential Replace an account credential
CoderAccountsApi refresh_coder_account_models POST /v1/api/coder-accounts/{id}/models/refresh Refresh an API account's advertised models
CoderAccountsApi start_coder_account_connect POST /v1/api/coder-accounts/connect Start subscription sign-in
CoderAccountsApi test_coder_account POST /v1/api/coder-accounts/{id}/test Check a Claude or Codex API key
CoderAccountsApi update_coder_account PATCH /v1/api/coder-accounts/{id} Rename, share or enable an account
CrmApi add_crm_note POST /v1/api/crm/notes Add a note to a deal, contact or client timeline
CrmApi create_crm_contact POST /v1/api/crm/contacts Create a contact
CrmApi create_crm_deal POST /v1/api/crm/deals Create a deal
CrmApi get_crm_client_record GET /v1/api/crm/clients/{clientAccountId} Show a client's record: deals, contacts, timeline, projects and invoices
CrmApi get_crm_pipeline GET /v1/api/crm/pipeline Show the pipeline board and the last 30 days of outbound
CrmApi list_crm_contacts GET /v1/api/crm/contacts List contacts
CrmApi regenerate_crm_deal_suggestion POST /v1/api/crm/deals/{dealId}/suggestion/regenerate Have the agent write a new suggested next step and draft
CrmApi set_crm_deal_suggestion PUT /v1/api/crm/deals/{dealId}/suggestion Replace a deal's suggested next step and draft with your own
CrmApi set_crm_stage_probability PUT /v1/api/crm/pipeline/stages/{stage}/probability Set the forecast odds of an open pipeline stage
CrmApi update_crm_deal PATCH /v1/api/crm/deals/{dealId} Move a deal or edit its value, owner and next step
CyclesApi add_cycle_task POST /v1/api/cycles/{id}/tasks Add a task to a cycle
CyclesApi assign_cycle PATCH /v1/api/cycles/{id}/assign Hand a cycle to a teammate
CyclesApi continue_branch_cycle POST /v1/api/cycles/{id}/continue Admit a branch cycle once its branch is at the pushed commit
CyclesApi create_cycle_review_comment POST /v1/api/cycles/{id}/review/comments Comment on a cycle's review
CyclesApi create_direct_cycle POST /v1/api/cycles/direct Create a separate cycle
CyclesApi delete_cycle DELETE /v1/api/cycles/{id} Delete a draft or failed cycle
CyclesApi delete_cycle_task DELETE /v1/api/cycles/{id}/tasks/{taskId} Remove a task from a cycle
CyclesApi execute_cycle POST /v1/api/cycles/{id}/execute Run a cycle's lifecycle
CyclesApi get_cycle GET /v1/api/cycles/{id} Get one cycle with its tasks
CyclesApi get_cycle_artifact_url GET /v1/api/cycles/{id}/artifacts/{filename} Get a signed download URL for one cycle artifact
CyclesApi get_cycle_e2e_report GET /v1/api/cycles/{id}/e2e The cycle's user-side verification: journeys, outcomes and evidence keys
CyclesApi get_cycle_review_evidence GET /v1/api/cycles/{id}/review Get the verified review evidence for a cycle
CyclesApi get_cycle_run_diagnostics GET /v1/api/cycles/{id}/diagnostics Read why the cycle's run failed or is parked
CyclesApi get_cycle_timeline GET /v1/api/cycles/{id}/timeline List a cycle's events plus its tasks'
CyclesApi get_cycle_usage GET /v1/api/cycles/{id}/usage Get the cycle's cost and token roll-up
CyclesApi list_cycle_artifacts GET /v1/api/cycles/{id}/artifacts List a cycle's stored artifacts
CyclesApi list_cycle_events GET /v1/api/cycles/{id}/events List a cycle's own events
CyclesApi list_cycle_messages GET /v1/api/cycles/{id}/messages Read a cycle's conversation
CyclesApi list_cycle_pending_requests GET /v1/api/cycles/{id}/pending-requests List a cycle's pending requests
CyclesApi list_cycle_review_comments GET /v1/api/cycles/{id}/review/comments List the review comments on a cycle
CyclesApi list_cycles GET /v1/api/cycles List cycles
CyclesApi open_branch_cycle POST /v1/api/cycles/from-branch Open a cycle from a pushed branch
CyclesApi propose_cycle POST /v1/api/cycles Propose a cycle
CyclesApi request_cycle_revision POST /v1/api/cycles/{id}/review/request-revision Ask the cycle's engineer to address the open comments
CyclesApi send_cycle_message POST /v1/api/cycles/{id}/messages Send a message to a cycle's coder
CyclesApi stop_cycle POST /v1/api/cycles/{id}/stop Stop a running cycle
CyclesApi update_cycle PATCH /v1/api/cycles/{id} Update a cycle's title, description or target branch
CyclesApi update_cycle_review_comment PATCH /v1/api/cycles/{id}/review/comments/{commentId} Resolve or reopen a cycle review comment
CyclesApi update_cycle_task PATCH /v1/api/cycles/{id}/tasks/{taskId} Update a task inside a cycle
DeliverablesApi apply_deliverable_preparation POST /v1/api/deliverables/packages/{deliverableId}/preparations/{jobId}/apply Apply a prepared candidate after concurrent draft edits
DeliverablesApi create_deliverable_package POST /v1/api/deliverables/packages Create a client review package draft
DeliverablesApi decide_deliverable_approval POST /v1/api/deliverables/{cycleId}/approvals/{approvalId}/decide Record the customer's decision
DeliverablesApi decide_deliverable_package_approval POST /v1/api/deliverables/packages/{deliverableId}/approvals/{approvalId}/decide Record a decision on a published package version
DeliverablesApi generate_deliverable_suggestions POST /v1/api/deliverables/packages/suggestions Suggest coherent review milestones
DeliverablesApi get_deliverable GET /v1/api/deliverables/{cycleId} Get one deliverable with its derived progress
DeliverablesApi get_deliverable_package GET /v1/api/deliverables/packages/{deliverableId} Read a client review package
DeliverablesApi get_deliverable_package_recording GET /v1/api/deliverables/packages/{deliverableId}/recording Read the published package recording
DeliverablesApi get_deliverable_preparation GET /v1/api/deliverables/packages/{deliverableId}/preparations/{jobId} Read preparation progress and candidate
DeliverablesApi get_deliverable_preparation_recording GET /v1/api/deliverables/packages/{deliverableId}/preparations/{jobId}/recording Read an agency preparation recording
DeliverablesApi get_deliverable_suggestions GET /v1/api/deliverables/packages/suggestions Read private milestone suggestions
DeliverablesApi list_deliverable_approvals GET /v1/api/deliverables/{cycleId}/approvals List the decisions asked about a deliverable
DeliverablesApi list_deliverable_package_approvals GET /v1/api/deliverables/packages/{deliverableId}/approvals Read package review decisions
DeliverablesApi list_deliverable_packages GET /v1/api/deliverables/packages List client review packages
DeliverablesApi list_deliverable_preparations GET /v1/api/deliverables/packages/{deliverableId}/preparations Read agency preparation history
DeliverablesApi list_deliverables GET /v1/api/deliverables List deliverables
DeliverablesApi publish_deliverable POST /v1/api/deliverables/{cycleId}/publish Publish a deliverable to the customer
DeliverablesApi publish_deliverable_package POST /v1/api/deliverables/packages/{deliverableId}/publish Publish an immutable client review version
DeliverablesApi request_deliverable_approval POST /v1/api/deliverables/{cycleId}/approvals Ask a reviewer to decide
DeliverablesApi request_deliverable_package_approval POST /v1/api/deliverables/packages/{deliverableId}/approvals Request a client review of the published package
DeliverablesApi start_deliverable_preparation POST /v1/api/deliverables/packages/{deliverableId}/preparations Prepare recorded integrated review evidence
DeliverablesApi unpublish_deliverable POST /v1/api/deliverables/{cycleId}/unpublish Withdraw a deliverable from the customer
DeliverablesApi unpublish_deliverable_package POST /v1/api/deliverables/packages/{deliverableId}/unpublish Withdraw a review package
DeliverablesApi update_deliverable_package PUT /v1/api/deliverables/packages/{deliverableId} Save review package draft
DeliverablesApi upsert_deliverable PUT /v1/api/deliverables/{cycleId} Create or update a deliverable
DeploymentsApi get_deployment GET /v1/api/deployments/{id} Get one deployment
DeploymentsApi get_preview_sharing GET /v1/api/deployments/preview-sharing Get public preview sharing for a project
DeploymentsApi get_production_custom_domain GET /v1/api/deployments/custom-domain Check the production deployment's custom domain
DeploymentsApi list_deployments GET /v1/api/deployments List deployments
DeploymentsApi redeploy_project_preview POST /v1/api/deployments Redeploy a project's preview, or deploy it to production
DeploymentsApi set_preview_sharing PUT /v1/api/deployments/preview-sharing Enable or revoke public preview sharing
DeploymentsApi set_production_custom_domain PUT /v1/api/deployments/custom-domain Connect or remove the production deployment's custom domain
DeploymentsApi touch_deployment POST /v1/api/deployments/{id}/touch Extend a preview's time to live
EnvironmentsApi create_project_environment POST /v1/api/environments/project/{projectId} Create an environment
EnvironmentsApi delete_project_environment DELETE /v1/api/environments/project/{projectId}/{id} Delete an environment
EnvironmentsApi list_project_environments GET /v1/api/environments/project/{projectId} List a project's environments
EnvironmentsApi update_project_environment PATCH /v1/api/environments/project/{projectId}/{id} Update an environment
EventsApi get_activity_summary GET /v1/api/events/summary Summarize recorded workspace activity
EventsApi list_events GET /v1/api/events List activity events
FollowsApi create_follow POST /v1/api/follows Follow a project or a cycle
FollowsApi delete_follow DELETE /v1/api/follows/{targetType}/{targetId} Stop following
FollowsApi list_follows GET /v1/api/follows List what you follow
GrowthApi add_growth_index_leads POST /v1/api/growth/projects/{projectId}/index-leads Add people and companies from Hlix's shared index to a growth project
GrowthApi add_growth_suppressions POST /v1/api/growth/suppressions Add addresses and domains to the do-not-contact list
GrowthApi approve_growth_batch POST /v1/api/growth/projects/{projectId}/batches/{batchId}/approve Release a researched lead list before its review deadline
GrowthApi approve_growth_message POST /v1/api/growth/messages/{messageId}/approve Approve a drafted email, optionally edited, so it sends
GrowthApi cancel_managed_mailbox_hosting POST /v1/api/growth/managed-mailboxes/resources/{resourceId}/cancel-hosting Block new cold sends immediately and request hosting cancellation
GrowthApi cancel_managed_mailbox_warmup POST /v1/api/growth/managed-mailboxes/resources/{resourceId}/cancel-warmup Cancel warmup separately from mailbox hosting
GrowthApi check_growth_mailbox_dns GET /v1/api/growth/mailboxes/{mailboxId}/dns Check the mailbox domain's SPF, DKIM and DMARC records
GrowthApi classify_growth_message PATCH /v1/api/growth/messages/{messageId} Sort a reply by hand
GrowthApi compare_growth_providers POST /v1/api/growth/chains/find_email/compare Run two email finders on the same sample of the workspace's leads
GrowthApi connect_growth_mailbox POST /v1/api/growth/mailboxes/connect Start connecting a Google or Microsoft mailbox to send from
GrowthApi connect_growth_sendkit POST /v1/api/growth/sendkit/connect Verify and bind the deployment-configured SendKit workspace
GrowthApi create_growth_play POST /v1/api/growth/projects/{projectId}/plays Create one campaign
GrowthApi create_growth_project POST /v1/api/growth/projects Create a growth project from a website and start its research run
GrowthApi disconnect_growth_mailbox DELETE /v1/api/growth/mailboxes/{mailboxId} Disconnect a mailbox and revoke its access
GrowthApi download_growth_lead_export GET /v1/api/growth/projects/{projectId}/lead-exports/{exportId} Download a project's lead CSV export
GrowthApi export_growth_leads POST /v1/api/growth/projects/{projectId}/leads/export Export all matching leads to CSV
GrowthApi get_growth_enrich_price GET /v1/api/growth/enrich Hlix Enrich price: what one email sent to a lead built on Hlix's data costs
GrowthApi get_growth_index_stats GET /v1/api/growth/index The size of Hlix's shared company index and how many of the workspace's companies it supplied
GrowthApi get_growth_overview GET /v1/api/growth/projects/{projectId}/overview A growth project's outreach, hot leads and spend per day, with its daily budget
GrowthApi get_growth_project GET /v1/api/growth/projects/{projectId} Show a growth project's brain, campaigns and last run
GrowthApi get_growth_sending_schedule GET /v1/api/growth/projects/{projectId}/sending-schedule Resolve project and campaign sending schedules
GrowthApi get_growth_sendkit_connection GET /v1/api/growth/sendkit Inspect the workspace's SendKit connection and mailbox inventory
GrowthApi get_growth_settings GET /v1/api/growth/settings The workspace's growth settings and this month's growth spend
GrowthApi get_growth_spend GET /v1/api/growth/projects/{projectId}/spend Show each campaign's data-provider spend for today and the last 30 days
GrowthApi get_growth_thread GET /v1/api/growth/leads/{leadId}/thread Show a lead's whole email thread, drafts included
GrowthApi get_managed_mailbox_configuration GET /v1/api/growth/managed-mailboxes/configuration Read managed mailbox configuration and commercial readiness
GrowthApi get_managed_mailbox_order GET /v1/api/growth/managed-mailboxes/orders/{orderId} Read a saved managed mailbox order
GrowthApi import_growth_tool_result POST /v1/api/growth/projects/{projectId}/lead-lists/from-tool-call Import the people a completed tool call returned
GrowthApi import_managed_mailboxes POST /v1/api/growth/managed-mailboxes/import Connect existing InboxKit domains and mailboxes without purchasing them again
GrowthApi list_growth_batches GET /v1/api/growth/projects/{projectId}/batches Research lists and their twelve-hour review deadlines
GrowthApi list_growth_chains GET /v1/api/growth/chains Each capability's data-provider order and how each provider did in the last 7 days
GrowthApi list_growth_citable_projects GET /v1/api/growth/citable-projects List the finished delivery projects a growth brain may quote
GrowthApi list_growth_inbox GET /v1/api/growth/projects/{projectId}/inbox List a growth project's email threads, one per lead
GrowthApi list_growth_leads GET /v1/api/growth/projects/{projectId}/leads List a growth project's leads with their evidence and provenance
GrowthApi list_growth_mailboxes GET /v1/api/growth/mailboxes List the workspace's sending mailboxes with their warm-up and today's sends
GrowthApi list_growth_providers GET /v1/api/growth/providers List growth data providers and the workspace's key state
GrowthApi list_growth_suppressions GET /v1/api/growth/suppressions List the do-not-contact list
GrowthApi list_managed_mailbox_orders GET /v1/api/growth/managed-mailboxes/orders List managed mailbox orders
GrowthApi list_managed_mailbox_resources GET /v1/api/growth/managed-mailboxes/resources List managed domains and mailbox resources
GrowthApi order_managed_mailboxes POST /v1/api/growth/managed-mailboxes/orders Persist a managed mailbox order before provider dispatch
GrowthApi preview_growth_lead_export POST /v1/api/growth/projects/{projectId}/leads/export/preview What exporting the matching leads would cost, before exporting
GrowthApi quote_managed_mailboxes POST /v1/api/growth/managed-mailboxes/quotes Observe domain availability and recurring mailbox prices
GrowthApi reconcile_managed_mailbox_order POST /v1/api/growth/managed-mailboxes/orders/{orderId}/reconcile Reconcile provider evidence without replaying uncertain purchases
GrowthApi refine_growth_reply POST /v1/api/growth/leads/{leadId}/refine-reply Refine a reply against the lead thread and sourced project context without sending
GrowthApi remove_growth_provider_key DELETE /v1/api/growth/providers/{provider}/key Remove the workspace's own key for a growth provider
GrowthApi remove_growth_suppression DELETE /v1/api/growth/suppressions/{suppressionId} Remove an entry a person added to the do-not-contact list
GrowthApi remove_managed_mailbox_domain POST /v1/api/growth/managed-mailboxes/resources/{resourceId}/remove-domain Request domain removal without claiming a refund or renewal cancellation
GrowthApi repair_managed_mailbox_resource POST /v1/api/growth/managed-mailboxes/resources/{resourceId}/repair Repair a failed resource step without repurchasing successful resources
GrowthApi rerun_growth_project POST /v1/api/growth/projects/{projectId}/runs Run the website research again
GrowthApi research_growth_play POST /v1/api/growth/plays/{playId}/research Find or resume leads for one campaign without repeating completed research
GrowthApi resolve_growth_message POST /v1/api/growth/messages/{messageId}/resolve Record whether an email whose delivery was unknown went out
GrowthApi save_growth_provider_key PUT /v1/api/growth/providers/{provider}/key Add or replace the workspace's own key for a growth provider
GrowthApi search_growth_index GET /v1/api/growth/index/search Search Hlix's shared index of companies and their people
GrowthApi send_growth_reply POST /v1/api/growth/leads/{leadId}/reply Answer a lead in their thread from the mailbox that wrote to them
GrowthApi set_growth_autopilot PUT /v1/api/growth/projects/{projectId}/autopilot Turn the project's budget autopilot on or off
GrowthApi set_growth_project_budget PUT /v1/api/growth/projects/{projectId}/daily-budget Set or remove what all of a growth project's campaigns may spend per day
GrowthApi update_growth_brain PUT /v1/api/growth/projects/{projectId}/brain Replace the Company brain
GrowthApi update_growth_chain PUT /v1/api/growth/chains/{capability} Set the order a capability tries its providers in, or go back to the default
GrowthApi update_growth_lead PATCH /v1/api/growth/leads/{leadId} Disqualify a lead or put it back in line
GrowthApi update_growth_mailbox PATCH /v1/api/growth/mailboxes/{mailboxId} Change a mailbox's daily limit or warm-up start, or pause and resume it
GrowthApi update_growth_play PATCH /v1/api/growth/plays/{playId} Edit or launch a campaign
GrowthApi update_growth_provider PATCH /v1/api/growth/providers/{provider} Turn a growth provider on or off for the workspace, or change its settings
GrowthApi update_growth_sending_schedule PATCH /v1/api/growth/projects/{projectId}/sending-schedule Set or inherit a project's sending schedule
GrowthApi update_growth_settings PATCH /v1/api/growth/settings Change the hard cap, the sending rules or the booking link
GrowthApi upload_growth_lead_list POST /v1/api/growth/projects/{projectId}/lead-lists Upload a lead list to a growth project
HostingApi get_workspace_hosting GET /v1/api/settings/hosting Read the workspace's immutable hosting region
HostingApi list_hosting_regions GET /v1/api/hosting-regions List configured regional entry points
ImportsApi import_project_agent POST /v1/api/projects/{id}/resources/agent Create a project-scoped agent from local instructions
ImportsApi import_project_mcp POST /v1/api/projects/{id}/resources/mcp Explicitly activate a validated MCP server for one project
ImportsApi import_project_skill POST /v1/api/projects/{id}/resources/skill Explicitly activate a quarantined skill for one project
LinearApi delete_project_linear_binding DELETE /v1/api/integrations/linear/projects/{projectId} Disconnect a source without changing existing cycles
LinearApi get_linear_catalog GET /v1/api/integrations/linear/{installId}/catalog List accessible Linear teams, projects and labels
LinearApi get_project_linear_binding GET /v1/api/integrations/linear/projects/{projectId} Read a project's Linear source
LinearApi get_project_linear_issue GET /v1/api/integrations/linear/projects/{projectId}/issues/{issueId} Read an imported issue with its full Linear context
LinearApi list_linear_bindings GET /v1/api/integrations/linear/bindings List workspace Linear sources
LinearApi list_project_linear_issues GET /v1/api/integrations/linear/projects/{projectId}/issues List imported Linear issues and their work links
LinearApi save_project_linear_binding PUT /v1/api/integrations/linear/projects/{projectId} Save source filters and automatic or manual start behavior
LinearApi start_project_linear_issue POST /v1/api/integrations/linear/projects/{projectId}/issues/{issueId}/start Refresh an issue and send it to the project manager
LinearApi sync_project_linear_issues POST /v1/api/integrations/linear/projects/{projectId}/sync Import current matching open issues
LogsApi list_agent_logs GET /v1/api/logs/agent/{agentId} List the log lines across one agent's tasks
LogsApi list_agent_run_logs GET /v1/api/logs/agent-run/{agentRunId} List the log lines of one agent run
LogsApi list_cycle_logs GET /v1/api/logs/cycle/{cycleId} List one cycle's log lines
LogsApi list_project_logs GET /v1/api/logs/project/{projectId} List a project's log lines
LogsApi list_task_logs GET /v1/api/logs/task/{taskId} List one task's log lines
LogsApi list_trace_logs GET /v1/api/logs/trace/{traceId} List the log lines of one trace
McpServersApi connect_mcp_server POST /v1/api/mcp-servers/{id}/connect Start hosted OAuth for a remote MCP connection
McpServersApi create_mcp_server POST /v1/api/mcp-servers Register an MCP server
McpServersApi delete_mcp_server DELETE /v1/api/mcp-servers/{id} Delete an MCP server
McpServersApi disconnect_mcp_server POST /v1/api/mcp-servers/{id}/disconnect Disconnect OAuth and invalidate discovered tools
McpServersApi discover_mcp_server POST /v1/api/mcp-servers/{id}/discover Discover and save the remote server tool catalog
McpServersApi get_mcp_server GET /v1/api/mcp-servers/{id} Get one MCP server
McpServersApi list_mcp_servers GET /v1/api/mcp-servers List MCP servers in workspace or project scope
McpServersApi update_mcp_server PATCH /v1/api/mcp-servers/{id} Update an MCP server
MemoriesApi create_memory POST /v1/api/memories Write a memory
MemoriesApi delete_memory DELETE /v1/api/memories/{id} Delete a memory
MemoriesApi extract_cycle_memories POST /v1/api/memories/extract/{cycleId} Extract memories from a finished cycle
MemoriesApi get_memory GET /v1/api/memories/{id} Get one memory
MemoriesApi get_project_knowledge GET /v1/api/memories/project/{projectId} Read learned knowledge and recording availability for one project
MemoriesApi list_memories GET /v1/api/memories List the workspace's memories
MemoriesApi search_memories GET /v1/api/memories/search/{scope}/{scopeId} Search one scope by meaning
MemoriesApi update_memory PATCH /v1/api/memories/{id} Update a memory
MentionsApi get_project_mention_roster GET /v1/api/projects/{projectId}/mention-roster List who this project's conversations can mention
MentionsApi list_unread_mentions GET /v1/api/mentions List the caller's unread mentions
MentionsApi mark_mentions_read POST /v1/api/mentions/read Mark the caller's mentions read
MobileProviderApi get_mobile_provider GET /v1/api/mobile-provider Read mobile emulators and devices billing configuration
MobileProviderApi remove_mobile_provider_key DELETE /v1/api/mobile-provider/key Remove the key for new builds; existing resources retain their cleanup credentials
MobileProviderApi save_mobile_provider_key PUT /v1/api/mobile-provider/key Verify and save a workspace Limrun key for new builds
MobileProviderApi test_mobile_provider_key POST /v1/api/mobile-provider/test Check a supplied or saved Limrun key without allocating a device
MobileProviderApi toggle_mobile_provider PATCH /v1/api/mobile-provider Choose workspace or Hlix funding for new mobile builds
ModelConfigApi clear_ai_settings DELETE /v1/api/model-config/{slot} Clear one workspace settings group
ModelConfigApi clear_project_ai_settings DELETE /v1/api/model-config/projects/{projectId}/{slot} Clear a project's override of one settings group
ModelConfigApi get_resolved_ai_settings GET /v1/api/model-config/resolved Resolve the workspace's AI settings, with provenance
ModelConfigApi get_resolved_project_ai_settings GET /v1/api/model-config/projects/{projectId}/resolved Resolve a project's AI settings, with provenance
ModelConfigApi list_ai_settings GET /v1/api/model-config List the workspace's AI settings rows
ModelConfigApi list_model_catalog GET /v1/api/model-config/catalog List current tool-capable chat models
ModelConfigApi set_ai_settings PUT /v1/api/model-config/{slot} Set one workspace settings group
ModelConfigApi set_project_ai_settings PUT /v1/api/model-config/projects/{projectId}/{slot} Set a project's override of one settings group
PacksApi attach_project_pack POST /v1/api/packs/project/{projectId} Attach a pack to a project
PacksApi create_custom_skill POST /v1/api/packs/custom-skills Write a custom skill
PacksApi delete_custom_skill DELETE /v1/api/packs/custom-skills/{slug} Delete a custom skill
PacksApi detach_project_pack DELETE /v1/api/packs/{id} Detach a pack from a project
PacksApi generate_custom_skill POST /v1/api/packs/custom-skills/generate Draft a custom skill from a description (never saves)
PacksApi get_custom_skill GET /v1/api/packs/custom-skills/{slug} Get one custom skill
PacksApi list_available_packs GET /v1/api/packs List every pack the registry knows
PacksApi list_custom_skills GET /v1/api/packs/custom-skills List the workspace's own skills
PacksApi list_project_packs GET /v1/api/packs/project/{projectId} List a project's attached packs
PacksApi update_custom_skill PATCH /v1/api/packs/custom-skills/{slug} Update a custom skill
PacksApi update_project_pack PATCH /v1/api/packs/{id} Toggle an attached pack
PendingRequestsApi ask_client_question POST /v1/api/pending-requests/client-question Ask the customer a question
PendingRequestsApi cancel_pending_request POST /v1/api/pending-requests/{id}/cancel Cancel a request nobody will decide
PendingRequestsApi get_pending_request GET /v1/api/pending-requests/{id} Get one request
PendingRequestsApi list_pending_requests GET /v1/api/pending-requests List requests awaiting a decision
PendingRequestsApi resolve_pending_request POST /v1/api/pending-requests/{id}/resolve Approve or deny a request
PluginsApi get_plugin GET /v1/api/plugins/{id} Read a plugin installation
PluginsApi get_plugin_catalog_detail GET /v1/api/plugins/catalog/detail Read MCP Registry details and a public repository README
PluginsApi import_plugin_archive POST /v1/api/plugins/import-archive Preview a standard plugin or Agent Skills ZIP
PluginsApi install_plugin POST /v1/api/plugins Install a plugin with encrypted inputs
PluginsApi list_plugin_catalog GET /v1/api/plugins/catalog Browse official MCP Registry recipes
PluginsApi list_plugins GET /v1/api/plugins List installed workspace plugins
PluginsApi preview_plugin POST /v1/api/plugins/preview Validate a plugin manifest without installing
PluginsApi remove_plugin DELETE /v1/api/plugins/{id} Remove a plugin from subsequent runs
PluginsApi update_plugin PATCH /v1/api/plugins/{id} Update plugin setup, version or project availability
ProjectCallsApi heartbeat_project_call PUT /v1/api/projects/{projectId}/call/{participantId} Keep the caller's place in the project's call
ProjectCallsApi join_project_call POST /v1/api/projects/{projectId}/call Join the project's call
ProjectCallsApi leave_project_call POST /v1/api/projects/{projectId}/call/{participantId}/leave Leave the project's call
ProjectsApi add_project_initial_proposal_comment POST /v1/api/projects/{id}/initial-proposal/comments Comment on a proposal section
ProjectsApi apply_canvas_agent_ops POST /v1/api/projects/{id}/canvas/agent/ops Draw on the project canvas as hlix, for the caller
ProjectsApi approve_project_initial_proposal POST /v1/api/projects/{id}/initial-proposal/approve Approve the initial plan and release delivery
ProjectsApi archive_project POST /v1/api/projects/{id}/archive Archive a project
ProjectsApi assign_project PATCH /v1/api/projects/{id}/assign Hand a project to a teammate
ProjectsApi attach_project_github_repository POST /v1/api/projects/{id}/repos/github Attach an existing GitHub repository by owner/name
ProjectsApi attach_project_repo POST /v1/api/projects/{id}/repos Attach a repository to a project
ProjectsApi build_design POST /v1/api/projects/{projectId}/designs/{designId}/build Submit implementation of an accepted prototype
ProjectsApi build_project_mobile_app POST /v1/api/projects/{id}/mobile/builds Build a native app preview
ProjectsApi control_task_computer POST /v1/api/projects/{id}/computers/{computerId}/control Take, renew or release managed computer input
ProjectsApi create_design POST /v1/api/projects/{projectId}/designs Submit a native prototype brief
ProjectsApi create_design_comment POST /v1/api/projects/{projectId}/designs/{designId}/comments Comment on a frame without dispatching work
ProjectsApi create_project POST /v1/api/projects Create a project
ProjectsApi decide_design POST /v1/api/projects/{projectId}/designs/{designId}/decisions Accept a revision or submit revision work
ProjectsApi decide_project_initial_proposal POST /v1/api/projects/{id}/initial-proposal/decision Record the invited client reviewer's optional decision
ProjectsApi delete_project DELETE /v1/api/projects/{id} Delete a project
ProjectsApi detach_project_repo DELETE /v1/api/projects/{id}/repos/{repoId} Detach a repository from a project
ProjectsApi detect_project_commands POST /v1/api/projects/{id}/detect-commands Re-run command detection without writing anything
ProjectsApi download_task_computer_evidence GET /v1/api/projects/{id}/computers/{computerId}/evidence/{kind} Download retained execution screen or replay evidence
ProjectsApi edit_project_initial_proposal PUT /v1/api/projects/{id}/initial-proposal/revisions/manual Create a manual business-copy revision
ProjectsApi get_canvas_agent_view GET /v1/api/projects/{id}/canvas/agent Read the project canvas as an agent may see it
ProjectsApi get_design GET /v1/api/projects/{projectId}/designs/{designId} Read a design revision and its review threads
ProjectsApi get_project GET /v1/api/projects/{id} Get one project
ProjectsApi get_project_architecture GET /v1/api/projects/{id}/architecture Read the application's source dependency graph
ProjectsApi get_project_artifact_url GET /v1/api/projects/{id}/artifacts/{filename} Get a signed download URL for one project artifact
ProjectsApi get_project_board GET /v1/api/projects/{id}/board Read the rows a project's board shows
ProjectsApi get_project_budget GET /v1/api/projects/{id}/budget Get the project's delivery budget and spend to date
ProjectsApi get_project_canvas GET /v1/api/projects/{id}/canvas Read the project canvas without waking its Cloud Machine
ProjectsApi get_project_cycle_metrics GET /v1/api/projects/{id}/cycle-metrics Get a project's flow metrics computed from cycle stage history
ProjectsApi get_project_desktop GET /v1/api/projects/{id}/desktop Report whether a graphical desktop is reachable
ProjectsApi get_project_director_clip GET /v1/api/projects/{id}/director/clips/{clipId} Read an audience-scoped Director video segment
ProjectsApi get_project_environment GET /v1/api/projects/{id}/environment Read where the project's boxes start from
ProjectsApi get_project_initial_proposal GET /v1/api/projects/{id}/initial-proposal Read the current initial SDD/SOW
ProjectsApi get_project_initial_proposal_logo GET /v1/api/projects/{id}/initial-proposal/logo Read the frozen agency logo
ProjectsApi get_project_mobile_agent_session GET /v1/api/projects/{id}/mobile/agent-sessions/{sessionId} Read this agent run's native test device
ProjectsApi get_project_mobile_builds GET /v1/api/projects/{id}/mobile/builds List saved native builds
ProjectsApi get_project_mobile_session GET /v1/api/projects/{id}/mobile/sessions/{sessionId} Read your private app preview
ProjectsApi get_project_mobile_targets GET /v1/api/projects/{id}/mobile/targets List native app targets
ProjectsApi get_project_review GET /v1/api/projects/{id}/review Read recorded verification evidence for completed project cycles
ProjectsApi get_project_roadmap GET /v1/api/projects/{id}/roadmap Get the project's roadmap
ProjectsApi get_project_run_diagnostics GET /v1/api/projects/{id}/diagnostics Read why the project's run failed or is parked
ProjectsApi get_project_sequence GET /v1/api/projects/{id}/sequence Watch a cycle's narrated Sequence
ProjectsApi get_project_status GET /v1/api/projects/{id}/status Read where a project stands, in a person's terms
ProjectsApi get_project_team_insights GET /v1/api/projects/{id}/insights Get a project's all-time cloud machine totals and its expected finish
ProjectsApi get_project_terminal_access GET /v1/api/projects/{id}/terminal Open a shell into the project's Cloud Machine
ProjectsApi get_project_thread_directory GET /v1/api/projects/{id}/threads Get the project's conversation tree
ProjectsApi get_project_usage GET /v1/api/projects/{id}/usage Get the project's cost and token roll-up
ProjectsApi get_task_computer GET /v1/api/projects/{id}/computers/{computerId} Read the exact execution computer's availability
ProjectsApi keep_project_environment_alive POST /v1/api/projects/{id}/environment/keepalive Tell a running environment it is still in use
ProjectsApi list_designs GET /v1/api/projects/{projectId}/designs List native project designs
ProjectsApi list_project_artifacts GET /v1/api/projects/{id}/artifacts List a project's stored artifacts
ProjectsApi list_project_image_builds GET /v1/api/projects/{id}/image-builds List the project's Cloud Machine image builds
ProjectsApi list_project_initial_proposal_comments GET /v1/api/projects/{id}/initial-proposal/comments List section-anchored proposal comments
ProjectsApi list_project_initial_proposal_revisions GET /v1/api/projects/{id}/initial-proposal/revisions List proposal revision history
ProjectsApi list_project_linear_sessions GET /v1/api/projects/{id}/linear-sessions List the Linear conversations delegated into this project
ProjectsApi list_project_messages GET /v1/api/projects/{id}/messages Read the project's conversation
ProjectsApi list_project_repos GET /v1/api/projects/{id}/repos List a project's repositories
ProjectsApi list_projects GET /v1/api/projects List the workspace's projects
ProjectsApi list_task_computers GET /v1/api/projects/{id}/computers List the project's task execution computers
ProjectsApi merge_project_review POST /v1/api/projects/{id}/review/merge Merge a reviewed preview pull request at its exact head commit
ProjectsApi project_workspace_exec POST /v1/api/projects/{id}/workspace/exec Run a command in the project's Cloud Machine
ProjectsApi project_workspace_fs POST /v1/api/projects/{id}/workspace/fs Read or write a file in the project's Cloud Machine
ProjectsApi publish_design_revision POST /v1/api/projects/{projectId}/designs/{designId}/revisions Publish a tested playable prototype
ProjectsApi publish_project_initial_proposal POST /v1/api/projects/{id}/initial-proposal/publish Publish a branded proposal revision
ProjectsApi request_project_delivery POST /v1/api/projects/{id}/delivery Open the project's pull request now
ProjectsApi resolve_design_comment PATCH /v1/api/projects/{projectId}/designs/{designId}/comments/{commentId} Resolve or reopen a design comment
ProjectsApi resolve_project_initial_proposal GET /v1/api/projects/initial-proposal-by-id/{proposalId} Resolve a proposal deep link
ProjectsApi resolve_project_initial_proposal_comment PATCH /v1/api/projects/{id}/initial-proposal/comments/{commentId} Resolve or reopen a proposal comment
ProjectsApi resume_project POST /v1/api/projects/{id}/resume Resume a stopped project, or start one that never started
ProjectsApi revise_project_initial_proposal POST /v1/api/projects/{id}/initial-proposal/revisions Request a targeted AI revision
ProjectsApi send_task_computer_input POST /v1/api/projects/{id}/computers/{computerId}/input Send input to the computer currently owned by the caller
ProjectsApi set_primary_project_repo POST /v1/api/projects/{id}/repos/{repoId}/primary Make a repository the project's primary
ProjectsApi set_project_mobile_targets PUT /v1/api/projects/{id}/mobile/targets Configure native app targets
ProjectsApi start_project POST /v1/api/projects/{id}/start Start the project's autonomous run
ProjectsApi start_project_desktop POST /v1/api/projects/{id}/desktop Start the desktop
ProjectsApi start_project_mobile_agent_session POST /v1/api/projects/{id}/mobile/agent-sessions Start a native test device for this agent run
ProjectsApi start_project_mobile_session POST /v1/api/projects/{id}/mobile/sessions Start a private app preview
ProjectsApi stop_project POST /v1/api/projects/{id}/stop Stop every agent working on the project
ProjectsApi stop_project_mobile_agent_session DELETE /v1/api/projects/{id}/mobile/agent-sessions/{sessionId} Stop this agent run's native test device
ProjectsApi stop_project_mobile_session DELETE /v1/api/projects/{id}/mobile/sessions/{sessionId} End your private app preview
ProjectsApi suggest_project_stack POST /v1/api/projects/{id}/suggest-stack Propose a stack string from the project's own evidence
ProjectsApi unarchive_project POST /v1/api/projects/{id}/unarchive Restore an archived project
ProjectsApi undo_canvas_agent_edit POST /v1/api/projects/{id}/canvas/agent/undo Undo hlix's most recent canvas edit
ProjectsApi update_project PATCH /v1/api/projects/{id} Update a project's configuration
ProjectsApi update_project_repo PATCH /v1/api/projects/{id}/repos/{repoId} Update a repository's branch or label
ProjectsApi watch_project_director GET /v1/api/projects/{id}/director Watch the Director Explainer's evolving video segments
ProvidersApi connect_model_provider POST /v1/api/providers Save a workspace model provider
ProvidersApi delete_model_provider DELETE /v1/api/providers/{provider} Disconnect a model provider
ProvidersApi get_model_provider GET /v1/api/providers/{provider} Read a model provider configuration
ProvidersApi get_model_provider_models GET /v1/api/providers/{provider}/models Read cached models advertised by this billing provider
ProvidersApi list_model_providers GET /v1/api/providers List connected model billing providers
ProvidersApi refresh_model_provider_models POST /v1/api/providers/{provider}/models/refresh Refresh the connected provider model catalog
ProvidersApi test_model_provider POST /v1/api/providers/{provider}/test Test provider credentials without inference
ProvidersApi update_model_provider PATCH /v1/api/providers/{provider} Update a model provider
ReportsApi get_billing_report GET /v1/api/reports/billing Get billing health
ReportsApi get_overview_report GET /v1/api/reports Get the current portfolio overview
ReportsApi get_usage_report GET /v1/api/reports/usage Get agent usage and cost
ReportsApi list_customer_reports GET /v1/api/reports/customers List customer portfolio reports
ReportsApi list_project_reports GET /v1/api/reports/projects List project health reports
ReposApi create_repo_access POST /v1/api/projects/{id}/repos/{repoId}/access Get short-lived Git access to a repository in HLIX Repos
ReposApi get_project_protected_files GET /v1/api/projects/{id}/protected-files Read encrypted project files with manage access
ReposApi get_repo_head GET /v1/api/projects/{id}/repos/{repoId}/head Read a repository head without waking its workspace
SecretsApi create_project_secrets_config POST /v1/api/secrets/project/{projectId} Configure a secrets provider
SecretsApi delete_project_secret_entry DELETE /v1/api/secrets/project/{projectId}/entries/{key} Remove one secret from the project store
SecretsApi delete_project_secrets_config DELETE /v1/api/secrets/project/{projectId}/{configId} Delete a secrets config
SecretsApi export_project_secrets POST /v1/api/secrets/project/{projectId}/export Export one source file's secrets, values in clear
SecretsApi import_project_secret_files PUT /v1/api/secrets/project/{projectId}/files Upload whole secret files and let the store parse them
SecretsApi list_project_secret_entries GET /v1/api/secrets/project/{projectId}/entries List the project's secrets, masked, with the file each belongs to
SecretsApi list_project_secrets_configs GET /v1/api/secrets/project/{projectId} List a project's secrets configs
SecretsApi list_project_secrets_sync_logs GET /v1/api/secrets/project/{projectId}/sync-logs List a project's secrets sync history
SecretsApi test_project_secrets POST /v1/api/secrets/project/{projectId}/test Resolve the project's secrets and report the key names
SecretsApi update_project_secrets_config PATCH /v1/api/secrets/project/{projectId}/{configId} Update a secrets config
SecretsApi upsert_project_secret_entries PUT /v1/api/secrets/project/{projectId}/entries Create or replace secrets in the project store
TasksApi add_task_comment POST /v1/api/tasks/{id}/comments Comment on a task
TasksApi create_task POST /v1/api/tasks Create a task; taskConfig delegates it through a one-task cycle
TasksApi execute_task POST /v1/api/tasks/{id}/execute Execute a task standalone (not implemented)
TasksApi get_task GET /v1/api/tasks/{id} Get one task
TasksApi list_task_comments GET /v1/api/tasks/{id}/comments List the comments on a task
TasksApi list_tasks GET /v1/api/tasks List tasks in the workspace
TasksApi update_task PATCH /v1/api/tasks/{id} Update a task's title, description or status
ToolsApi call_tool POST /v1/api/tools/{toolId}/call Create or revisit a durable tool invocation
ToolsApi describe_tool GET /v1/api/tools/{toolId} Read the accepted input schema and execution policy
ToolsApi get_tool_call GET /v1/api/tool-calls/{callId} Read a persisted tool result and cost status
ToolsApi get_tool_connection GET /v1/api/tools/connections/treg Read safe Treg connection state
ToolsApi list_tool_calls GET /v1/api/tool-calls List recent workspace tool invocations
ToolsApi remove_tool_connection DELETE /v1/api/tools/connections/treg Remove a workspace Treg connection
ToolsApi save_tool_connection PUT /v1/api/tools/connections/treg Save a workspace Treg connection
ToolsApi search_tools GET /v1/api/tools Search available tools and inspect funding readiness
WebProvidersApi get_hlix_crawl_status GET /v1/api/web-providers/crawl Show hlix-crawl usage against the plan allowance
WebProvidersApi list_web_providers GET /v1/api/web-providers List web-provider credential state
WebProvidersApi remove_web_provider_key DELETE /v1/api/web-providers/{provider}/key Remove a stored web-provider key
WebProvidersApi save_web_provider_key PUT /v1/api/web-providers/{provider}/key Add or replace a web-provider key
WebProvidersApi toggle_hlix_crawl PATCH /v1/api/web-providers/crawl Opt the workspace in or out of hlix-crawl
WebProvidersApi toggle_web_provider PATCH /v1/api/web-providers/{provider} Enable or disable a stored web-provider key
WorkspacesApi list_workspaces GET /v1/api/workspaces List the workspaces you belong to

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Author

Project links

Data verified by PyPI on Nov 7, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for hlix from gravatar.com hlix

Credits

Author: Hlix

GitHub Statistics

Data verified by PyPI on Nov 7, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

Provenance

Data verified by PyPI on Nov 7, 2026
Data provided by the project maintainers and verified by PyPI at the time of upload.

Full provenance

Both files in this release have provenance metadata.

View provenance details

License

Apache License

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator hlix API

Metadata

Project links

Data verified by PyPI on Nov 7, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for hlix from gravatar.com hlix

Credits

Author: Hlix

GitHub Statistics

Data verified by PyPI on Nov 7, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

Provenance

Data verified by PyPI on Nov 7, 2026
Data provided by the project maintainers and verified by PyPI at the time of upload.

Full provenance

Both files in this release have provenance metadata.

View provenance details

License

Apache License

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator hlix API

Release files for hlix-sdk 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hlix-sdk 0.1.1
File Size Uploaded Provenance Actions
hlix_sdk-0.1.1.tar.gz 960.3 kB With provenance Details for hlix_sdk-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hlix-sdk 0.1.1
File Interpreter ABI Platform Actions
hlix_sdk-0.1.1-py3-none-any.whl 2.5 MB With provenance Python 3 none any Details for hlix_sdk-0.1.1-py3-none-any.whl

Total release size: 3.4 MB

Release files / hlix_sdk-0.1.1.tar.gz

Download URL hlix_sdk-0.1.1.tar.gz
Size 960.3 kB
Tags Source
SHA-256 checksum
How to use checksums 		7d5eecf29ea1453b816b8012f8002d3a8adf8834696e8fd393b090211b0bc016
BLAKE2b-256 checksum
How to use checksums 		80623642a5a431e51b42347f8a08c75c7eb34cdb06134931cb3c9c823de9fd7e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 7, 2026.

Transparency log
Identity
Publishing platform
GitHub Actions
Publishing repository
github.com/hlix-ai/hlix
Publishing commit
github.com/hlix-ai/hlix/tree/eb3613a8150897fbc06b8c02e7978aa5bbca2276
Workflow
Publishing configuration
github.com/hlix-ai/hlix/blob/eb3613a8150897fbc06b8c02e7978aa5bbca2276/.github/workflows/release-generated-sdks.yml
Publishing logs
github.com/hlix-ai/hlix/actions/runs/42332245799/attempts/1
Artifact
Subject
hlix_sdk-0.1.1.tar.gz
SHA-256 checksum
7d5eecf29ea1453b816b8012f8002d3a8adf8834696e8fd393b090211b0bc016 Verifying attestations

Release files / hlix_sdk-0.1.1-py3-none-any.whl

Download URL hlix_sdk-0.1.1-py3-none-any.whl
Size 2.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums 		ed1c770b2a1415d3635e3a415eba757a0e8739e770b0cffdf9acfeec12fe7150
BLAKE2b-256 checksum
How to use checksums 		f5023cd31eabfa8aa2af0fe708996016c635f4cd199610e5bbea91a247e44c89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 7, 2026.

Transparency log
Identity
Publishing platform
GitHub Actions
Publishing repository
github.com/hlix-ai/hlix
Publishing commit
github.com/hlix-ai/hlix/tree/eb3613a8150897fbc06b8c02e7978aa5bbca2276
Workflow
Publishing configuration
github.com/hlix-ai/hlix/blob/eb3613a8150897fbc06b8c02e7978aa5bbca2276/.github/workflows/release-generated-sdks.yml
Publishing logs
github.com/hlix-ai/hlix/actions/runs/42332245799/attempts/1
Artifact
Subject
hlix_sdk-0.1.1-py3-none-any.whl
SHA-256 checksum
ed1c770b2a1415d3635e3a415eba757a0e8739e770b0cffdf9acfeec12fe7150 Verifying attestations

Security for hlix-sdk 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for hlix_sdk-0.1.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 7, 2026.

Transparency log
Identity
Publishing platform
GitHub Actions
Publishing repository
github.com/hlix-ai/hlix
Publishing commit
github.com/hlix-ai/hlix/tree/eb3613a8150897fbc06b8c02e7978aa5bbca2276
Workflow
Publishing configuration
github.com/hlix-ai/hlix/blob/eb3613a8150897fbc06b8c02e7978aa5bbca2276/.github/workflows/release-generated-sdks.yml
Publishing logs
github.com/hlix-ai/hlix/actions/runs/42332245799/attempts/1
Artifact
Subject
hlix_sdk-0.1.1.tar.gz
SHA-256 checksum
7d5eecf29ea1453b816b8012f8002d3a8adf8834696e8fd393b090211b0bc016 Verifying attestations

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files Full provenance

0.1.0

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page