api.md

Shared Types

from hyperspell.types import (
    Blob,
    Callout,
    Chunk,
    Code,
    Comment,
    Company,
    Conversation,
    Deal,
    Divider,
    Document,
    Equation,
    Event,
    File,
    Footnote,
    Heading,
    Image,
    LineBreak,
    Link,
    List,
    ListItem,
    Message,
    Metadata,
    Paragraph,
    Person,
    Provenance,
    ProvenanceEntity,
    ProvenanceSource,
    ProvenanceStep,
    QueryResult,
    Quote,
    ScoredDocumentResponse,
    Table,
    TableCell,
    TableRow,
    Task,
    Text,
    ToDo,
    ToolCall,
    ToolResult,
    Trace,
    TraceMessage,
    Transcript,
    Utterance,
    Website,
)

Connections

Types:

from hyperspell.types import ConnectionListResponse, ConnectionRevokeResponse

Methods:

• client.connections.list() -> ConnectionListResponse
• client.connections.revoke(connection_id) -> ConnectionRevokeResponse

Folders

Types:

from hyperspell.types import (
    FolderListResponse,
    FolderDeletePolicyResponse,
    FolderListPoliciesResponse,
    FolderSetPoliciesResponse,
)

Methods:

• client.folders.list(connection_id, **params) -> FolderListResponse
• client.folders.delete_policy(policy_id, *, connection_id) -> FolderDeletePolicyResponse
• client.folders.list_policies(connection_id) -> FolderListPoliciesResponse
• client.folders.set_policies(connection_id, **params) -> FolderSetPoliciesResponse

Integrations

Types:

from hyperspell.types import IntegrationListResponse, IntegrationConnectResponse

Methods:

• client.integrations.list() -> IntegrationListResponse
• client.integrations.connect(integration_id, **params) -> IntegrationConnectResponse

GoogleCalendar

Types:

from hyperspell.types.integrations import Calendar

Methods:

• client.integrations.google_calendar.list() -> Calendar

WebCrawler

Types:

from hyperspell.types.integrations import WebCrawlerIndexResponse

Methods:

• client.integrations.web_crawler.index(**params) -> WebCrawlerIndexResponse

Slack

Methods:

• client.integrations.slack.list(**params) -> object

Memories

Types:

from hyperspell.types import (
    MemoryStatus,
    MemoryListResponse,
    MemoryDeleteResponse,
    MemoryAddBulkResponse,
    MemoryGetResponse,
    MemoryStatusResponse,
)

Methods:

• client.memories.update(resource_id, *, source, **params) -> MemoryStatus
• client.memories.list(**params) -> SyncCursorPage[MemoryListResponse]
• client.memories.delete(resource_id, *, source) -> MemoryDeleteResponse
• client.memories.add(**params) -> MemoryStatus
• client.memories.add_bulk(**params) -> MemoryAddBulkResponse
• client.memories.get(resource_id, *, source) -> MemoryGetResponse
• client.memories.search(**params) -> QueryResult
• client.memories.status() -> MemoryStatusResponse
• client.memories.upload(**params) -> MemoryStatus

Evaluate

Types:

from hyperspell.types import (
    EvaluateListQueriesResponse,
    EvaluateScoreHighlightResponse,
    EvaluateScoreQueryResponse,
)

Methods:

• client.evaluate.get_query(query_id) -> QueryResult
• client.evaluate.list_queries(**params) -> SyncCursorPage[EvaluateListQueriesResponse]
• client.evaluate.score_highlight(highlight_id, **params) -> EvaluateScoreHighlightResponse
• client.evaluate.score_query(query_id, **params) -> EvaluateScoreQueryResponse

Actions

Types:

from hyperspell.types import ActionAddReactionResponse, ActionSendMessageResponse

Methods:

• client.actions.add_reaction(**params) -> ActionAddReactionResponse
• client.actions.send_message(**params) -> ActionSendMessageResponse

Sessions

Methods:

• client.sessions.add(**params) -> MemoryStatus

Vaults

Types:

from hyperspell.types import VaultListResponse

Methods:

• client.vaults.list(**params) -> SyncCursorPage[VaultListResponse]

Auth

Types:

from hyperspell.types import Token, AuthDeleteUserResponse, AuthMeResponse

Methods:

• client.auth.delete_user() -> AuthDeleteUserResponse
• client.auth.me() -> AuthMeResponse
• client.auth.user_token(**params) -> Token